mirror of https://github.com/transloadit/uppy.git synced 2026-07-20 16:53:33 +00:00

History

Artur Paikin f20330aee9 Dashboard: rename Done to Cancel, add Save to Image Editor (#3033 ) * Rename Done button to Cancel everywhere * Add Save button to the top bar of the FileEditor * Remove Save button from Image Editor toolbar * fix locale		2021-07-21 14:07:42 +01:00
..
src	Dashboard: rename Done to Cancel, add Save to Image Editor (#3033 )	2021-07-21 14:07:42 +01:00
types	add more granular image rotation control (#2838 )	2021-06-13 14:31:19 +01:00
LICENSE	Move cropping to a standalone image-editor plugin	2020-06-20 16:10:16 +01:00
package.json	Release	2021-06-30 23:07:21 +01:00
README.md	Add all the CI badges (#2725 )	2021-01-13 00:30:59 +00:00

README.md

@uppy/image-editor

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

const Uppy = require('@uppy/core')
const Dashboard = require('@uppy/dashboard')
const ImageEditor = require('@uppy/image-editor')

const uppy = 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.