# @uppy/image-editor

> Image editor and cropping UI

Latest version **5.0.0** (published 2026-08-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @uppy/image-editor
pnpm add @uppy/image-editor
yarn add @uppy/image-editor
bun add @uppy/image-editor
```

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score; popular repo.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2026-08-26 |
| First published | 2020-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 2 |
| Unpacked size | 121.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30988 |
| Maintainers | kvz, tim-kos, mifi, uppydev |
| Keywords | file uploader, upload, uppy, uppy-plugin, image editor, cropper, crop, rotate, resize |

## Links

- npm: https://www.npmjs.com/package/@uppy/image-editor
- Repository: https://github.com/transloadit/uppy
- Homepage: https://uppy.io
- Issues: https://github.com/transloadit/uppy/issues
- npm.io page: https://npm.io/package/@uppy/image-editor

## Dependencies (2)

- [preact](https://npm.io/package/preact.md) ^10.29.2
- [cropperjs](https://npm.io/package/cropperjs.md) ^1.6.2

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 5.0.0 (latest) — 2026-08-26
- 3.0.0-beta.6 (next) — 2024-06-27
- 4.2.0 — 2026-02-03
- 4.1.0 — 2025-12-02
- 4.0.2 — 2025-10-17
- 4.0.1 — 2025-09-16
- 4.0.0 — 2025-08-22
- 3.4.2 — 2025-08-01
- 3.4.1 — 2025-07-29
- 3.4.0 — 2025-07-29
- 3.3.3 — 2025-05-18
- 3.3.2 — 2025-04-08
- 3.3.1 — 2025-01-09
- 3.3.0 — 2025-01-06
- 3.2.1 — 2024-12-05
- … 60 more at https://npm.io/package/@uppy/image-editor/versions

## README

# @uppy/image-editor

<img src="https://uppy.io/img/logo.svg" width="120" alt="Uppy logo: a smiling puppy above a pink upwards arrow" align="right">

[![npm version](https://img.shields.io/npm/v/@uppy/image-editor.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/image-editor)
![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg)
![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg)
![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg)

Image Editor is an image cropping and editing plugin for Uppy. Designed to be
used with the Dashboard UI (can in theory work without it).

⚠ In beta.

**[Read the docs](https://uppy.io/docs/image-editor)** |
**[Try it](https://uppy.io/examples/dashboard/)**

Uppy is being developed by the folks at [Transloadit](https://transloadit.com),
a versatile file encoding service.

## Example

```js
import Uppy from '@uppy/core'
import Dashboard from '@uppy/dashboard'
import ImageEditor from '@uppy/image-editor'

const uppy = new Uppy()
uppy.use(Dashboard)
uppy.use(ImageEditor, { quality: 0.7 })
```

## Installation

```bash
$ npm install @uppy/image-editor
```

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](https://uppy.io/docs/#Installation) for instructions.

## Documentation

Documentation for this plugin can be found on the
[Uppy website](https://uppy.io/docs/image-editor).

## License

[The MIT License](./LICENSE).

---
_Source: https://npm.io/package/@uppy/image-editor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
