github-actions[bot] e07c83bebe Release: uppy@4.8.0 (#5541) 4 달 전
..
src 64bffd5363 export plugin options (#5433) 7 달 전
.npmignore d85caf6c51 meta: exclude `tsconfig` files from npm bundles (#4916) 1 년 전
CHANGELOG.md e07c83bebe Release: uppy@4.8.0 (#5541) 4 달 전
LICENSE 25f4f405fe Move cropping to a standalone image-editor plugin 4 년 전
README.md 71a6fcd956 Fix links (#5492) 5 달 전
package.json e07c83bebe Release: uppy@4.8.0 (#5541) 4 달 전
tsconfig.build.json 8f97fd61fa cleanup tsconfig (#5520) 5 달 전
tsconfig.json 588bfb515e meta: prettier 3.0.3 -> 3.2.4 (#4889) 1 년 전

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