uppy/packages/@uppy/compressor
github-actions[bot] 77d44c79f3
Release: uppy@4.3.0 (#5438)
| Package                | Version | Package                | Version |
| ---------------------- | ------- | ---------------------- | ------- |
| @uppy/aws-s3           |   4.1.0 | @uppy/informer         |   4.1.0 |
| @uppy/box              |   3.1.0 | @uppy/instagram        |   4.1.0 |
| @uppy/companion        |   5.1.0 | @uppy/locales          |   4.1.0 |
| @uppy/companion-client |   4.1.0 | @uppy/onedrive         |   4.1.0 |
| @uppy/compressor       |   2.1.0 | @uppy/remote-sources   |   2.2.0 |
| @uppy/core             |   4.2.0 | @uppy/screen-capture   |   4.1.0 |
| @uppy/dashboard        |   4.1.0 | @uppy/tus              |   4.1.0 |
| @uppy/dropbox          |   4.1.0 | @uppy/unsplash         |   4.1.0 |
| @uppy/facebook         |   4.1.0 | @uppy/url              |   4.1.0 |
| @uppy/google-drive     |   4.1.0 | @uppy/xhr-upload       |   4.1.0 |
| @uppy/google-photos    |   0.3.0 | @uppy/zoom             |   3.1.0 |
| @uppy/image-editor     |   3.1.0 | uppy                   |   4.3.0 |

- @uppy/core,@uppy/dashboard: Pass container to `UIPlugin.render` for non-Preact integration (Merlijn Vos / #5437)
- @uppy/companion: do not use unsafe call to `JSON.stringify` (Antoine du Hamel / #5422)
- meta: Fix yarn.lock (Murderlon)
- @uppy/locales: Fix locale-pack for en_US (Merlijn Vos / #5431)
- meta: Add tsconfig to packages in private/ (Merlijn Vos / #5432)
- @uppy/remote-sources: support companionKeysParams (Merlijn Vos / #5434)
- @uppy/aws-s3,@uppy/box,@uppy/compressor,@uppy/dropbox,@uppy/facebook,@uppy/google-drive,@uppy/google-photos,@uppy/image-editor,@uppy/informer,@uppy/instagram,@uppy/onedrive,@uppy/screen-capture,@uppy/tus,@uppy/unsplash,@uppy/url,@uppy/xhr-upload,@uppy/zoom: export plugin options (Antoine du Hamel / #5433)
- docs: correctly list exported components (Merlijn Vos / #5417)
2024-08-29 14:33:09 +00:00
..
src export plugin options (#5433) 2024-08-28 15:49:03 +02:00
.npmignore meta: exclude tsconfig files from npm bundles (#4916) 2024-02-13 23:21:08 +01:00
CHANGELOG.md Release: uppy@4.3.0 (#5438) 2024-08-29 14:33:09 +00:00
LICENSE @uppy/compressor: Add image compressor plugin (#3471) 2022-02-16 11:40:08 +00:00
package.json Release: uppy@4.3.0 (#5438) 2024-08-29 14:33:09 +00:00
README.md Format 2024-05-02 15:22:30 +02:00
tsconfig.build.json @uppy/compressor: migrate to TS (#4907) 2024-02-12 23:10:49 +08:00
tsconfig.json @uppy/compressor: migrate to TS (#4907) 2024-02-12 23:10:49 +08: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.