2018-01-03 20:14:15 -02:00
---
2018-08-14 11:33:13 -06:00
label: "Image"
2018-10-01 20:00:57 -04:00
title: image
2018-01-03 20:14:15 -02:00
---
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
2018-08-30 16:24:28 -04:00
- `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
2018-01-03 20:14:15 -02:00
- **Example:**
2018-08-14 07:37:07 -07:00
```yaml
2018-08-14 11:33:13 -06:00
- label: "Featured Image"
name: "thumbnail"
widget: "image"
default: "/uploads/chocolate-dogecoin.jpg"
2018-08-30 16:24:28 -04:00
options:
media_library:
config:
publicKey: "demopublickey"
multiple: true
2018-08-14 07:37:07 -07:00
```