Skip to content
main
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Oct 14, 2021
Oct 16, 2021
Apr 23, 2019
Oct 14, 2021

Uppy

Uppy logo: a superman puppy in a pink suit

Tests CI status for Uppy tests CI status for Companion tests CI status for browser tests
Deploys CI status for CDN deployment CI status for Companion deployment CI status for website deployment

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, Instagram 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 file encoding service.

Example

Code used in the above example:

import Uppy from '@uppy/core'
import Dashboard from '@uppy/dashboard'
import GoogleDrive from '@uppy/google-drive'
import Instagram from '@uppy/instagram'
import Webcam from '@uppy/webcam'
import Tus from '@uppy/tus'

const uppy = new Uppy({ autoProceed: false })
  .use(Dashboard, { trigger: '#select-files' })
  .use(GoogleDrive, { target: Dashboard, companionUrl: 'https://companion.uppy.io' })
  .use(Instagram, { target: Dashboard, companionUrl: 'https://companion.uppy.io' })
  .use(Webcam, { target: Dashboard })
  .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.

Features

  • Lightweight, modular plugin-based architecture, light on dependencies
  • Resumable file uploads via the open tus standard, so large uploads survive network hiccups
  • Supports picking files from: Webcam, Dropbox, Box, Google Drive, Instagram, bypassing the user’s device where possible, syncing between servers directly via @uppy/companion
  • Works great with file encoding and processing backends, such as Transloadit, works great without (all you need is to roll your own Apache/Nginx/Node/FFmpeg/etc backend)
  • Sleek user interface
  • Optional file recovery (after a browser crash) with Golden Retriever
  • Speaks several 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/core @uppy/dashboard @uppy/tus

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 your HTML page’s <head> or include in JS, if your bundler of choice supports it — transforms and plugins are available for Browserify and Webpack.

Alternatively, you can also use a pre-built bundle from Transloadit’s CDN: Edgly. 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/v2.2.1/uppy.min.css" rel="stylesheet">

<!-- 2. Add JS before the closing `</body>` -->
<script src="https://releases.transloadit.com/uppy/v2.2.1/uppy.min.js"></script>

<!-- 3. Initialize -->
<div class="UppyDragDrop"></div>
<script>
  var uppy = new Uppy.Core()
  uppy.use(Uppy.DragDrop, { target: '.UppyDragDrop' })
  uppy.use(Uppy.Tus, { endpoint: '//tusd.tusdemo.net/files/' })
</script>

Documentation

  • Uppy — full list of options, methods and events
  • Plugins — list of Uppy plugins and their options
  • Companion — setting up and running a Companion instance, which adds support for Instagram, Dropbox, Box, Google Drive and remote URLs
  • React — components to integrate Uppy UI plugins with React apps
  • Architecture & Writing a Plugin — how to write a plugin for Uppy

Plugins

List of plugins and their common options

UI Elements

  • Dashboard — universal UI with previews, progress bars, metadata editor and all the cool stuff. Required for most UI plugins like Webcam and Instagram
  • Progress Bar — minimal progress bar that fills itself when upload progresses
  • Status Bar — 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)

Sources

  • Drag & Drop — plain drag and drop area
  • File Input — even plainer “select files” button
  • Webcam — snap and record those selfies 📷
  • Google Drive — import files from Google Drive
  • Dropbox — import files from Dropbox
  • Box — import files from Box
  • Instagram — import images and videos from Instagram
  • Facebook — import images and videos from Facebook
  • OneDrive — import files from Microsoft OneDrive
  • Import From URL — import direct URLs from anywhere on the web

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

Destinations

  • Tus — resumable uploads via the open tus standard
  • XHR Upload — regular uploads for any backend out there (like Apache, Nginx)
  • AWS S3 — plain upload to AWS S3 or compatible services
  • AWS S3 Multipart — S3-style “Multipart” upload to AWS or compatible services

File Processing

  • Robodog — user friendly abstraction to do file processing with Transloadit
  • Transloadit — support for Transloadit’s robust file uploading and encoding backend

Miscellaneous

  • Golden Retriever — restores files after a browser crash, like it’s nothing
  • Thumbnail Generator — generates image previews (included by default with Dashboard)
  • Form — collects metadata from <form> right before an Uppy upload, then optionally appends results back to the form
  • Redux — for your emerging time traveling needs

React

  • React — components to integrate Uppy UI plugins with React apps
  • React Native — basic Uppy component for React Native with Expo

Browser Support

Sauce Test Status

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

We still provide a bundle which should work on IE11, but we are not running tests on it.

Polyfills

Here’s a list of polyfills you’ll need to include to make Uppy work in older browsers, such as IE11:

If you’re using a bundler, you need import them before Uppy:

import 'core-js'
import 'whatwg-fetch'
import 'abortcontroller-polyfill/dist/polyfill-patch-fetch'
// Order matters: AbortController needs fetch which needs Promise (provided by core-js).

import 'md-gum-polyfill'
import ResizeObserver from 'resize-observer-polyfill'

window.ResizeObserver ??= ResizeObserver

export { default } from '@uppy/core'
export * from '@uppy/core'

If you’re using Uppy from CDN, those polyfills are already included in the legacy bundle, so no need to include anything additionally:

<script src="https://releases.transloadit.com/uppy/v2.2.1/uppy.min.js"></script>

FAQ

Why not use <input type="file">?

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 are important, especially for big files and to be inclusive towards people on poorer connections (we also launched tus.io to attack that problem). Uppy uploads can survive network outages and browser crashes or accidental navigate-aways.
  • Uppy supports editing meta information before uploading (such as cropping of images).
  • There’s the situation where people are using their mobile devices and want to upload on the go, but they have their picture on Instagram, files in Dropbox or a plain file URL from anywhere on the open web. Uppy allows to pick files from those and push it to the destination without downloading it to your mobile device first.
  • Accurate upload progress reporting is an issue on many platforms.
  • Some file validation — size, type, number of files — can be done on the client with Uppy.
  • Uppy integrates webcam support, in case your users want to upload a picture/video/audio that does not exist yet :)
  • A larger drag and drop surface can be pleasant to work with. Some people also like that you can control the styling, language, etc.
  • Uppy is aware of encoding backends. Often after an upload, the server needs to rotate, detect faces, optimize for iPad, or what have you. Uppy can track progress of this and report back to the user in different ways.
  • Sometimes you might want your uploads to happen while you continue to interact on the same single page.

Not all apps need all these features. An <input type="file"> 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 React?

Yep, we have Uppy React components, please see Uppy React docs.

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 Instagram, Google Drive, Dropbox or via direct URLs (with more services coming).

Contributions are welcome

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

arturi goto-bus-stop kvz ifedapoolarewaju hedgerh AJvanLoon
arturi goto-bus-stop kvz ifedapoolarewaju hedgerh AJvanLoon
nqst aduh95 Murderlon lakesare kiloreux sadovnychyi
nqst aduh95 Murderlon lakesare kiloreux sadovnychyi
samuelayo richardwillars mifi ajkachnic dependabot[bot] zcallan
samuelayo richardwillars mifi ajkachnic dependabot[bot] zcallan
tim-kos janko wilkoklak oliverpool Botz mcallistertyler
tim-kos janko wilkoklak oliverpool Botz mcallistertyler
mokutsu-coursera YukeshShr DJWassink taoqf tuoxiansp dominiceden
mokutsu-coursera YukeshShr DJWassink taoqf tuoxiansp dominiceden
elenalape mejiaej gavboulton Hawxy bertho-zero tranvansang
elenalape mejiaej gavboulton Hawxy bertho-zero tranvansang
ap-- mrbatista MikeKovarik pauln toadkicker ofhope
ap-- mrbatista MikeKovarik pauln toadkicker ofhope
johnnyperkins dargmuesli juliangruber manuelkiessling nndevstudio ogtfaber
johnnyperkins dargmuesli juliangruber manuelkiessling nndevstudio ogtfaber
sksavant suchoproduction sunil-shrestha timodwhit yonahforst a-kriya
sksavant suchoproduction sunil-shrestha timodwhit yonahforst a-kriya
stephentuso jhen0409 mskelton ahmedkandel btrice behnammodi
stephentuso jhen0409 mskelton ahmedkandel btrice behnammodi
BePo65 Burkes craigjennings11 davekiss DenysNosov ethanwillis
BePo65 Burkes craigjennings11 davekiss DenysNosov ethanwillis
frobinsonj geertclerx ghasrfakhri jasonbosco jedwood dogrocker
frobinsonj geertclerx ghasrfakhri jasonbosco jedwood dogrocker
lamartire Mactaivsh maferland Martin005 martiuslim MatthiasKunnen
lamartire Mactaivsh maferland Martin005 martiuslim MatthiasKunnen
msand paescuj richartkeil richmeij rosenfeld jrschumacher
msand paescuj richartkeil richmeij rosenfeld jrschumacher
ThomasG77 sparanoid zhuangya allenfantasy Zyclotrop-j anark
ThomasG77 sparanoid zhuangya allenfantasy Zyclotrop-j anark
fortrieb jarey muhammadInam rettgerst mkabatek jukakoski
fortrieb jarey muhammadInam rettgerst mkabatek jukakoski
olemoign ajschmidt8 superhawk610 abannach adamelmore ajh-sr
olemoign ajschmidt8 superhawk610 abannach adamelmore ajh-sr
adamvigneault Adrrei adritasharma ahmadissa asmt3 alexnj
adamvigneault Adrrei adritasharma ahmadissa asmt3 alexnj
aalepis Dogfalo tekacs amitport functino radarhere
aalepis Dogfalo tekacs amitport functino radarhere
superandrew213 andychongyz anthony0030 Abourass arthurdenner apuyou
superandrew213 andychongyz anthony0030 Abourass arthurdenner apuyou
atsawin ayhankesicioglu azeemba azizk bducharme Quorafind
atsawin ayhankesicioglu azeemba azizk bducharme Quorafind
wbaaron bedgerotto cyu cartfisk cellvinchung chao
wbaaron bedgerotto cyu cartfisk cellvinchung chao
Cretezy csprance Aarbel cbush06 czj ardeois
Cretezy csprance Aarbel cbush06 czj ardeois
sercraig Cruaier danmichaelo danilat mrboomer akizor
sercraig Cruaier danmichaelo danilat mrboomer akizor
davilima6 DennisKofflard jeetiss sweetro efbautista yoldar
davilima6 DennisKofflard jeetiss sweetro efbautista yoldar
eliOcs EnricoSottile epexa Gkleinereva fgallinari ferdiusa
eliOcs EnricoSottile epexa Gkleinereva fgallinari ferdiusa
dtrucs geoffappleford gjungb roenschg HughbertD HussainAlkhalifah
dtrucs geoffappleford gjungb roenschg HughbertD HussainAlkhalifah
huydod IanVS ishendyweb NaxYo eltociear intenzive
huydod IanVS ishendyweb NaxYo eltociear intenzive
GreenJimmy mazoruss JacobMGEvans jdssem Jbithell jcjmcclean
GreenJimmy mazoruss JacobMGEvans jdssem Jbithell jcjmcclean
janklimo janwilts vith jessica-coursera Jmales theJoeBiz
janklimo janwilts vith jessica-coursera Jmales theJoeBiz
profsmallpine jonathanarbely jderrough jonathanly jorgeepc jszobody
profsmallpine jonathanarbely jderrough jonathanly jorgeepc jszobody
julianocomg jmontoyaa tykarol firesharkstudios elkebab kyleparisi
julianocomg jmontoyaa tykarol firesharkstudios elkebab kyleparisi
lafe leaanthony larowlan dviry galli-leo leods92
lafe leaanthony larowlan dviry galli-leo leods92
louim lucaperret lucax88x onhate mperrando marcosthejew
louim lucaperret lucax88x onhate mperrando marcosthejew
marcusforsberg Acconut martin-brennan masaok mattfik matthewhartstonge
marcusforsberg Acconut martin-brennan masaok mattfik matthewhartstonge
hrsh mhulet mkopinsky achmiral mnafees shahimclt
hrsh mhulet mkopinsky achmiral mnafees shahimclt
pleasespammelater naveed-ahmad nicojones coreprocess nil1511 leftdevel
pleasespammelater naveed-ahmad nicojones coreprocess nil1511 leftdevel
cryptic022 patricklindsay pedrofs phillipalexander ppadmavilasom Pzoco
cryptic022 patricklindsay pedrofs phillipalexander ppadmavilasom Pzoco
eman8519 luarmr SxDx robwilson1 romain-preston scherroman
eman8519 luarmr SxDx robwilson1 romain-preston scherroman
rossng rart fortunto2 samuelcolburn sebasegovia01 sergei-zelinsky
rossng rart fortunto2 samuelcolburn sebasegovia01 sergei-zelinsky
szh SpazzMarticus waptik steverob taj Tashows
szh SpazzMarticus waptik steverob taj Tashows
twarlop tmaier tomsaleeba tvaliasek vially valentinoli
twarlop tmaier tomsaleeba tvaliasek vially valentinoli
nagyv dwnste willycamargo xhocquet yaegor YehudaKremer
nagyv dwnste willycamargo xhocquet yaegor YehudaKremer
zachconner zacharylawson agreene-coursera alfatv arggh avalla
zachconner zacharylawson agreene-coursera alfatv arggh avalla
bdirito bencergazda c0b41 canvasbh christianwengert craigcbrunner
bdirito bencergazda c0b41 canvasbh christianwengert craigcbrunner
darthf1 dkisic fingul franckl gaelicwinter green-mike
darthf1 dkisic fingul franckl gaelicwinter green-mike
hxgf johnmanjiro13 kode-ninja magumbo ninesalt phil714
hxgf johnmanjiro13 kode-ninja magumbo ninesalt phil714
luntta rhymes rlebosse rtaieb slawexxx44 thanhthot
luntta rhymes rlebosse rtaieb slawexxx44 thanhthot
tinny77 vedran555 yoann-hellopret olitomas JimmyLv
tinny77 vedran555 yoann-hellopret olitomas JimmyLv

Software

We use Browserstack for manual testing BrowserStack logo

License

The MIT License.