github-actions[bot] 8654e9822f Release: uppy@4.9.0 (#5553) 4 months ago
..
src 24fd4158a9 Companion stream upload unknown size files (#5489) 4 months ago
.npmignore d85caf6c51 meta: exclude `tsconfig` files from npm bundles (#4916) 1 year ago
CHANGELOG.md 8654e9822f Release: uppy@4.9.0 (#5553) 4 months ago
LICENSE 79f7fbeff5 @uppy/statusbar --> @uppy/status-bar 6 years ago
README.md 71a6fcd956 Fix links (#5492) 5 months ago
package.json 8654e9822f Release: uppy@4.9.0 (#5553) 4 months ago
tsconfig.build.json 8f97fd61fa cleanup tsconfig (#5520) 5 months ago
tsconfig.json 588bfb515e meta: prettier 3.0.3 -> 3.2.4 (#4889) 1 year ago

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

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit’s CDN: Smart CDN. 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.