Antoine du Hamel 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
..
src 005a7e48ec showLinkToFileUploadResult: false by default (#2994) 3 years ago
types 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
LICENSE 7fab052e00 Move `Dashboard` to `@uppy/dashboard`. 6 years ago
README.md c48064ba56 doc: lint JS code snippets (#2954) 3 years ago
package.json fe96096c3d Merge branch 'master' into 2.0 3 years ago

README.md

@uppy/dashboard

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.