github-actions[bot] 2af711cf28 Release: uppy@2.3.0 (#3348) %!s(int64=3) %!d(string=hai) anos
..
src cd8af60bfb examples: update `angular-example` to Angular v13 (#3325) %!s(int64=3) %!d(string=hai) anos
types 472766e48b UIPlugin fix: prevent Preact replacing contents of body element by using createDocumentFragment (#3072) %!s(int64=3) %!d(string=hai) anos
CHANGELOG.md 2af711cf28 Release: uppy@2.3.0 (#3348) %!s(int64=3) %!d(string=hai) anos
LICENSE 79f7fbeff5 @uppy/statusbar --> @uppy/status-bar %!s(int64=6) %!d(string=hai) anos
README.md 55e0ffd04a Add retext to markdown linter (#3024) %!s(int64=3) %!d(string=hai) anos
package.json 2af711cf28 Release: uppy@2.3.0 (#3348) %!s(int64=3) %!d(string=hai) anos

README.md

@uppy/status-bar

npm version CI status for Uppy tests CI status for Companion tests CI status for browser tests

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 basic file source plugin, such as @uppy/file-input or @uppy/drag-drop, or a custom implementation. It’s also included in the @uppy/dashboard plugin.

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

Example

import Uppy from '@uppy/core'
import StatusBar from '@uppy/status-bar'

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

Installation

$ npm install @uppy/status-bar

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.