uppy/packages/@uppy/compressor
2024-01-03 09:43:13 +01:00
..
src test: migrate to Vitest for Uppy core and Uppy plugins (#4700) 2023-09-26 17:23:17 +02:00
types meta: run Prettier on existing files (#4713) 2023-09-29 11:11:28 +02:00
CHANGELOG.md Release: uppy@3.16.0 (#4685) 2023-09-18 20:12:54 +00:00
LICENSE @uppy/compressor: Add image compressor plugin (#3471) 2022-02-16 11:40:08 +00:00
package.json upgrade @transloadit/prettier-bytes (#4850) 2024-01-03 09:43:13 +01:00
README.md meta: Fix logos in all the readmes (#4407) 2023-04-07 23:46:04 +01:00

@uppy/compressor

Uppy logo: a smiling puppy above a pink upwards arrow

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 Transloadits 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.