transloadit/uppyPublic

NotificationsYou must be signed in to change notification settings
Fork2k
Star29.7k

The next open source file uploader for web browsers 🐶

License

MIT license

29.7k stars 2k forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 10,165 Commits
.github		.github
.vscode		.vscode
.yarn/patches		.yarn/patches
assets		assets
bin		bin
e2e		e2e
examples		examples
output		output
packages		packages
private		private
.browserslistrc		.browserslistrc
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.env.example		.env.example
.eslintignore		.eslintignore
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.js		.prettierrc.js
.remarkignore		.remarkignore
.stylelintrc.json		.stylelintrc.json
.yarnrc.yml		.yarnrc.yml
BACKLOG.md		BACKLOG.md
BUNDLE-README.md		BUNDLE-README.md
CHANGELOG.md		CHANGELOG.md
Dockerfile		Dockerfile
Dockerfile.test		Dockerfile.test
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
SECURITY.md		SECURITY.md
babel.config.js		babel.config.js
docker-compose-dev.yml		docker-compose-dev.yml
docker-compose-test.yml		docker-compose-test.yml
docker-compose.yml		docker-compose.yml
package.json		package.json
tsconfig.build.json		tsconfig.build.json
tsconfig.json		tsconfig.json
tsconfig.shared.json		tsconfig.shared.json
vitest.config.ts		vitest.config.ts
yarn.lock		yarn.lock

Repository files navigation

Uppy

Uppy is a sleek, modular JavaScript file uploader that integrates seamlesslywith any application. It’s fast, has a comprehensible API and lets you worryabout 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 atTransloadit,a versatile API to handle any file in your app.

Tests
Deploys

Example

Code used in the above example:

importUppyfrom'@uppy/core'importDashboardfrom'@uppy/dashboard'importRemoteSourcesfrom'@uppy/remote-sources'importImageEditorfrom'@uppy/image-editor'importWebcamfrom'@uppy/webcam'importTusfrom'@uppy/tus'constuppy=newUppy().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 orread the docs for more details on how to use Uppyand its plugins.

Features

Lightweight, modular plugin-based architecture, light on dependencies ⚡
Resumable file uploads via the opentus standard, so largeuploads survive network hiccups
Supports picking files from: Webcam, Dropbox, Box, Google Drive, Instagram,bypassing the user’s device where possible, syncing between servers directlyvia@uppy/companion
Works great with file encoding and processing backends, such asTransloadit, works great without (all you need isto roll your own Apache/Nginx/Node/FFmpeg/etc backend)
Sleek user interface ✨
Optional file recovery (after a browser crash) withGolden 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 CSSuppy.min.css,either to your HTML page’s<head> or include in JS, if your bundler of choicesupports it.

Alternatively, you can also use a pre-built bundle from Transloadit’s CDN: SmartCDN. In that caseUppy will attach itself to the globalwindow.Uppy object.

⚠️ The bundle consists of most Uppy plugins, so this method is not recommendedfor production, as your users will have to download all plugins when you arelikely using only a few.

<!-- 1. Add CSS to `<head>` --><linkhref="https://releases.transloadit.com/uppy/v4.15.0/uppy.min.css"rel="stylesheet"/><!-- 2. Initialize --><divid="files-drag-drop"></div><scripttype="module">import{Uppy,Dashboard,Tus,}from'https://releases.transloadit.com/uppy/v4.15.0/uppy.min.mjs'constuppy=newUppy()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 aCompanion instance, which adds support for Instagram, Dropbox, Box, GoogleDrive and remote URLs
React — components to integrate Uppy UI pluginswith React apps
Architecture & Writing a Plugin — howto write a plugin for Uppy

Plugins

UI Elements

Dashboard — universal UI with previews,progress bars, metadata editor and all the cool stuff. Required for most UIplugins like Webcam and Instagram
Progress Bar — minimal progress barthat fills itself when upload progresses
Status Bar — more detailed progress,pause/resume/cancel buttons, percentage, speed, uploaded/total sizes (includedby default withDashboard)
Informer — send notifications like “smile”before taking a selfie or “upload failed” when all is lost (also included bydefault withDashboard)

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 fromGoogle Drive
ⓒDropbox — import files from Dropbox
ⓒBox — import files from Box
ⓒInstagram — import images and videosfrom Instagram
ⓒFacebook — import images and videos fromFacebook
ⓒOneDrive — import files from MicrosoftOneDrive
ⓒImport From URL — import direct URLs fromanywhere on the web

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

Destinations

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

File Processing

Transloadit — support forTransloadit’s robust file uploading and encodingbackend

Miscellaneous

Golden Retriever — restores filesafter a browser crash, like it’s nothing
Thumbnail Generator — generatesimage previews (included by default withDashboard)
Form — collects metadata from<form> rightbefore an Uppy upload, then optionally appends results back to the form
Redux — for youremergingtime traveling needs

React

React — components to integrate Uppy UI pluginswith React apps
React Native — basic Uppy component for ReactNative with Expo

Browser Support

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

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 incases, the file input leaves some to be desired:

We received complaints about broken uploads and found that resumable uploadsare important, especially for big files and to be inclusive towards people onpoorer connections (we also launchedtus.io to attack thatproblem). Uppy uploads can survive network outages and browser crashes oraccidental 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 toupload on the go, but they have their picture on Instagram, files in Dropboxor a plain file URL from anywhere on the open web. Uppy allows to pick filesfrom those and push it to the destination without downloading it to yourmobile 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 clientwith Uppy.
Uppy integrates webcam support, in case your users want to upload apicture/video/audio that does not exist yet :)
A larger drag and drop surface can be pleasant to work with. Some people alsolike that you can control the styling, language, etc.
Uppy is aware of encoding backends. Often after an upload, the server needs torotate, detect faces, optimize for iPad, or what have you. Uppy can trackprogress of this and report back to the user in different ways.
Sometimes you might want your uploads to happen while you continue to interacton the same single page.

Not all apps need all these features. An<input type="file"> is fine in manysituations. But these were a few things that our customers hit / asked aboutenough 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 fromopen source. By giving away projects liketus.io andUppy, we’re hoping to advance the state of the art, make lifea tiny little bit better for everyone and in doing so have rewarding jobs andget 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 theappeal of hosted versions straight from the source, that could already be enoughto sustain our work. So far this is working out! We’re able to dedicate 80% ofour time to open source and haven’t gone bankrupt yet. :D

Does Uppy support S3 uploads?

Yes, please check out thedocs for moreinformation.

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 aPOST orPUT request. Here’s aPHP backend example.

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

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