Skip to content

Forms

ICheckbox

A checkbox for a choice that is submitted rather than applied on the spot. The model is tri-state: true, false, or 'indeterminate' for a parent whose children disagree. For a setting that takes effect immediately, use ISwitch.

With a description

Store a PDF of every invoice you send, for seven years.

Indeterminate

Set the model to the string 'indeterminate' for the mixed state. A "select all" checkbox is then one binding derived from its children, which is what ITable's header checkbox does.

Model: indeterminate

Sizes

Disabled

Props

PropTypeDefaultDescription
labelstringText beside the box, wired to it
descriptionstringSecondary line under the label
size'sm' | 'md' | 'lg''md'Control scale
idstringgeneratedUseful when an external ILabel targets it
unstyledbooleanDrop built-in classes
classstringMerged with the built-in classes
ui{ wrapper?, root?, indicator?, content?, label?, description? }Per-slot class overrides

The model is boolean | 'indeterminate'. disabled, required, name and value are forwarded to the underlying control, so the checkbox posts in a plain <form>.

Slots

SlotWhen to use it
labelThe label needs markup, such as a link inside it
descriptionSame, for the description