# Uppy
Uppy is (going to be) 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.
Uppy is developed by the [Transloadit](https://transloadit.com) team.
Check out [uppy.io](http://uppy.io/) for docs, API, examples and stats.
## Features (some in development)
- Lightweight, modular plugin-based architecture, easy on dependencies :zap:
- Use from a CDN or as a module to import
- Resumable file uploads via the open [tus](http://tus.io/) standard
- Supports picking files from sources like: Webcam, Dropbox, Facebook, bypassing the user's device where possible, syncing between servers directly via [uppy-server](https://github.com/transloadit/uppy-server)
- A nice user interface :sparkles:
- Speaks multiple languages (i18n) :earth_africa:
- 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](http://transloadit.com), works great without (just roll your own Apache/Nginx/Node/etc backend)
- Cute as a puppy, also accepts cat pictures :dog:
## Demo
- [Full featured UI](http://uppy.io/examples/dashboard)
- [Simple Drag & Drop](http://uppy.io/examples/dragdrop)
## Usage
### Installing from NPM
```sh
$ npm install uppy --save
```
Bundle with Browserify or Webpack:
```js
import Uppy from 'uppy/lib/core'
import DragDrop from 'uppy/lib/plugins/DragDrop'
import Tus10 from 'uppy/lib/plugins/Tus10'
const uppy = Uppy()
uppy
.use(DragDrop, {target: 'body'})
.use(Tus10, {endpoint: '//master.tus.io/files/'})
.run()
```
Add CSS [uppy.min.css](https://unpkg.com/uppy/dist/uppy.min.css), either to `` of your HTML page or include in JS, if your bundler of choice supports it — transforms and plugins are available for Browserify and Webpack.
Give Uppy a spin [on RequireBin](http://requirebin.com/?gist=54e076cccc929cc567cb0aba38815105).
### Installing from CDN
But if you like, you can also use a pre-built bundle, for example from [unpkg CDN](https://unpkg.com/uppy/). In that case `Uppy` will attach itself to the global `window` object.
1\. Add a script to your the bottom of your HTML’s ``:
```html
```
2\. Add CSS to your HTML’s ``:
```html
```
3\. Initialize:
```js
```
## API
:warning: :construction: API is unstable and is subject to breaking changes
Uppy exposes events that you can subscribe to in your app:
### Event `core:upload-progress` when file upload progress is available
```js
uppy.on('core:upload-progress', (data) => {
console.log(data.id, data.bytesUploaded, data.bytesTotal)
})
```
### Event `core:upload-success` when one upload is complete
```js
uppy.on('core:upload-success', (fileId, response) => {
console.log(response.url)
var img = new Image()
img.width = 300
img.alt = fileId
img.src = response.url
document.body.appendChild(img)
})
```
### Event `core:success` when all uploads are complete
```js
uppy.on('core:success', (fileCount) => {
console.log(fileCount)
})
```
## 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 `
Uppy is (going to be) 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.
Uppy is developed by the [Transloadit](https://transloadit.com) team.
Check out [uppy.io](http://uppy.io/) for docs, API, examples and stats.
## Features (some in development)
- Lightweight, modular plugin-based architecture, easy on dependencies :zap:
- Use from a CDN or as a module to import
- Resumable file uploads via the open [tus](http://tus.io/) standard
- Supports picking files from sources like: Webcam, Dropbox, Facebook, bypassing the user's device where possible, syncing between servers directly via [uppy-server](https://github.com/transloadit/uppy-server)
- A nice user interface :sparkles:
- Speaks multiple languages (i18n) :earth_africa:
- 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](http://transloadit.com), works great without (just roll your own Apache/Nginx/Node/etc backend)
- Cute as a puppy, also accepts cat pictures :dog:
## Demo
- [Full featured UI](http://uppy.io/examples/dashboard)
- [Simple Drag & Drop](http://uppy.io/examples/dragdrop)
## Usage
### Installing from NPM
```sh
$ npm install uppy --save
```
Bundle with Browserify or Webpack:
```js
import Uppy from 'uppy/lib/core'
import DragDrop from 'uppy/lib/plugins/DragDrop'
import Tus10 from 'uppy/lib/plugins/Tus10'
const uppy = Uppy()
uppy
.use(DragDrop, {target: 'body'})
.use(Tus10, {endpoint: '//master.tus.io/files/'})
.run()
```
Add CSS [uppy.min.css](https://unpkg.com/uppy/dist/uppy.min.css), either to `` of your HTML page or include in JS, if your bundler of choice supports it — transforms and plugins are available for Browserify and Webpack.
Give Uppy a spin [on RequireBin](http://requirebin.com/?gist=54e076cccc929cc567cb0aba38815105).
### Installing from CDN
But if you like, you can also use a pre-built bundle, for example from [unpkg CDN](https://unpkg.com/uppy/). In that case `Uppy` will attach itself to the global `window` object.
1\. Add a script to your the bottom of your HTML’s ``:
```html
```
2\. Add CSS to your HTML’s ``:
```html
```
3\. Initialize:
```js
```
## API
:warning: :construction: API is unstable and is subject to breaking changes
Uppy exposes events that you can subscribe to in your app:
### Event `core:upload-progress` when file upload progress is available
```js
uppy.on('core:upload-progress', (data) => {
console.log(data.id, data.bytesUploaded, data.bytesTotal)
})
```
### Event `core:upload-success` when one upload is complete
```js
uppy.on('core:upload-success', (fileId, response) => {
console.log(response.url)
var img = new Image()
img.width = 300
img.alt = fileId
img.src = response.url
document.body.appendChild(img)
})
```
### Event `core:success` when all uploads are complete
```js
uppy.on('core:success', (fileCount) => {
console.log(fileCount)
})
```
## 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 `