Antoine du Hamel 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
..
src ecec3d3213 Split `Plugin` into `BasePlugin` and extended `UIPlugin` (#2944) 3 years ago
types 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
LICENSE 48a529aa38 Move `ProgressBar` plugin to `@uppy/progress-bar` 6 years ago
README.md 56c86e2f18 doc: use ESM syntax in code snippets (#2953) 3 years ago
package.json fe96096c3d Merge branch 'master' into 2.0 3 years ago

README.md

@uppy/progress-bar

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.