mirror of https://github.com/transloadit/uppy.git synced 2026-07-30 13:30:31 +00:00

History

Renée Kooi c62ec3665d Update eslint to v6 (#1777 ) * Update eslint * Do eslint --fix * Do not access Object.prototype method 'hasOwnProperty' from target object * utils: add hasProperty * eslint --fix * Disable quote-props for locale files * add back quotes in locale files * revert locale files to state on master * Update react-scripts		2019-08-13 21:45:30 +03:00
..
src	Update eslint to v6 (#1777 )	2019-08-13 21:45:30 +03:00
types	fix wrong definition for metaFields property (#1763 )	2019-08-02 13:10:37 +02:00
LICENSE	Move `Dashboard` to `@uppy/dashboard`.	2018-06-14 16:31:19 +02:00
package.json	lerna link convert (#1730 )	2019-07-19 12:16:36 +02:00
README.md	docs: update webpack homepage URLs	2019-03-04 13:43:37 +01: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.