uppy/packages/@uppy/thumbnail-generator/README.md
2019-03-04 13:43:37 +01:00

1.6 KiB

@uppy/thumbnail-generator

Uppy logo: a superman puppy in a pink suit

Build Status

Uppy plugin that generates small previews of images to show on your upload UI.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

const Uppy = require('@uppy/core')
const ThumbnailGenerator = require('@uppy/thumbnail-generator')

const uppy = Uppy()
uppy.use(ThumbnailGenerator, {
  thumbnailWidth: 200
})

Installation

$ npm install @uppy/thumbnail-generator --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.

License

The MIT License.