CheckboxField
Labelled checkbox field with inline layout — wraps the Checkbox primitive with a right-side label and optional help text
Interactive-mode
Examples
Default checkbox field
Checkbox field with help text
Receive weekly product updates and tips.
API
The element family below can be composed together. Click an element to jump to its properties.
| Element | Purpose |
|---|---|
| CheckboxField | A labelled checkbox field chunk with inline layout. The checkbox sits on the left; the label and optional help text stack to the right. Wraps the Checkbox primitive. |
CheckboxField
A labelled checkbox field chunk with inline layout. The checkbox sits on the left; the label and optional help text stack to the right. Wraps the Checkbox primitive.
| Property | Type | Required | Description |
|---|---|---|---|
| Label | string? | Label text rendered to the right of the checkbox via FormLabel. Omit to hide the label. | |
| HelpText | string? | Helper text rendered below the label. Shown in text-danger-fg when Error is true, otherwise text-muted-foreground. | |
| Error | bool | Applies error styling to the label and help text. Default: false. | |
| Required | bool | Appends a red asterisk to the label via FormLabel. Default: false. | |
| Disabled | bool | Disables the underlying checkbox. Default: false. | |
| Id | string | HTML id for the checkbox — wired to the label's for attribute. Auto-generated by default. | |
| Value | bool | Whether the checkbox is checked. Use @bind-Value for two-way binding. | |
| ValueChanged | EventCallback<bool> | Fires when the checked state changes. Part of the @bind-Value pair. |