6e453b3f08
* make widget docs editable * update widget doc frontmatter keys * improve docs preview * fix formatting * fix preview * add prism highlighting for previews * fix formatting * restore cms branch
30 lines
1.1 KiB
Markdown
30 lines
1.1 KiB
Markdown
---
|
|
label: "Image"
|
|
title: image
|
|
---
|
|
|
|
The image widget allows editors to upload an image or select an existing one from the media library. The path to the image file will be saved to the field as a string.
|
|
|
|
- **Name:** `image`
|
|
- **UI:** file picker button opens media gallery allowing image files (jpg, jpeg, webp, gif, png, bmp, tiff, svg) only; displays selected image thumbnail
|
|
- **Data type:** file path string, based on `media_folder`/`public_folder` configuration
|
|
- **Options:**
|
|
- `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
|
|
current widget
|
|
- `config`: a configuration object that will be passed directly to the media library being
|
|
used - available options are determined by the library
|
|
- **Example:**
|
|
```yaml
|
|
- label: "Featured Image"
|
|
name: "thumbnail"
|
|
widget: "image"
|
|
default: "/uploads/chocolate-dogecoin.jpg"
|
|
options:
|
|
media_library:
|
|
config:
|
|
publicKey: "demopublickey"
|
|
multiple: true
|
|
```
|