# Widgets

Source: https://decapcms.org/docs/widgets/ (updated 2026-01-30)


Widgets define the data type and interface for entry fields. Decap CMS comes with several built-in widgets. Click the widget names in the sidebar to jump to specific widget details. We're always adding new widgets, and you can also [create your own](https://decapcms.org/docs/custom-widgets)!

Widgets are specified as collection fields in the Decap CMS `config.yml` file. Note that [YAML syntax](https://en.wikipedia.org/wiki/YAML#Basic_components) allows lists and objects to be written in block or inline style, and the code samples below include a mix of both.

To see working examples of all of the built-in widgets, try making a 'Kitchen Sink' collection item on the [CMS demo site](https://demo.decapcms.org). (No login required: click the login button and the CMS will open.) You can refer to the demo [configuration code](https://github.com/decaporg/decap-cms/blob/master/dev-test/config.yml) to see how each field was configured.

## Common widget options

The following options are available on all fields:

- `required`: specify as `false` to make a field optional; defaults to `true`
- `hint`: optionally add helper text directly below a widget. Useful for including instructions. Accepts markdown for bold, italic, strikethrough, and links.
- `pattern`: add field validation by specifying a list with a [regex pattern](https://regexr.com/) and an error message; more extensive validation can be achieved with [custom widgets](https://decapcms.org/docs/custom-widgets/#advanced-field-validation)
- **Example:**
  ```yaml
    label: "Title"
    name: "title"
    widget: "string"
    pattern: ['.{12,}', "Must have at least 12 characters"]
  ```

## Default widgets


## Widget reference

- [Boolean](https://decapcms.org/docs/widgets/boolean.md)
- [Code](https://decapcms.org/docs/widgets/code.md)
- [Color](https://decapcms.org/docs/widgets/color.md)
- [DateTime](https://decapcms.org/docs/widgets/datetime.md)
- [File](https://decapcms.org/docs/widgets/file.md)
- [Hidden](https://decapcms.org/docs/widgets/hidden.md)
- [Image](https://decapcms.org/docs/widgets/image.md)
- [List](https://decapcms.org/docs/widgets/list.md)
- [Map](https://decapcms.org/docs/widgets/map.md)
- [Richtext (Beta)](https://decapcms.org/docs/widgets/richtext.md)
- [Markdown (deprecated)](https://decapcms.org/docs/widgets/markdown.md)
- [Number](https://decapcms.org/docs/widgets/number.md)
- [Object](https://decapcms.org/docs/widgets/object.md)
- [Relation](https://decapcms.org/docs/widgets/relation.md)
- [Select](https://decapcms.org/docs/widgets/select.md)
- [String](https://decapcms.org/docs/widgets/string.md)
- [Text](https://decapcms.org/docs/widgets/text.md)
- [UUID](https://decapcms.org/docs/widgets/uuid.md)