github-actions[bot] 3e5be3250e Release: uppy@2.3.1 (#3357) 3 years ago
..
src 479f3a68a5 deps: use `nanoid/non-secure` to workaround react-native limitation (#3350) 3 years ago
types 8985283572 Disable drop state for non-files (#2449) 3 years ago
CHANGELOG.md 3e5be3250e Release: uppy@2.3.1 (#3357) 3 years ago
LICENSE 7fab052e00 Move `Dashboard` to `@uppy/dashboard`. 6 years ago
README.md 55e0ffd04a Add retext to markdown linter (#3024) 3 years ago
package.json 3e5be3250e Release: uppy@2.3.1 (#3357) 3 years 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

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.

License

The MIT License.