Renée Kooi 6b82d12d42 Release 6 years ago
..
src 88cfe9d5aa refactor StatusBar status containers 6 years ago
types 73202c2108 Add uppy.use() overloads to plugin typings. 6 years ago
LICENSE 79f7fbeff5 @uppy/statusbar --> @uppy/status-bar 6 years ago
README.md 79f7fbeff5 @uppy/statusbar --> @uppy/status-bar 6 years ago
package.json 6b82d12d42 Release 6 years ago

README.md

@uppy/status-bar

Build Status

The status-bar shows upload progress and speed, ETAs, pre- and post-processing information, and allows users to control (pause/resume/cancel) the upload. Best used together with a simple file source plugin, such as @uppy/file-input or @uppy/drag-drop, or a custom implementation. It is also included in the @uppy/dashboard plugin.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

const Uppy = require('@uppy/core')
const StatusBar = require('@uppy/status-bar')

const uppy = Uppy()
uppy.use(StatusBar, {
  target: 'body',
  hideUploadButton: false,
  showProgressDetails: false,
  hideAfterFinish: true
})

Installation

$ npm install @uppy/status-bar --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.