Skip to content

Commit

Permalink
docs: note that image editor is beta
Browse files Browse the repository at this point in the history
  • Loading branch information
goto-bus-stop committed Sep 2, 2020
1 parent 3942046 commit d4a77ab
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions website/src/docs/image-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const ImageEditor = require('@uppy/image-editor')

const uppy = new Uppy()
uppy.use(Dashboard)
uppy.use(ImageEditor, {
uppy.use(ImageEditor, {
target: Dashboard,
quality: 0.8
})
Expand All @@ -39,11 +39,7 @@ Install from NPM:
npm install @uppy/image-editor
```

In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:

```js
const ImageEditor = Uppy.ImageEditor
```
The `@uppy/image-editor` plugin is in beta and is not yet available in the [CDN package](/docs/#With-a-script-tag).

## Options

Expand All @@ -53,7 +49,7 @@ The `@uppy/image-editor` plugin has the following configurable options:
uppy.use(ImageEditor, {
id: 'ImageEditor',
quality: 0.8,
cropperOptions: {
cropperOptions: {
viewMode: 1,
background: false,
autoCropArea: 1,
Expand Down

0 comments on commit d4a77ab

Please sign in to comment.