mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-29 13:00:18 +00:00
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
# @uppy/informer
|
|
|
|
<img src="https://uppy.io/images/logos/uppy-dog-head-arrow.svg" width="120" alt="Uppy logo: a superman puppy in a pink suit" align="right">
|
|
|
|
<a href="https://www.npmjs.com/package/@uppy/informer"><img src="https://img.shields.io/npm/v/@uppy/informer.svg?style=flat-square"></a>
|
|
<a href="https://travis-ci.org/transloadit/uppy"><img src="https://img.shields.io/travis/transloadit/uppy/master.svg?style=flat-square" alt="Build Status"></a>
|
|
|
|
The Informer is a pop-up bar for showing notifications. When other plugins have some exciting news (or error) to share, they can show a notification here.
|
|
|
|
Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.
|
|
|
|
## Example
|
|
|
|
```js
|
|
const Uppy = require('@uppy/core')
|
|
const Informer = require('@uppy/informer')
|
|
|
|
const uppy = Uppy()
|
|
uppy.use(Informer, {
|
|
target: '#mount-point'
|
|
})
|
|
```
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
$ npm install @uppy/informer --save
|
|
```
|
|
|
|
We recommend installing from npm and then using a module bundler such as [Webpack](https://webpack.js.org/), [Browserify](http://browserify.org/) or [Rollup.js](http://rollupjs.org/).
|
|
|
|
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/informer).
|
|
|
|
## License
|
|
|
|
[The MIT License](./LICENSE).
|