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

Update image.md (#1923)

Browse Source 
* Update image.md

Update the docs to match the configuration example

* Remove deprecated options field
This commit is contained in:
Hatem Houssein 2018-11-30 17:27:06 +09:00 committed by Tom Rutgers
parent e5ad6087af
commit 53c00940fe
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -10,20 +10,18 @@ The image widget allows editors to upload an image or select an existing one fro
- **Data type:** file path string, based on `media_folder`/`public_folder` configuration - **Data type:** file path string, based on `media_folder`/`public_folder` configuration
- **Options:** - **Options:**
- `default`: accepts a file path string; defaults to null - `default`: accepts a file path string; defaults to null
- `options`: an object for settings that are unique to the image widget - `media_library`: media library settings to apply when a media library is opened by the
- `media_library`: media library settings to apply when a media library is opened by the current widget
current widget - `config`: a configuration object that will be passed directly to the media library being
- `config`: a configuration object that will be passed directly to the media library being used - available options are determined by the library
used - available options are determined by the library
- **Example:** - **Example:**
```yaml ```yaml
- label: "Featured Image" - label: "Featured Image"
name: "thumbnail" name: "thumbnail"
widget: "image" widget: "image"
default: "/uploads/chocolate-dogecoin.jpg" default: "/uploads/chocolate-dogecoin.jpg"
options: media_library:
media_library: config:
config: publicKey: "demopublickey"
publicKey: "demopublickey" multiple: true
multiple: true
``` ```