Skip to content

Commit

Permalink
/docs/dashboard - remove autoOpenFileEditor, add autoOpen (#210)
Browse files Browse the repository at this point in the history
Co-authored-by: Merlijn Vos <merlijn@soverin.net>
  • Loading branch information
lakesare and Murderlon committed Mar 25, 2024
1 parent 96f5c5c commit 6a5a3bc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
17 changes: 11 additions & 6 deletions docs/user-interfaces/dashboard.mdx
Expand Up @@ -572,14 +572,19 @@ It supports the following values:
- `dark`
- `auto` — will respect the user’s system settings and switch automatically

#### `autoOpenFileEditor`
#### `autoOpen`

Automatically open file editor (see [`@uppy/image-editor`](/docs/image-editor))
for the first file in a batch (`boolean`, default: `false`).
Automatically open file editor for the file user just dropped/selected.
If one file is added, editor opens for that file; if 10 files are added, editor
opens only for the first file.

If one file is added, editor opens for that file, if 10 files are added — editor
opens for the first file. Use case: user adds an image — Uppy opens Image Editor
right away — user crops / adjusts the image — upload.
This option supports the following values:

- `null` - the default
- `"metaEditor"` - open the meta fields editor if
[meta fields](/docs/dashboard/#metafields) are enabled.
- `"imageEditor"` - open [`@uppy/image-editor`](/docs/image-editor) if the
plugin is enabled.

#### `disabled`

Expand Down
2 changes: 1 addition & 1 deletion docs/user-interfaces/elements/image-editor.mdx
Expand Up @@ -77,7 +77,7 @@ new Uppy()
:::info

If you automatically want to open the image editor when an image is added, see
the [`autoOpenFileEditor`](/docs/dashboard#autoOpenFileEditor) Dashboard option.
the [`autoOpen`](/docs/dashboard#autoopen) Dashboard option.

:::

Expand Down

0 comments on commit 6a5a3bc

Please sign in to comment.