uppy/packages/@uppy/compressor
github-actions[bot] 54d3b4ed38
Release: uppy@4.1.0 (#5376)
| Package              | Version | Package              | Version |
| -------------------- | ------- | -------------------- | ------- |
| @uppy/audio          |   2.0.1 | @uppy/status-bar     |   4.0.1 |
| @uppy/aws-s3         |   4.0.2 | @uppy/store-default  |   4.1.0 |
| @uppy/compressor     |   2.0.1 | @uppy/transloadit    |   4.0.1 |
| @uppy/core           |   4.1.0 | @uppy/utils          |   6.0.1 |
| @uppy/dashboard      |   4.0.2 | @uppy/webcam         |   4.0.1 |
| @uppy/remote-sources |   2.1.0 | uppy                 |   4.1.0 |

- @uppy/remote-sources: fix options type (Merlijn Vos / #5364)
- @uppy/transloadit: do not mark `opts` as mandatory (Antoine du Hamel / #5375)
- @uppy/compressor: mark `quality` as optional (Antoine du Hamel / #5374)
- @uppy/aws-s3: improve error when `endpoint` is not provided (Antoine du Hamel / #5361)
- @uppy/core,@uppy/store-default: export `Store` type (Merlijn Vos / #5373)
- @uppy/dashboard: make `toggleAddFilesPanel` args consistent (Evgenia Karunus / #5365)
- @uppy/dashboard: Dashboard - convert some files to typescript (Evgenia Karunus / #5359)
- @uppy/audio,@uppy/webcam: Don't use `<h1>` in Uppy markup (Evgenia Karunus / #5355)
- @uppy/status-bar: GoldenRetriever + `hideUploadButton=true` (Evgenia Karunus / #5350)
- meta: Bump docker/build-push-action from 6.3.0 to 6.4.1 (dependabot[bot] / #5360)
2024-07-30 08:08:33 +00:00
..
src @uppy/compressor: mark quality as optional (#5374) 2024-07-29 14:14:54 +02:00
.npmignore meta: exclude tsconfig files from npm bundles (#4916) 2024-02-13 23:21:08 +01:00
CHANGELOG.md Release: uppy@4.1.0 (#5376) 2024-07-30 08:08:33 +00:00
LICENSE @uppy/compressor: Add image compressor plugin (#3471) 2022-02-16 11:40:08 +00:00
package.json Release: uppy@4.1.0 (#5376) 2024-07-30 08:08:33 +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.