mirror of https://github.com/transloadit/uppy.git synced 2026-07-23 18:29:09 +00:00

History

Renée Kooi bd6c2c36ae Release - uppy@0.27.2 - @uppy/companion@0.14.2 - @uppy/dashboard@0.27.2 - @uppy/google-drive@0.27.2 - @uppy/instagram@0.27.2 - @uppy/react@0.27.2 - @uppy/transloadit@0.27.2 - @uppy/tus@0.27.2 - @uppy/url@0.27.2		2018-08-23 12:38:49 +02:00
..
src	show note and “powered by” when no acquire/sources plugins are used too	2018-08-13 22:53:51 +01:00
types	Add type tests for the Dashboard.	2018-06-28 16:30:25 +02:00
LICENSE	Move `Dashboard` to `@uppy/dashboard`.	2018-06-14 16:31:19 +02:00
package.json	Release	2018-08-23 12:38:49 +02:00
README.md	Insert missing documentation links.	2018-06-18 13:20:19 +02:00

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

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.