Uppy

Uppy is a sleek, modular file uploader that integrates seemlessly with any application. It’s fast, easy to use and lets you worry about more important problems than building a file uploader.

Fetch files from local disk, Google Drive, Dropbox, Instagram, or snap and record selfies with a camera;
Preview and edit metadata with a nice interface;
Upload to the final destination, optionally processing/encoding on the way;

Read the docs | Try Uppy

Uppy is being developed by the Transloadit team.

Example

const Uppy = require('uppy/lib/core')
const Dashboard = require('uppy/lib/plugins/Dashboard')
const Webcam = require('uppy/lib/plugins/Webcam')
const GoogleDrive = require('uppy/lib/plugins/GoogleDrive')
const Tus = require('uppy/lib/plugins/Tus')

const uppy = Uppy({ autoProceed: false })
  .use(Dashboard, { trigger: '#select-files' })
  .use(Webcam, { target: Dashboard })
  .use(GoogleDrive, { target: Dashboard, host: 'https://server.uppy.io' })
  .use(Tus, { endpoint: '://master.tus.io/files/' })
  .run()
  .on('core:success', files => console.log(`Successfully uploaded these files: ${files}`))

Try it online or read the docs for details on how to use Uppy and its plugins.

Features

Lightweight, modular plugin-based architecture, easy on dependencies ⚡
Resumable file uploads via the open tus standard
Supports picking files from: Webcam, Dropbox, Google Drive, Instagram, bypassing the user’s device where possible, syncing between servers directly via uppy-server
Works great with file encoding and processing backends, such as Transloadit, works great without (just roll your own Apache/Nginx/Node/etc backend)
Sleek user interface ✨
Optional file recovering (after a browser crash) with Golden Retriever
Speaks multiple languages (i18n) 🌍
Built with accessibility in mind
Free for the world, forever (as in beer 🍺, pizza 🍕, and liberty 🗽)
Cute as a puppy, also accepts cat pictures 🐶

Installation

$ npm install uppy --save

We recommend installing from NPM and then using a module bundler such as Webpack, Browserify or Rollup.js.

Add CSS uppy.min.css, either to <head> of your HTML page or include in JS, if your bundler of choice supports it — transforms and plugins are available for Browserify and Webpack.

If you like, you can also use a pre-built bundle, for example from unpkg CDN. In that case Uppy will attach itself to the global window.Uppy object.

⚠️ The bundle currently consists of most Uppy plugins, so this method is not recommended for production, as your users will have to download all plugins, when you are likely using just a few.

1. Add a script to the bottom of <body>:

<script src="https://unpkg.com/uppy"></script>

2. Add CSS to <head>:

<link href="https://unpkg.com/uppy/dist/uppy.min.css" rel="stylesheet">

3. Initialize:

<script>
  var uppy = Uppy.Core()
  uppy.use(Uppy.DragDrop, {target: '.UppyDragDrop'})
  uppy.use(Uppy.Tus, {endpoint: '//master.tus.io/files/'})
  uppy.run()
</script>

Documentation

Uppy — full list of options, methods and events.
Plugins — list of Uppy plugins and their options.
Server — setting up and running an Uppy Server instance, which adds support for Instagram, Dropbox, Google Drive and other remote sources.
React — components to integrate uppy UI plugins with react apps.
Architecture & Making a Plugin — how to write a plugin for Uppy [documentation in progress].

Plugins

Tus — resumable uploads via tus.io open standard
XHRUpload — regular uploads for any backend out there
Transloadit — support for Transloadit’s robust file encoding and processing backend
Dashboard — universal UI with previews, progress bars, metadata editor and all the cool stuff
DragDrop — plain and simple drag and drop area
FileInput — even more plain “select files” button
ProgressBar — minimal progress bar that fills itself when upload progresses
StatusBar — more detailed progress, pause/resume/cancel buttons, percentage, speed, uploaded/total sizes (included by default with Dashboard)
Informer — send notifications like “smile” before taking a selfie or “upload failed” when all is lost (also included by default with Dashboard)
GoldenRetriever — restores files after a browser crash, like it’s nothing
ReduxDevTools — for your emerging time traveling needs
GoogleDrive — select files from Google Drive
Dropbox — select files from Dropbox
Instagram — you guessed right — select files from Instagram
Webcam — snap and record those selfies 📷

Browser Support

Note: we aim to support IE10+ and recent versions of Safari, Edge, Chrome, Firefox and Opera. IE6 on the chart above means we recommend setting Uppy to target a <form> element, so when Uppy has not yet loaded or is not supported, upload still works. Even on the refrigerator browser. Or, yes, IE6.

FAQ

React support?

Yep. Uppy-React component is in the works, in the meantime you can just use it as any other lib with React, see here.

Can I use it with Rails/Node/Go/PHP?

Yes, whatever you want on the backend will work with XHRUpload plugin, since it just does a POST or PUT request. If you want resumability, use one of tus implementations 👌🏼

Do I need to install special service/server for it?

No, as mentioned previously, XHRUpload plugin is old-school and just works with everything. However, you need uppy-server if you’d like your users to be able to pick files from Google Drive or Dropbox (more services coming). And you can add tus if you want resumability.

Does Uppy support S3 uploads?

Yes, since 0.18, there is an S3 plugin. Check out the docs for more information.

Contributions are welcome

Contributor’s guide in website/src/guide/contributing.md
Changelog to track our release progress (we aim to roll out a release every month): CHANGELOG.md

License

The MIT License.

DanielWare / uppy