mirror of https://github.com/transloadit/uppy.git synced 2026-07-25 03:08:34 +00:00

History

Renée Kooi 10bc79574e lerna link convert (#1730 ) * lerna link convert * ci: use npm ci * update lockfile * companion: set `bin` to source file Since typescript doesn't actually transform anything, we can just use this. In a next major version we could set `noEmit: true` in the tsconfig and stop publishing `lib`. * companion: do chmod +x on start-server.js * build: remove obsolete lerna config * build: explicitly install latest versions when building e2e tests for ci * Remove versions from private packages * fix regex * try fix * ci: force npm to install to endtoend folder * ci: fold up e2e build output * Update netlify deploy preview command * Remove mentions of npm run bootstrap * Edit .github/CONTRIBUTING.md instead * companion: add proxy executable * companion: fix publish * Downgrade jest to appease create-react-app		2019-07-19 12:16:36 +02:00
..
src	we don’t need no padding-top, we don’t need no space control	2019-07-18 16:35:57 +02:00
types	typescript: fix uppy package use with allowSyntheticImports: false	2019-04-01 11:47:52 +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.