Antoine du Hamel 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
..
src a194865fe5 Create `getObjectOfFilesPerState` in core for plugins (#2961) 3 years ago
types 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
LICENSE 79f7fbeff5 @uppy/statusbar --> @uppy/status-bar 6 years ago
README.md c48064ba56 doc: lint JS code snippets (#2954) 3 years ago
package.json fe96096c3d Merge branch 'master' into 2.0 3 years ago

README.md

@uppy/status-bar

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 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

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.