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

History

Renée Kooi be66c47deb Actually check types (#1918 ) * types: stronger typings * Remove remaining `declare module` things for uppy.use * Format types standard-style-like * Add `target` properties to plugin typings * Add type for `replaceTargetContent` option * xhr-upload: allow lowercase method * opt in to stricter typechecks * use the strictly typed version in all typings tests * endtoend: use strict types in typescript test * Add some comments to the typings file so IDEs will warn about untyped use() * informer: remove obsolete option from typings * react: generate prop types based on actual options types * react: update types * react: fix import in typings test * companion-client: add `pluginId` property to ProviderOptions type Co-Authored-By: Ifedapo .A. Olarewaju <ifedapoolarewaju@gmail.com> * core: remove some `any` types * : add locale string types : generate locale typings core: fix LocaleStrings<> type * dashboard: add locale string type tests * tus: inherit options typings from tus-js-client * transloadit: add missing options types * ci: do the required build steps before testing typings * Support TokenStorage in types, add `title?: string` options * form: update typings * types: put TokenStorage type in dependents * Document Uppy.StrictTypes * if we pin at least we should use the latest * Allow document.querySelector I think it's a eslint-plugin-compat bug that it's marking querySelector as not available in Android Chrome 78. Co-authored-by: Ifedapo .A. Olarewaju <ifedapoolarewaju@gmail.com>		2020-02-12 16:22:09 +01:00
..
src	Changed aria-level attribute to correct syntax. (#2032 )	2020-01-22 13:06:53 +01:00
types	Actually check types (#1918 )	2020-02-12 16:22:09 +01:00
LICENSE	Move `Dashboard` to `@uppy/dashboard`.	2018-06-14 16:31:19 +02:00
package.json	Release	2020-02-12 12:24:41 +01: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.