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
2018-12-04 17:04:52 -05:00
- **Data type:** file path string
2018-01-03 20:14:15 -02:00
- **Options:**
- `default` : accepts a file path string; defaults to null
2018-11-30 17:27:06 +09:00
- `media_library` : media library settings to apply when a media library is opened by the
current widget
2018-12-04 17:04:52 -05:00
- `allow_multiple` : _(default: `true`)_ when set to `false` , prevents multiple selection for any media library extension, but must be supported by the extension in use
2018-11-30 17:27:06 +09:00
- `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-11-30 17:27:06 +09:00
media_library:
config:
multiple: true
2018-08-14 07:37:07 -07:00
```