gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(docs): Update Docs: Widgets “image” (#5351)

Browse Source
This commit is contained in:
Valentin Nourdin 2021-05-09 11:33:42 +02:00 committed by GitHub
parent 157851e9c4
commit eb37eb7010
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
website/content/docs/widgets/image.md
View File

@ -10,12 +10,11 @@ The image widget allows editors to upload an image or select an existing one fro
* **Options:** * **Options:**
* `default`: accepts a file path string; defaults to null * `default`: accepts a file path string; defaults to null
* `media_library`: settings to apply when opening a media library is opened by the * `media_library`: settings to apply when a media library is opened by the
current widget current widget
* `allow_multiple`: *(default: `true`)* when set to `false`, multiple selection will be disabled even if the media library extension supports it
* `allow_multiple`: *(default: `true`)* when set to `false`, if the media library extension supports it, multiple selection will be disabled * `config`: a configuration object passed directly to the media library; check the documentation of your media library extension for available `config` options
* `config`: a configuration object passed directly to the media library; check the documentation of your media library extension for available `config` options. * `media_folder` (Beta): file path where uploaded images will be saved specific to this control. Paths can be relative to a collection folder (e.g. `images` will add the image to a sub-folder in the collection folder) or absolute with reference to the base of the repo which needs to begin with `/` (e.g `/static/images` will save uploaded images to the `static` folder in a sub folder named `images`)
* `media_folder` (Beta): file path where uploaded images will be saved specific to this control. Paths can be relative to a collection folder (e.g. `images` will add the image to a sub-folder in the collection folder) or absolute with reference to the base of the repo which needs to begin with `/` (e.g `/static/images` will save uploaded images to the static folder in a sub folder named `images`)
* **Example:** * **Example:**
```yaml ```yaml
@ -26,4 +25,4 @@ The image widget allows editors to upload an image or select an existing one fro
media_library: media_library:
config: config:
multiple: true multiple: true
``` ```