Antoine du Hamel 05d8234d26 fixup! @uppy/informer: remove dependency to `preact-transition-group` (#3055) 3 years ago
..
src 05d8234d26 fixup! @uppy/informer: remove dependency to `preact-transition-group` (#3055) 3 years ago
types 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
LICENSE 4c4e5b37f5 Move `Informer` to `@uppy/informer`. 6 years ago
README.md c48064ba56 doc: lint JS code snippets (#2954) 3 years ago
package.json 98fd749b62 @uppy/informer: remove dependency to `preact-transition-group` (#3055) 3 years ago

README.md

@uppy/informer

CI status for Uppy tests CI status for Companion tests CI status for browser tests

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, a versatile file encoding service.

Example

import Uppy from '@uppy/core'
import Informer from '@uppy/informer'

const uppy = new Uppy()
uppy.use(Informer, {
  target: '#mount-point',
})

Installation

$ npm install @uppy/informer

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.