mirror of https://github.com/transloadit/uppy.git synced 2026-07-22 09:48:06 +00:00

History

Artur Paikin 4b782ffbbb Release		2021-06-30 23:07:21 +01:00
..
src	Golden retriever 2 fixes (#2895 )	2021-05-21 17:47:39 +01:00
types	types: Corrected StatusBar types (#2697 )	2020-12-16 19:26:42 +00:00
LICENSE	@uppy/statusbar --> @uppy/status-bar	2018-06-21 16:03:19 -04:00
package.json	Release	2021-06-30 23:07:21 +01:00
README.md	Add all the CI badges (#2725 )	2021-01-13 00:30:59 +00:00

README.md

@uppy/status-bar

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