Antoine du Hamel 96dc19766c @uppy/dashboard: refactor to stable lifecycle method (#4999) 1 year ago
..
src 96dc19766c @uppy/dashboard: refactor to stable lifecycle method (#4999) 1 year ago
types 83e2527810 fix(@uppy/dashboard): fix wrong option type in index.d.ts (#4788) 1 year ago
CHANGELOG.md 0fd1a2a2ef Release: uppy@3.22.2 (#4952) 1 year ago
LICENSE 7fab052e00 Move `Dashboard` to `@uppy/dashboard`. 6 years ago
README.md 7adacb74a7 meta: Fix logos in all the readmes (#4407) 2 years ago
package.json 3be236ddc9 Release: uppy@3.23.0 (#4976) 1 year ago

README.md

@uppy/dashboard

npm version CI status for Uppy tests CI status for Companion tests CI status for browser tests

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

Read the docs | Try it

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

import Uppy from '@uppy/core'
import Dashboard from '@uppy/dashboard'

const uppy = new Uppy()
uppy.use(Dashboard, {
  target: 'body',
  inline: true,
})

Installation

$ npm install @uppy/dashboard

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.

License

The MIT License.