Mirrors/uppy
1
0
Fork 0
mirror of https://github.com/transloadit/uppy.git synced 2026-07-17 16:50:22 +00:00
Code Issues Projects Releases Wiki Activity
uppy/packages/@uppy/image-editor
History
prakash 156b87ec17
refactor(core): merge @uppy/utils into core via ./utils export
2026-06-22 01:40:25 +05:30
..
src refactor(core): merge @uppy/utils into core via ./utils export 2026-06-22 01:40:25 +05:30
.npmignore meta: exclude tsconfig files from npm bundles (#4916) 2024-02-13 23:21:08 +01:00
CHANGELOG.md [ci] release (#6166) 2026-02-03 11:08:41 +01:00
LICENSE Move cropping to a standalone image-editor plugin 2020-06-20 16:10:16 +01:00
package.json refactor(core): merge @uppy/utils into core via ./utils export 2026-06-22 01:40:25 +05:30
README.md Fix links (#5492) 2024-10-29 13:54:00 +01:00
tsconfig.build.json refactor(core): merge @uppy/utils into core via ./utils export 2026-06-22 01:40:25 +05:30
tsconfig.json refactor(core): merge @uppy/utils into core via ./utils export 2026-06-22 01:40:25 +05:30
turbo.json Fix turbo race condition (#5839) 2025-07-23 10:49:11 +02:00

README.md

@uppy/image-editor

Uppy logo: a smiling puppy above a pink upwards arrow

npm version CI status for Uppy tests CI status for Companion tests CI status for browser tests

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 | Try it

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

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

$ 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 for instructions.

Documentation

Documentation for this plugin can be found on the Uppy website.

License

The MIT License.