---
title: checkbox
description: A labelled on/off control whose checked state is a string-backed boolean.
status: shipped
url: https://getairframe.com/framewerk/reference/nodes/checkbox
---

> Part of the Framewerk docs. Index of every page: /framewerk/llms.txt

# `checkbox`

A labelled on/off control whose checked state is a string-backed boolean.

## Example

**checkbox**

```json
{
  "id": "f",
  "layout": {
    "_id": "root",
    "type": "column",
    "gap": 12,
    "padding": 16,
    "children": [
      {
        "_id": "c",
        "type": "checkbox",
        "label": "Email me",
        "checked": true
      }
    ]
  }
}
```

## States

`checked`. Common to every node: `hover` / `press` / `focus` CSS bags, `showWhen` / `hideWhen`, `animate`.

## Stability

This node type is part of the format contract: adding an optional prop is additive; removing the node or narrowing an existing prop is breaking. Prop tables are generated from the schema; this page carries the prose.