github-actions[bot] d425517c64 Release: uppy@4.0.0-beta.1 (#5047) 1 year ago
..
src 34dbaf588d Merge branch 'main' 1 year ago
.npmignore c9606092f0 @uppy/progress-bar: refactor to TypeScript (#4921) 1 year ago
CHANGELOG.md d425517c64 Release: uppy@4.0.0-beta.1 (#5047) 1 year ago
LICENSE 48a529aa38 Move `ProgressBar` plugin to `@uppy/progress-bar` 6 years ago
README.md 7adacb74a7 meta: Fix logos in all the readmes (#4407) 2 years ago
package.json d425517c64 Release: uppy@4.0.0-beta.1 (#5047) 1 year ago
tsconfig.build.json c9606092f0 @uppy/progress-bar: refactor to TypeScript (#4921) 1 year ago
tsconfig.json c9606092f0 @uppy/progress-bar: refactor to TypeScript (#4921) 1 year ago

README.md

@uppy/progress-bar

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

ProgressBar is a minimalist plugin that shows the current upload progress in a thin bar element. Like the ones used by YouTube and GitHub when navigating between pages.

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

Example

import Uppy from '@uppy/core'
import ProgressBar from '@uppy/progress-bar'

const uppy = new Uppy()
uppy.use(ProgressBar, {
  // Options
})

Installation

$ npm install @uppy/progress-bar

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.