Mirrors/uppy
1
0
Fork 0
mirror of https://github.com/transloadit/uppy.git synced 2026-01-24 02:46:39 +00:00
Code Issues Projects Releases Wiki Activity
uppy/packages/@uppy/compressor
History
Merlijn Vos 6e65cd8c51
Import types consistently from @uppy/core (#5589) 
* Import types consistently from @uppy/core

* Add new eslint rule

* Clean up exports
2025-01-09 11:03:43 +01:00
..
src Import types consistently from @uppy/core (#5589) 2025-01-09 11:03:43 +01:00
.npmignore meta: exclude tsconfig files from npm bundles (#4916) 2024-02-13 23:21:08 +01:00
CHANGELOG.md Release: uppy@4.11.0 (#5574) 2025-01-06 14:11:04 +00:00
LICENSE @uppy/compressor: Add image compressor plugin (#3471) 2022-02-16 11:40:08 +00:00
package.json Release: uppy@4.11.0 (#5574) 2025-01-06 14:11:04 +00:00
README.md docs: rename Edgly to Smart CDN (#5449) 2024-09-19 10:42:57 +02:00
tsconfig.build.json Remove "paths" from all tsconfig's (#5572) 2025-01-06 12:14:42 +01:00
tsconfig.json Remove "paths" from all tsconfig's (#5572) 2025-01-06 12:14:42 +01:00

README.md

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