CheckboxInput

Beta notice: This page is being built.Edit on GitHub(opens in new tab)

Edits a boolean or indeterminate field.

longlink docs component "CheckboxInput"

Example

CheckboxInput - Properties
label`string` Label text for the checkbox (always rendered for accessibility).
description`string` Description text displayed below the label.
name`string` Includes the themed control's value under this form submission name.
required`boolean` Requires a value before native form submission.
disabled`boolean` Prevents interaction and excludes the field from submission.
value`boolean \| "indeterminate"` Whether the checkbox is checked, unchecked, or indeterminate.
defaultChecked`boolean` Initial checked state.
onChange`(value: boolean) => void` Callback fired when the checkbox state changes.