mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-20 16:53:33 +00:00
56b84dfec7
* Dashboard: add `required` option to `metaFields` Fixes: https://github.com/transloadit/uppy/issues/2892 * use `<form>` element to allow users to use all built-in form features from the web browser. * remove `saveOnEnter` hack The fields are now inside a form, saving on Enter is the default behavior – and it doesn't short-circuit form validation checks. * restrictions.requiredMetaFields * fix documentation of restrictions.requiredMetaFields * check for required meta fields on upload * Use detached `<form>` element to avoid nesting `<form>` elements * fixup! Use detached `<form>` element to avoid nesting `<form>` elements * Use `cuid` to generate `<form>` `id` |
||
|---|---|---|
| .. | ||
| src | ||
| types | ||
| LICENSE | ||
| package.json | ||
| 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
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 = 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.