Mirrors/uppy
1
0
Fork 0
mirror of https://github.com/transloadit/uppy.git synced 2026-07-21 01:15:35 +00:00
Code Issues Projects Releases Wiki Activity
uppy/packages/@uppy/image-editor
History
Murderlon fe96096c3d
Merge branch 'master' into 2.0 
* master: (23 commits)
  A bit of polish (#2986)
  Companion: Fix typescript error
  Companion: Fix invalid referrer crashing the process
  Publish 1.30 blog post
  Release
  Build: Companion needs to be built before locale-pack
  Release
  Fix build: locale-pack first, integrations second
  changelog for 1.30
  Release
  Update package.json
  Only log info if debug is true (#2855)
  build(deps): bump prismjs from 1.23.0 to 1.24.0 (#2971)
  Angular Integration (#2871)
  ci: don't run markdown tests in type tests
  Add types for `uppy.once` method (#2965)
  build: lint fixes in build scripts
  Fix typo in docs/progressbar.md (#2962)
  Document `uppy.once` in `docs/uppy.md` (#2960)
  Add `props` example to docs/vue.md (#2959)
  ...
2021-07-07 15:32:38 +02:00
..
src Remove IE polyfills and special casing (#2947) 2021-06-28 11:34:51 +02: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 Merge branch 'master' into 2.0 2021-07-07 15:32:38 +02:00
README.md doc: lint JS code snippets (#2954) 2021-07-04 19:32:50 +02:00

README.md

@uppy/image-editor

Uppy logo: a superman puppy in a pink suit

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