Mirrors/uppy
1
0
Fork 0
mirror of https://github.com/transloadit/uppy.git synced 2026-07-18 17:16:00 +00:00
Code Issues Projects Releases Wiki Activity
uppy/packages/@uppy/image-editor
History
Antoine du Hamel 9fe02400ae meta: use workspace:^ instead of workspace:* (#3278)
2021-10-27 17:53:11 +02:00
..
src @uppy/image-editor: add workaround for when Cropper is loaded as ESM (#3218) 2021-09-28 16:59:13 +02:00
types meta: enforce no-unused-vars linter rule (#3118) 2021-08-23 13:10:17 +01:00
LICENSE Move cropping to a standalone image-editor plugin 2020-06-20 16:10:16 +01:00
package.json meta: use workspace:^ instead of workspace:* (#3278) 2021-10-27 17:53:11 +02:00
README.md Add retext to markdown linter (#3024) 2021-10-14 16:10:45 +02:00

README.md

@uppy/image-editor

Uppy logo: a superman puppy in a pink suit

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, {
  target: Dashboard,
  quality: 0.7,
})

Installation

$ npm install @uppy/image-editor

We recommend installing from npm and then using a module bundler such as Webpack, Browserify or Rollup.js.

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.