static-cms/website/content/docs/widgets/image.md

---
title: image
label: 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
* **Options:**

  * `default`: accepts a file path string; defaults to null
  * `media_library`: settings to apply when opening a media library is opened by the
    current widget

    * `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.
* **Example:**

  ```yaml
  - label: "Featured Image"
    name: "thumbnail"
    widget: "image"
    default: "/uploads/chocolate-dogecoin.jpg"
    media_library:
      config:
        multiple: true
  ```
New design for the widgets section in the docs (#866) * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Rebased and updated the info according to @verythorough contribution * Fixing the yaml codes for the relation and select widget sections * Merging with widgets.md and app.j * Fixing some silly mistakes (sorry!) * Following @verythorough contributions :) * Adding the markdown widget and fixing the widgets container background * Adding the URL functionality and myself as a contributor :) * Adding myself as a contributor :) 2018-01-03 20:14:15 -02:00			`---`
docs: make widget docs editable (#1782) * 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 2018-10-01 20:00:57 -04:00			`title: image`
feat(test): add docs linter to PR workflow actions (#4321) 2020-10-11 07:02:47 -07:00			`label: Image`
New design for the widgets section in the docs (#866) * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Initial commit for the new widgets section * Placing all the widgets and refining the CSS and Hugo logic * Rebased and updated the info according to @verythorough contribution * Fixing the yaml codes for the relation and select widget sections * Merging with widgets.md and app.j * Fixing some silly mistakes (sorry!) * Following @verythorough contributions :) * Adding the markdown widget and fixing the widgets container background * Adding the URL functionality and myself as a contributor :) * Adding myself as a contributor :) 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.`

feat(test): add docs linter to PR workflow actions (#4321) 2020-10-11 07:02:47 -07:00			* 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`
			`* Options:`

			* `default`: accepts a file path string; defaults to null
			* `media_library`: settings to apply when opening a media library is opened by the
Update image.md (#1923) * Update image.md Update the docs to match the configuration example * Remove deprecated options field 2018-11-30 17:27:06 +09:00			`current widget`
feat(test): add docs linter to PR workflow actions (#4321) 2020-10-11 07:02:47 -07:00
			* `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.
			`* Example:`

			```yaml
			`- label: "Featured Image"`
			`name: "thumbnail"`
			`widget: "image"`
			`default: "/uploads/chocolate-dogecoin.jpg"`
			`media_library:`
			`config:`
			`multiple: true`
			```