| 1 | # @uppy/dashboard
|
| 2 |
|
| 3 | <img src="https://uppy.io/images/logos/uppy-dog-head-arrow.svg" width="120" alt="Uppy logo: a superman puppy in a pink suit" align="right">
|
| 4 |
|
| 5 | <a href="https://www.npmjs.com/package/@uppy/dashboard"><img src="https://img.shields.io/npm/v/@uppy/dashboard.svg?style=flat-square"></a>
|
| 6 | <img src="https://github.com/transloadit/uppy/workflows/Tests/badge.svg" alt="CI status for Uppy tests"> <img src="https://github.com/transloadit/uppy/workflows/Companion/badge.svg" alt="CI status for Companion tests"> <img src="https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg" alt="CI status for browser tests">
|
| 7 |
|
| 8 | Dashboard is a universal UI plugin for Uppy:
|
| 9 |
|
| 10 | * Drag and Drop, paste, select from local disk / my device
|
| 11 | * UI for Webcam and remote sources: Google Drive, Dropbox, Instagram (all optional, added via plugins)
|
| 12 | * File previews and info
|
| 13 | * Metadata editor
|
| 14 | * Progress: total and for individual files
|
| 15 | * Ability to pause/resume or cancel (depending on uploader plugin) individual or all files
|
| 16 |
|
| 17 | **[Read the docs](https://uppy.io/docs/dashboard/)** | **[Try it](https://uppy.io/examples/dashboard/)**
|
| 18 |
|
| 19 | Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.
|
| 20 |
|
| 21 | ## Example
|
| 22 |
|
| 23 | ```js
|
| 24 | const Uppy = require('@uppy/core')
|
| 25 | const Dashboard = require('@uppy/dashboard')
|
| 26 |
|
| 27 | const uppy = new Uppy()
|
| 28 | uppy.use(Dashboard, {
|
| 29 | target: 'body',
|
| 30 | inline: true
|
| 31 | })
|
| 32 | ```
|
| 33 |
|
| 34 | ## Installation
|
| 35 |
|
| 36 | ```bash
|
| 37 | $ npm install @uppy/dashboard
|
| 38 | ```
|
| 39 |
|
| 40 | We recommend installing from npm and then using a module bundler such as [Webpack](https://webpack.js.org/), [Browserify](http://browserify.org/) or [Rollup.js](http://rollupjs.org/).
|
| 41 |
|
| 42 | 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](https://uppy.io/docs/#Installation) for instructions.
|
| 43 |
|
| 44 | ## Documentation
|
| 45 |
|
| 46 | Documentation for this plugin can be found on the [Uppy website](https://uppy.io/docs/dashboard).
|
| 47 |
|
| 48 | ## License
|
| 49 |
|
| 50 | [The MIT License](./LICENSE).
|