# Checkbox

_How to add and configure a Checkbox field in the Notebook Editor._

---

```{important}
Checkbox is **deprecated** for new form design.
It remains fully supported for existing notebooks and existing Checkbox fields are not removed.
For new forms, prefer [Select one option](radio-group.md) with explicit choices such as "Yes" and "No".
```

## What This Field Does

A Checkbox Field provides a toggle that stores a boolean
value — checked (true) or unchecked (false). Use it for
presence/absence indicators, consent acknowledgements, procedural
confirmations, or data quality flags. Unlike other choice fields
(e.g., Select Field, Select Multiple), a Checkbox captures a
single yes/no state rather than a selection from a list.

## Adding the Field

New Checkbox fields are not available from the add-field chooser.
Checkbox remains supported for legacy notebooks where it already exists.
For new forms, add **Select one option** instead.

> **Note:** You can still edit Checkbox settings for existing fields.

## Configuring the Field

Click the field's **grey header bar** to expand it and see its settings.
For an overview of the settings shared by all fields — including Label,
Helper Text, Field ID, and the field toolbar — see
[Field Identity](../shared-settings/field-identity.md) and
[Field Toolbar](../shared-settings/field-toolbar.md).

Give the field a meaningful Label, review the auto-populated
Field ID, and add any desired Helper Text.

```{screenshot} field-types-design/checkbox-02-configured.png
:alt: Checkbox configuration in the {{Notebook}} Editor
:align: right
:width: 100%
```

### Shared Field Options

Configure any of the shared field options as needed.

For settings shared across all field types — including Required,
Annotation, Uncertainty, Conditions, Copy value to new records,
and Display in child records — see
[Field Options](../shared-settings/field-options.md).

## Tips

- **"Required" does not mean "must be checked."** Marking a Checkbox as
  Required prevents a null (unanswered) state but still allows the collector
  to leave it unchecked (false). If you need to force a checked state (e.g.,
  for consent forms), this must be configured via JSON validation rules.
- **For questions with more than two states** (e.g., "yes / no / unknown"),
  use a Select Field or a 'Select one option' field instead of a Checkbox.
- **Checkbox is ideal for quick binary flags** during rapid data collection —
  presence/absence of charcoal, bioturbation observed, safety check completed.
- **Enable Annotation and Uncertainty** if collectors might need to qualify
  their answer, such as noting "could not confirm — poor visibility".

## Migration Guidance

- Existing Checkbox fields can be left in place and will continue to work.
- For new templates, replace Checkbox with **Select one option** to make choices explicit.
- If you need three or more states (for example "yes / no / unknown"), use **Select one option** or **Select Field**.