> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Boolean

Allows you to display boolean controls for your widget. The control displays as a checkbox.

---

**Widget Configuration Output**

```json showLineNumbers={false}
{
  "displayControls": true
}
```

---

**User Interface Output**

![output](/_fern-img/cee26518e79d0644828c0accb6ad5979c630865ca99adc00673cf0cea79d60f6.webp)

---

**JSON Schema**

| Property  | Type    | Description                                                                         | Example                  |
| --------- | ------- | ----------------------------------------------------------------------------------- | ------------------------ |
| `type`    | string  | The type of setting component to display.                                           | "boolean"                |
| `label`   | string  | The user friendly message to inform the user how this setting will be used.         | "Display video controls" |
| `id`      | string  | The variable name where the setting value will be available in the widget template. | "displayControls"        |
| `default` | boolean | The default value to use when rendering the widget for the first time.              | True                     |