github-actions[bot] c6c279fa75 Release: uppy@4.0.0 (#5325) 9 months ago
..
src d536a3525f @uppy/google-photos: fix various issues (#5275) 10 months ago
.npmignore d85caf6c51 meta: exclude `tsconfig` files from npm bundles (#4916) 1 year ago
CHANGELOG.md 53cb32f5d9 Release: uppy@4.0.0-beta.7 (#5162) 11 months ago
LICENSE 25f4f405fe Move cropping to a standalone image-editor plugin 4 years ago
README.md 53cb32f5d9 Release: uppy@4.0.0-beta.7 (#5162) 11 months ago
package.json c6c279fa75 Release: uppy@4.0.0 (#5325) 9 months ago
tsconfig.build.json d18bb0c468 @uppy/image-editor: migrate to TS (#4880) 1 year ago
tsconfig.json 588bfb515e meta: prettier 3.0.3 -> 3.2.4 (#4889) 1 year ago

README.md

@uppy/image-editor

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