@sourcesoft/uppy
v0.24.5
Extensible JavaScript file upload widget with support for drag&drop, resumable uploads, previews, restrictions, file processing/encoding, remote providers like Instagram, Dropbox, Google Drive, S3 and more :dog:
0/weekUpdated 3 years agoMITUnpacked: 7.7 MB
Published by sourcesoft
npm install @sourcesoft/uppyUppy
Uppy is a sleek, modular JavaScript file uploader that integrates seamlessly with any application. It’s fast, easy to use and lets you worry about more important problems than building a file uploader.
- Fetch files from local disk, remote urls, Google Drive, Dropbox, 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
Uppy is being developed by the folks at Transloadit, a versatile file encoding service.
Example
Code used in the above example:
``js
const Uppy = require('uppy/lib/core')
const Dashboard = require('uppy/lib/plugins/Dashboard')
const GoogleDrive = require('uppy/lib/plugins/GoogleDrive')
const Instagram = require('uppy/lib/plugins/Instagram')
const Webcam = require('uppy/lib/plugins/Webcam')
const Tus = require('uppy/lib/plugins/Tus')
const uppy = Uppy({ autoProceed: false })
.use(Dashboard, { trigger: '#select-files' })
.use(GoogleDrive, { target: Dashboard, host: 'https://server.uppy.io' })
.use(Instagram, { target: Dashboard, host: 'https://server.uppy.io' })
.use(Webcam, { target: Dashboard })
.use(Tus, { endpoint: 'https://master.tus.io/files/' })
.run()
.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, easy on dependencies :zap:
- Resumable file uploads via the open tus standard, so large uploads survive network hiccups
- Supports picking files from: Webcam, Dropbox, Google Drive, Instagram, bypassing the user’s device where possible, syncing between servers directly via uppy-server
- Works great with file encoding and processing backends, such as Transloadit, works great without (just roll your own Apache/Nginx/Node/FFmpeg/etc backend)
- Sleek user interface :sparkles:
- Optional file recovery (after a browser crash) with Golden Retriever
- Speaks multiple languages (i18n) :earth_africa:
- Built with accessibility in mind
- Free for the world, forever (as in beer 🍺, pizza 🍕, and liberty 🗽)
- Cute as a puppy, also accepts cat pictures :dog:
Installation
` bash`
$ npm install uppy --save
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
of your HTML page 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 currently 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 just a few.
1\. Add a script to the bottom of
:` html
`2\. Add CSS to
:
` html
`3\. Initialize:
html
`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.
- React — components to integrate Uppy UI plugins with React apps.
- Architecture & Making a Plugin — how to write a plugin for Uppy [documentation in progress].
Plugins
-
— resumable uploads via the open tus standard
- XHRUpload — regular uploads for any backend out there (like Apache, Nginx)
- Transloadit — support for Transloadit’s robust file uploading and encoding backend
- AwsS3 — upload to AWS S3 (also works for Google Cloud)
- Dashboard — universal UI with previews, progress bars, metadata editor and all the cool stuff
- DragDrop — plain and simple drag and drop area
- FileInput — even plainer “select files” button
- ProgressBar — minimal progress bar that fills itself when upload progresses
- StatusBar — 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)
- GoldenRetriever — restores files after a browser crash, like it’s nothing
- ThumbnailGenerator — generates image previews (included by default with Dashboard)
- Form — collects metadata from