Uppy

Uppy is a sleek, modular JavaScript file uploader that integrates seamlessly with any application. It’s fast, has a comprehensible API and lets you worry about more important problems than building a file uploader.

• Fetch files from local disk, remote URLs, Google Drive, Dropbox, Box,

or snap and record selfies with a camera

• Preview and edit metadata with a nice interface
• Upload to the final destination, optionally process/encode

Read the docs | Try Uppy

Uppy is being developed by the folks at Transloadit, a versatile API to handle any file in your app.

Tests
Deploys

Example

Code used in the above example:

import Uppy from '@uppy/core'
import Dashboard from '@uppy/dashboard'
import RemoteSources from '@uppy/remote-sources'
import ImageEditor from '@uppy/image-editor'
import Webcam from '@uppy/webcam'
import Tus from '@uppy/tus'
const uppy = new Uppy()
  .use(Dashboard, { trigger: '#select-files' })
  .use(RemoteSources, { companionUrl: 'https://companion.uppy.io' })
  .use(Webcam)
  .use(ImageEditor)
  .use(Tus, { endpoint: 'https://tusd.tusdemo.net/files/' })
  .on('complete', (result) => {
    console.log('Upload result:', result)
  })

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

Integrations

Uppy has first-class support for plain JS/HTML, React, Svelte, Vue, and Angular.

For the supported frameworks (except Angular) Uppy offers three ways to build user interfaces:

1. Pre-composed, plug-and-play components. Mainly .

1. Headless components. Smaller components, easier to override the styles

1. Hooks. Attach our logic to your own components, no restrictions, create a

Features

• Lightweight, modular plugin-based architecture, light on dependencies :zap:
• Resumable file uploads via the open tus standard, so large

• Supports picking files from: Webcam, Dropbox, Box, Google Drive,

• Works great with file encoding and processing backends, such as

• Sleek user interface :sparkles:
• Optional file recovery (after a browser crash) with

• Speaks several languages (i18n) :earth_africa:
• Built with accessibility in mind
• Free for the world, forever (as in beer 🍺, pizza 🍕, and liberty 🗽)
• Cute as a puppy, also accepts cat pictures :dog:

Installation

npm install @uppy/core @uppy/dashboard @uppy/tus

Add CSS uppy.min.css, either to your HTML page’s or include in JS, if your bundler of choice supports it.

Alternatively, you can also use a pre-built bundle from Transloadit’s CDN: Smart CDN. In that case Uppy will attach itself to the global window.Uppy object.

⚠️ The bundle 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 only a few.

<!-- 1. Add CSS to <head> -->
<link
  href="https://releases.transloadit.com/uppy/v6.0.5/uppy.min.css"
  rel="stylesheet"
/>
<!-- 2. Initialize -->
<div id="files-drag-drop"></div>
<script type="module">
  import {
    Uppy,
    Dashboard,
    Tus,
  } from 'https://releases.transloadit.com/uppy/v6.0.5/uppy.min.mjs'
const uppy = new Uppy()
  uppy.use(Dashboard, { target: '#files-drag-drop' })
  uppy.use(Tus, { endpoint: 'https://tusd.tusdemo.net/files/' })
</script>

Documentation

• Uppy — full list of options, methods and events
• Companion — setting up and running a

• React — components to integrate Uppy UI plugins

• Architecture & Writing a Plugin — how

Plugins

UI Elements

• Dashboard — universal UI with previews,

• Headless components (react, svelte, vue)

Sources

• Drag & Drop — plain drag and drop area
• File Input — even plainer “select files”

• Webcam — snap and record those selfies 📷
• ⓒ Google Drive — import files from

• ⓒ Dropbox — import files from Dropbox
• ⓒ Box — import files from Box
• ⓒ Facebook — import images and videos from

• ⓒ OneDrive — import files from Microsoft

• ⓒ Import From URL — import direct URLs from

The ⓒ mark means that @uppy/companion, a server-side component, is needed for a plugin to work.

Destinations

• Tus — resumable uploads via the open

• XHR Upload — regular uploads for any

• AWS S3 — plain upload to AWS S3 or

File Processing

• Transloadit — creates Assemblies that

Miscellaneous

• Golden Retriever — restores files

• Thumbnail Generator — generates

• Form — collects metadata from
  right

Browser Support

We aim to support recent versions of Chrome, Firefox, and Safari.

FAQ

Why not use ?

Having no JavaScript beats having a lot of it, so that’s a fair question! Running an uploading & encoding business for ten years though we found that in cases, the file input leaves some to be desired:

• We received complaints about broken uploads and found that resumable uploads

• Uppy supports editing meta information before uploading.
• Uppy allows cropping images before uploading.
• There’s the situation where people are using their mobile devices and want to

• Accurate upload progress reporting is an issue on many platforms.
• Some file validation — size, type, number of files — can be done on the client

• Uppy integrates webcam support, in case your users want to upload a

• A larger drag and drop surface can be pleasant to work with. Some people also

• Uppy is aware of encoding backends. Often after an upload, the server needs to

• Sometimes you might want your uploads to happen while you continue to interact

Not all apps need all these features. An is fine in many situations. But these were a few things that our customers hit / asked about enough to spark us to develop Uppy.

Why is all this goodness free?

Transloadit’s team is small and we have a shared ambition to make a living from open source. By giving away projects like tus.io and Uppy, we’re hoping to advance the state of the art, make life a tiny little bit better for everyone and in doing so have rewarding jobs and get some eyes on our commercial service: a content ingestion & processing platform.

Our thinking is that if only a fraction of our open source userbase can see the appeal of hosted versions straight from the source, that could already be enough to sustain our work. So far this is working out! We’re able to dedicate 80% of our time to open source and haven’t gone bankrupt yet. :D

Does Uppy support S3 uploads?

Yes, please check out the docs for more information.

Can I use Uppy with Rails/Node.js/Go/PHP?

Yes, whatever you want on the backend will work with @uppy/xhr-upload plugin, since it only does a POST or PUT request. Here’s a PHP backend example.

If you want resumability with the Tus plugin, use one of the tus server implementations 👌🏼

And you’ll need @uppy/companion if you’d like your users to be able to pick files from Google Drive, Dropbox or via direct URLs (with more services coming).

Contributions are welcome

• Contributor’s guide in .github/CONTRIBUTING.md
• Changelog to track our release progress (we aim to roll out a release every

Used by

Uppy is used by: Photobox, Issuu, Law Insider, Cool Tabs, Soundoff, Scrumi, Crive and others.

Use Uppy in your project? Let us know!

Contributors

!contributors table

License

The MIT License.