uppy/packages/@uppy/progress-bar/README.md
Antoine du Hamel 56c86e2f18
doc: use ESM syntax in code snippets (#2953)
In preparation for a future release of Uppy which drop support for
CommonJS, we should start nudging our users to use ESM syntax.

Fixes: https://github.com/transloadit/uppy/issues/2951
2021-06-22 10:30:24 +02:00

1.7 KiB

@uppy/progress-bar

Uppy logo: a superman puppy in a pink suit

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. Similar to 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

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.