uppy/packages/@uppy/status-bar
Kevin van Zonneveld 803611ed04
Move @uppy/utils/lib/prettyBytes -> @transloadit/prettier-bytes (#2231)
* Move @uppy/utils/lib/prettyBytes -> @transloadit/prettier-bytes so we can more easily re-use it across projects

* Switch to MIT licensed @transloadit/prettier-bytes

* lockfile fun

* build: add dep for website/inject.js

Co-authored-by: Renée Kooi <renee@kooi.me>
2020-05-07 16:54:13 +02:00
..
src Move @uppy/utils/lib/prettyBytes -> @transloadit/prettier-bytes (#2231) 2020-05-07 16:54:13 +02:00
types Actually check types (#1918) 2020-02-12 16:22:09 +01:00
LICENSE @uppy/statusbar --> @uppy/status-bar 2018-06-21 16:03:19 -04:00
package.json Move @uppy/utils/lib/prettyBytes -> @transloadit/prettier-bytes (#2231) 2020-05-07 16:54:13 +02:00
README.md docs: update webpack homepage URLs 2019-03-04 13:43:37 +01:00

@uppy/status-bar

Uppy logo: a superman puppy in a pink suit

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.