• Stars
    star
    29,122
  • Rank 634 (Top 0.02 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created about 9 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The next open source file uploader for web browsers 🐶

Uppy logo: a smiling puppy above a pink upwards arrow

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 API to handle any file in your app.

TestsCI status for Uppy testsCI status for Companion testsCI status for browser tests
DeploysCI status for CDN deploymentCI status for Companion deploymentCI status for website deployment

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, { target: Dashboard })
  .use(ImageEditor, { 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

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

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/v3.24.3/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/v3.24.3/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
  • 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

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

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

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 to 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/v3.24.3/uppy.legacy.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.
  • Uppy allows cropping images before uploading.
  • 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 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 aduh95 ifedapoolarewaju hedgerh
arturi goto-bus-stop kvz aduh95 ifedapoolarewaju hedgerh
Murderlon AJvanLoon nqst mifi github-actions[bot] lakesare
Murderlon AJvanLoon nqst mifi github-actions[bot] lakesare
dependabot[bot] kiloreux samuelayo sadovnychyi richardwillars ajkachnic
dependabot[bot] kiloreux samuelayo sadovnychyi richardwillars ajkachnic
zcallan YukeshShr janko oliverpool Botz mcallistertyler
zcallan YukeshShr janko oliverpool Botz mcallistertyler
mokutsu-coursera dschmidt DJWassink mrbatista taoqf timodwhit
mokutsu-coursera dschmidt DJWassink mrbatista taoqf timodwhit
tim-kos eltociear tuoxiansp pauln MikeKovarik toadkicker
tim-kos eltociear tuoxiansp pauln MikeKovarik toadkicker
ap-- tranvansang LiviaMedeiros bertho-zero juliangruber Hawxy
ap-- tranvansang LiviaMedeiros bertho-zero juliangruber Hawxy
gavboulton mejiaej elenalape dominiceden Acconut jhen0409
gavboulton mejiaej elenalape dominiceden Acconut jhen0409
stephentuso bencergazda a-kriya yonahforst suchoproduction sksavant
stephentuso bencergazda a-kriya yonahforst suchoproduction sksavant
ogtfaber nndevstudio MatthiasKunnen manuelkiessling dargmuesli johnnyperkins
ogtfaber nndevstudio MatthiasKunnen manuelkiessling dargmuesli johnnyperkins
ofhope yaegor zhuangya sparanoid ThomasG77 subha1206
ofhope yaegor zhuangya sparanoid ThomasG77 subha1206
schonert SlavikTraktor scottbessler jrschumacher rosenfeld rdimartino
schonert SlavikTraktor scottbessler jrschumacher rosenfeld rdimartino
richmeij Youssef1313 allenfantasy Zyclotrop-j anark bdirito
richmeij Youssef1313 allenfantasy Zyclotrop-j anark bdirito
darthf1 fortrieb heocoi jarey muhammadInam rettgerst
darthf1 fortrieb heocoi jarey muhammadInam rettgerst
mkabatek jukakoski olemoign ahmedkandel btrice 5idereal
mkabatek jukakoski olemoign ahmedkandel btrice 5idereal
AndrwM behnammodi BePo65 bradedelman camiloforero command-tab
AndrwM behnammodi BePo65 bradedelman camiloforero command-tab
craig-jennings davekiss denysdesign ethanwillis richartkeil paescuj
craig-jennings davekiss denysdesign ethanwillis richartkeil paescuj
msand martiuslim Martin005 mskelton mactavishz lafe
msand martiuslim Martin005 mskelton mactavishz lafe
dogrocker jedwood jasonbosco frobinsonj ghasrfakhri geertclerx
dogrocker jedwood jasonbosco frobinsonj ghasrfakhri geertclerx
neuronet77 rossng scherroman robwilson1 SxDx refo
neuronet77 rossng scherroman robwilson1 SxDx refo
raulibanez luarmr eman8519 Pzoco ppadmavilasom phillipalexander
raulibanez luarmr eman8519 Pzoco ppadmavilasom phillipalexander
pmusaraj pedrofs plneto patricklindsay pascalwengerter Tashows
pmusaraj pedrofs plneto patricklindsay pascalwengerter Tashows
taj strayer sjauld steverob amaitu quigebo
taj strayer sjauld steverob amaitu quigebo
waptik SpazzMarticus szh sergei-zelinsky sebasegovia01 sdebacker
waptik SpazzMarticus szh sergei-zelinsky sebasegovia01 sdebacker
samuelcolburn fortunto2 GNURub rart ken-kuro mkopinsky
samuelcolburn fortunto2 GNURub rart ken-kuro mkopinsky
mhulet hrsh mauricioribeiro matthewhartstonge mjesuele mattfik
mhulet hrsh mauricioribeiro matthewhartstonge mjesuele mattfik
mateuscruz masumulu28 masaok martin-brennan marcusforsberg marcosthejew
mateuscruz masumulu28 masaok martin-brennan marcusforsberg marcosthejew
mperrando onhate marc-mabe ParsaArvanehPA cryptic022 Ozodbek1405
mperrando onhate marc-mabe ParsaArvanehPA cryptic022 Ozodbek1405
leftdevel nil1511 coreprocess nicojones trungcva10a6tn naveed-ahmad
leftdevel nil1511 coreprocess nicojones trungcva10a6tn naveed-ahmad
pleasespammelater marton-laszlo-attila navruzm mogzol shahimclt mnafees
pleasespammelater marton-laszlo-attila navruzm mogzol shahimclt mnafees
boudra achmiral mosi-kha maddy-jo mdxiaohu magumbo
boudra achmiral mosi-kha maddy-jo mdxiaohu magumbo
jx-zyf kode-ninja sontixyou jur-ng johnmanjiro13 jyoungblood
jx-zyf kode-ninja sontixyou jur-ng johnmanjiro13 jyoungblood
green-mike gaelicwinter frederikhors franckl fingul elliotsayes
green-mike gaelicwinter frederikhors franckl fingul elliotsayes
YehudaKremer JimmyLv zanzlender olitomas yoann-hellopret vedran555
YehudaKremer JimmyLv zanzlender olitomas yoann-hellopret vedran555
tusharjkhunt thanhthot stduhpf slawexxx44 rtaieb rmoura-92
tusharjkhunt thanhthot stduhpf slawexxx44 rtaieb rmoura-92
rlebosse rhymes luntta phil714 ordago odselsevier
rlebosse rhymes luntta phil714 ordago odselsevier
ninesalt xhocquet willycamargo weston-sankey-mark43 dwnste nagyv
ninesalt xhocquet willycamargo weston-sankey-mark43 dwnste nagyv
stiig valentinoli vially trivikr top-master tvaliasek
stiig valentinoli vially trivikr top-master tvaliasek
tomekp tomsaleeba WIStudent tmaier twarlop tcgj
tomekp tomsaleeba WIStudent tmaier twarlop tcgj
dzcpy dkisic craigcbrunner codehero7386 christianwengert cgoinglove
dzcpy dkisic craigcbrunner codehero7386 christianwengert cgoinglove
canvasbh c0b41 avalla arggh alfatv agreene-coursera
canvasbh c0b41 avalla arggh alfatv agreene-coursera
aduh95-test-account sartoshi-foot-dao zackbloom zlawson-ut zachconner yafkari
aduh95-test-account sartoshi-foot-dao zackbloom zlawson-ut zachconner yafkari
Cruaier sercraig ardeois CommanderRoot czj cbush06
Cruaier sercraig ardeois CommanderRoot czj cbush06
Aarbel cfra csprance prattcmp subvertallchris charlybillaud
Aarbel cfra csprance prattcmp subvertallchris charlybillaud
Cretezy chao cellvinchung cartfisk cyu radarhere
Cretezy chao cellvinchung cartfisk cyu radarhere
kergekacsa eliOcs yoldar efbautista emuell EdgarSantiago93
kergekacsa eliOcs yoldar efbautista emuell EdgarSantiago93
sweetro jeetiss DennisKofflard hoangsvit davilima6 akizor
sweetro jeetiss DennisKofflard hoangsvit davilima6 akizor
KaminskiDaniell Cantabar mrboomer danilat danschalow danmichaelo
KaminskiDaniell Cantabar mrboomer danilat danschalow danmichaelo
functino amitport tekacs Dogfalo aalepis alexnj
functino amitport tekacs Dogfalo aalepis alexnj
asmt3 ahmadissa adritasharma Adrrei adityapatadia adamvigneault
asmt3 ahmadissa adritasharma Adrrei adityapatadia adamvigneault
ajh-sr adamdottv abannach superhawk610 ajschmidt8 bryanjswift
ajh-sr adamdottv abannach superhawk610 ajschmidt8 bryanjswift
bedgerotto wbaaron Quorafind bducharme azizk azeemba
bedgerotto wbaaron Quorafind bducharme azizk azeemba
ayhankesicioglu atsawin ash-jc-allen apuyou arthurdenner Abourass
ayhankesicioglu atsawin ash-jc-allen apuyou arthurdenner Abourass
tyndria anthony0030 andychongyz andrii-bodnar superandrew213 firesharkstudios
tyndria anthony0030 andychongyz andrii-bodnar superandrew213 firesharkstudios
kaspermeinema tykarol jvelten mellow-fellow jmontoyaa jcalonso
kaspermeinema tykarol jvelten mellow-fellow jmontoyaa jcalonso
jbelej jszobody jorgeepc jondewoo jonathanarbely jsanchez034
jbelej jszobody jorgeepc jondewoo jonathanarbely jsanchez034
Jokcy chromacoma profsmallpine IanVS Lucklj521 lucax88x
Jokcy chromacoma profsmallpine IanVS Lucklj521 lucax88x
lucaperret ombr louim dolphinigle leomelzer leods92
lucaperret ombr louim dolphinigle leomelzer leods92
galli-leo dviry larowlan leaanthony hoangbits labohkip81
galli-leo dviry larowlan leaanthony hoangbits labohkip81
kyleparisi elkebab kidonng kevin-west-10x huydod HussainAlkhalifah
kyleparisi elkebab kidonng kevin-west-10x huydod HussainAlkhalifah
HughbertD hiromi2424 giacomocerquone roenschg gjungb geoffappleford
HughbertD hiromi2424 giacomocerquone roenschg gjungb geoffappleford
gabiganam fuadscodes dtrucs ferdiusa fgallinari Gkleinereva
gabiganam fuadscodes dtrucs ferdiusa fgallinari Gkleinereva
epexa EnricoSottile elliotdickison theJoeBiz Jmales jessica-coursera
epexa EnricoSottile elliotdickison theJoeBiz Jmales jessica-coursera
vith janwilts janklimo jamestiotio jcjmcclean Jbithell
vith janwilts janklimo jamestiotio jcjmcclean Jbithell
JakubHaladej jakemcallister gaejabong JacobMGEvans mazoruss GreenJimmy
JakubHaladej jakemcallister gaejabong JacobMGEvans mazoruss GreenJimmy
intenzive NaxYo ishendyweb
intenzive NaxYo ishendyweb

Software

We use Browserstack for manual testing BrowserStack logo

License

The MIT License.

More Repositories

1

uppy-server

[DEPRECATED] 'Uppy Server' was renamed to 'Companion' and lives inside the Uppy repo no
JavaScript
114
star
2

node-sdk

Transloadit's official Node.js SDK
TypeScript
62
star
3

php-sdk

Transloadit's official PHP SDK
PHP
61
star
4

jquery-sdk

DEPRECATED. https://uppy.io is Transloadit's browser integration that works with any framework including jQuery
JavaScript
59
star
5

rails-sdk

Transloadit's official Rails SDK, maintained by the community
Ruby
47
star
6

transloadify

🤖☁️📽📦 Transloadit's cloud encoding in a box
JavaScript
29
star
7

ruby-sdk

Transloadit's official Ruby SDK, maintained by the community
Ruby
28
star
8

letsbuild-youtube-clone

Let's build: A (very basic) YouTube Clone using Vue.js, Uppy, Node.js, Firebase, Transloadit
JavaScript
19
star
9

go-sdk

Transloadit's official Go SDK, maintained by the community
Go
19
star
10

TransloaditKit

An iOS and macOS integration for Transloadit's file uploading and encoding service
Swift
16
star
11

python-sdk

Python integration for Transloadit
Python
13
star
12

uppy.io

The Uppy website
TypeScript
12
star
13

java-sdk

Java client for Transloadit upload service
Java
11
star
14

uppy-vimeo-thing

A Vimeo thing for Uppy!
JavaScript
10
star
15

terraform-provider-transloadit

Terraform integration for Transloadit
Go
7
star
16

monolib

🏡 A monorepo with publicly published TypeScript utils that we can re-use in our different projects. Not recommended for use outside Transloadit. No SemVer guarantees. Use at own Risk.
TypeScript
7
star
17

android-sdk

Transloadit's official Android SDK
Java
6
star
18

benchr

Shell
3
star
19

ts-fly

Run TS on-the-fly on Node.js
JavaScript
3
star
20

bubble-plugin

This is a repository based on the Bubble plugin 'uppy-transloadit' (https://bubble.is).
JavaScript
3
star
21

types

PRE-ALPHA, BROKEN, AND SUBJECT TO FUNDAMENTAL CHANGE. DO NOT USE YET--Types for Transloadit Robots, Assemblies and Templates
TypeScript
2
star
22

heroku-addon

The docs for Transloadit's Heroku Addon
2
star
23

eslint-config-transloadit

Transloadit eslint rules
JavaScript
2
star
24

notify-url-proxy

Allows testing your notify_url locally.
JavaScript
2
star
25

eslint-plugin-transloadit

Custom ESLint rules by Transloadit
JavaScript
1
star
26

uppy-utils

Utility functions for use in Uppy
JavaScript
1
star
27

update-pr-title

JavaScript
1
star
28

node-sdk-coverage

Auto generated coverage reports for node-sdk
HTML
1
star