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

---
title: boolean
label: "Boolean"
---

The boolean widget translates a toggle switch input to a true/false value.

- **Name:** `boolean`
- **UI:** toggle switch
- **Data type:** boolean
- **Options:**
  - `default`: accepts `true` or `false`; defaults to `false`
- **Example:**
    ```yaml
    - {label: "Draft", name: "draft", widget: "boolean", default: 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: boolean`
docs(fix): revert prettier formatting on markdown files (#1612) Prettier formatting our markdown files is causing bugs because of the differences between Gatsby's parser and Prettier's. Also, Prettier formats the inline code-blocks containing example CMS configs, but the formatting it uses doesn't really make much sense or match the suggested CMS config style. It doesn't actually make much sense to format the docs anyway, since we use the CMS itself to edit/generate them. 2018-08-14 11:33:13 -06:00			`label: "Boolean"`
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 boolean widget translates a toggle switch input to a true/false value.`

			- Name: `boolean`
			`- UI: toggle switch`
			`- Data type: boolean`
			`- Options:`
			- `default`: accepts `true` or `false`; defaults to `false`
			`- Example:`
docs(fix): widget example code layout on Site (#1606) * Fix widget example layout * Stop running MarkDown through Prettier. 2018-08-14 07:37:07 -07:00			```yaml
docs(fix): revert prettier formatting on markdown files (#1612) Prettier formatting our markdown files is causing bugs because of the differences between Gatsby's parser and Prettier's. Also, Prettier formats the inline code-blocks containing example CMS configs, but the formatting it uses doesn't really make much sense or match the suggested CMS config style. It doesn't actually make much sense to format the docs anyway, since we use the CMS itself to edit/generate them. 2018-08-14 11:33:13 -06:00			`- {label: "Draft", name: "draft", widget: "boolean", default: true}`
docs(fix): widget example code layout on Site (#1606) * Fix widget example layout * Stop running MarkDown through Prettier. 2018-08-14 07:37:07 -07:00			```