github-actions[bot] e07c83bebe Release: uppy@4.8.0 (#5541) 4 months ago
..
src 64bffd5363 export plugin options (#5433) 7 months ago
.npmignore d85caf6c51 meta: exclude `tsconfig` files from npm bundles (#4916) 1 year ago
CHANGELOG.md e07c83bebe Release: uppy@4.8.0 (#5541) 4 months ago
LICENSE 7223af2c9d @uppy/compressor: Add image compressor plugin (#3471) 3 years ago
README.md 9eb857e68c docs: rename Edgly to Smart CDN (#5449) 7 months ago
package.json e07c83bebe Release: uppy@4.8.0 (#5541) 4 months ago
tsconfig.build.json 8f97fd61fa cleanup tsconfig (#5520) 5 months ago
tsconfig.json 6b4f5b68f7 @uppy/compressor: migrate to TS (#4907) 1 year ago

README.md

@uppy/compressor

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

The Compressor plugin for Uppy optimizes images (JPEG, PNG, WEBP), saving on average up to 60% in size (roughly 18 MB for 10 images). It uses Compressor.js.

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

Example

import Uppy from '@uppy/core'
import Compressor from '@uppy/compressor'

const uppy = new Uppy()
uppy.use(Compressor)

Installation

npm install @uppy/compressor

We recommend installing from yarn or npm, and then using a module bundler such as Parcel, Vite or Webpack.

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit’s CDN: Smart CDN. 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.