Renée Kooi 8d2b6a8a05 Insert missing documentation links. 6 years ago
..
src 382f4fba95 Move stylesheets into packages. 6 years ago
types 7fab052e00 Move `Dashboard` to `@uppy/dashboard`. 6 years ago
LICENSE 7fab052e00 Move `Dashboard` to `@uppy/dashboard`. 6 years ago
README.md 8d2b6a8a05 Insert missing documentation links. 6 years ago
package.json 382f4fba95 Move stylesheets into packages. 6 years ago

README.md

@uppy/dashboard

Build Status

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

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.

License

The MIT License.