mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-23 02:08:30 +00:00
b0e01ff082
* Fix Compressor docs * Remove unused test commands * Add note that all options are passed * Add event to types * Update website/src/docs/compressor.md Co-authored-by: Merlijn Vos <merlijn@soverin.net> * Update packages/@uppy/compressor/types/index.d.ts Co-authored-by: Merlijn Vos <merlijn@soverin.net> * add files array as callback to compressor:complete Co-authored-by: Merlijn Vos <merlijn@soverin.net> |
||
|---|---|---|
| .. | ||
| src | ||
| types | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
@uppy/compressor
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: 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.