uppy/packages/@uppy/progress-bar
Artur Paikin 4684a3e1f3
Merge pull request #924 from transloadit/export-plugin
Export Plugin class from @uppy/core.
2018-06-28 09:43:43 -04:00
..
src Export Plugin class from @uppy/core. 2018-06-28 12:20:21 +02:00
types Remove unnecessary declare module wrappers from .d.ts files. 2018-06-18 16:22:15 +02:00
LICENSE Move ProgressBar plugin to @uppy/progress-bar 2018-06-14 20:06:19 -04:00
package.json Fix version numbers 2018-06-28 15:41:15 +02:00
README.md Move ProgressBar plugin to @uppy/progress-bar 2018-06-14 20:06:19 -04:00

@uppy/progress-bar

Uppy logo: a superman puppy in a pink suit

Build Status

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

const Uppy = require('@uppy/core')
const ProgressBar = require('@uppy/progress-bar')

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

Installation

$ npm install @uppy/progress-bar --save

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.