| assets | ||
| bin | ||
| examples | ||
| src | ||
| test | ||
| website | ||
| .babelrc | ||
| .browsersync.js | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .travis.yml | ||
| ARCHITECTURE.md | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| env.example.sh | ||
| LICENSE | ||
| Makefile | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| SERVER-PLAN.md | ||
| UPPY-CALL.md | ||
| uppy-screenshot.jpg | ||
Uppy
Uppy is a sleek, modular file uploader that integrates seemlessly with any framework. It fetches files from local disk, Google Drive, Dropbox, Instagram, remote URLs, cameras and other exciting locations, and then uploads them to the final destination. It’s fast, easy to use and let's you worry about more important problems than building a file uploader. Try it live.
Uppy is developed by the Transloadit team.
Check out docs and examples on uppy.io.
Features
- Lightweight, modular plugin-based architecture, easy on dependencies ⚡
- Use from a CDN or as a module to import
- 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
- A sleek user interface ✨
- Speaks multiple languages (i18n) 🌍
- Built with accessibility in mind
- Free for the world, forever (as in beer 🍺, pizza 🍕, and liberty 🗽)
- Works great with file encoding and processing backends, such as Transloadit, works great without (just roll your own Apache/Nginx/Node/etc backend)
- Cute as a puppy, also accepts cat pictures 🐶
Installation
$ npm install uppy
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, even if you are using just a few.
1. Add a script to the bottom of <body>:
<script src="https://unpkg.com/uppy/dist/uppy.min.js"></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.Tus10, {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.
- Architecture & Making a Plugin — how to write a plugin for Uppy [documentation in progress].
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