mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-25 19:23:55 +00:00
7d6937300a
* meta: enable prettier for markdown * Ignore changelogs * revert CHANGELOG changes * More formatting --------- Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
47 lines
1.5 KiB
Markdown
47 lines
1.5 KiB
Markdown
# @uppy/progress-bar
|
||
|
||
<img src="https://uppy.io/img/logo.svg" width="120" alt="Uppy logo: a smiling puppy above a pink upwards arrow" align="right">
|
||
|
||
[](https://www.npmjs.com/package/@uppy/progress-bar)
|
||
|
||
|
||
|
||
|
||
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](https://transloadit.com),
|
||
a versatile file encoding service.
|
||
|
||
## Example
|
||
|
||
```js
|
||
import Uppy from '@uppy/core'
|
||
import ProgressBar from '@uppy/progress-bar'
|
||
|
||
const uppy = new Uppy()
|
||
uppy.use(ProgressBar, {
|
||
// Options
|
||
})
|
||
```
|
||
|
||
## Installation
|
||
|
||
```bash
|
||
$ 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](https://uppy.io/docs/#Installation) for instructions.
|
||
|
||
## Documentation
|
||
|
||
Documentation for this plugin can be found on the
|
||
[Uppy website](https://uppy.io/docs/progressbar).
|
||
|
||
## License
|
||
|
||
[The MIT License](./LICENSE).
|