mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-31 14:00:43 +00:00
8735c896a5
* Added possibility of specifying form field type. * remove log statements * Change to allow providing custom render function * Add Types and Docs. * Pass Uppy-styled CSS class names, so developers can leverege them when adding their custom inputs @goto-bus-stop as we’ve discussed, what do you think? * Fix var name * dashboard: make typings for `render()` stricter so people will get type errors if they try to return React elements or raw DOM nodes. Co-authored-by: Artur Paikin <artur@arturpaikin.com> Co-authored-by: Renée Kooi <renee@kooi.me> |
||
|---|---|---|
| .. | ||
| src | ||
| types | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
@uppy/dashboard
Dashboard is a universal UI plugin for Uppy:
- Drag and Drop, paste, select from local disk / my device
- UI for Webcam and remote sources: Google Drive, Dropbox, Instagram (all optional, added via plugins)
- File previews and info
- Metadata editor
- Progress: total and for individual files
- Ability to pause/resume or cancel (depending on uploader plugin) individual or all files
Uppy is being developed by the folks at Transloadit, a versatile file encoding service.
Example
const Uppy = require('@uppy/core')
const Dashboard = require('@uppy/dashboard')
const uppy = Uppy()
uppy.use(Dashboard, {
target: 'body',
inline: true
})
Installation
$ npm install @uppy/dashboard --save
We recommend installing from npm and then using a module bundler such as Webpack, Browserify or Rollup.js.
Alternatively, you can also use this plugin in a pre-built bundle from Transloadit's CDN: Edgly. In that case Uppy will attach itself to the global window.Uppy object. See the main Uppy documentation for instructions.
Documentation
Documentation for this plugin can be found on the Uppy website.