uppy/packages/@uppy/progress-bar/README.md
Antoine du Hamel 6f9813d9b2
doc: update bundler recommendation (#3763)
With the switch to ESM, Browserify will no longer work with Uppy.
Instead, let's recommend bundlers that we actually test with.
2022-05-23 19:41:37 +02:00

1.5 KiB
Raw Blame History

@uppy/progress-bar

Uppy logo: a superman puppy in a pink suit

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