Checkbox
IzzyBlazor.Checkbox in the IzzyBlazor.Core package, generated from the 0.1.0-alpha.17 assembly
and its doc comments.
Properties (6)
ChildContentRenderFragment?Rich label content, such as text with a link. Overrides Label.
Indeterminatebool = falseShows the box as partly selected (a dash), such as a "select all" box when only some items are. Display only: it posts as unchecked, and choosing the box clears it. With script, screen readers announce it as "mixed". A Switch doesn't take it.
ControlPositionControlPosition = ControlPosition.StartWhich side of the label the box or switch sits on. End puts it at the end of the row, with the hint and errors under the label, as in a list of settings. Defaults to Start.
IconIconData?An icon before the label, such as a key for a security setting. With ControlPosition.End it's centered on the label and hint, at the start of the row. Decorative: screen readers read only the label. Use icons on every row of a group or none.
@bind-Valuebool = falseThe value, bound with @bind-Value.
DisplayNamestring?The field's name in validation messages from the input itself, such as a value that can't be parsed.
Field props (from FieldBase)
Labelstring? (computed)The visible label. Defaults to the model property's [Display(Name)], or its name.
HideLabelbool = falseKeeps the label for screen readers but doesn't show it, as in a toolbar or a one-field newsletter form. Checkboxes and switches show their label beside the box, so this doesn't apply.
Hintstring?Help text shown under the field and linked to it for screen readers.
Requiredbool? (computed)Whether a value is required. Defaults to whether the property has [Required].
Disabledbool = falseDisables the field. Disabled fields are not posted with the form.
SizeControlSize = ControlSize.MdHeight, shared with buttons. Defaults to ControlSize.Md.
Classstring?Classes for the field's outer wrapper (label, control, hint and error).
Stylestring?Inline style for the field's outer wrapper, after its generated custom properties.
VisibleFromBreakpoint?Shows the field only from this breakpoint up.
Margin on all sides, in spacing steps (-16 to 16; one step = 4px).
Width of the whole field (label, control, hint).
Minimum width of the whole field.
Maximum width of the whole field.
Growbool = falseWhether to grow into free space inside a Stack, Row or Column: <TextField Grow />.
Shrinkbool = trueWhether to shrink when space is short inside a Stack, Row or Column. Defaults to true.
Starting size inside a Stack, before growing or shrinking.
Alignment across the parent's direction, overriding the parent's Align for this field only.
Events (0)
No events.
Types (1)
ControlPosition
enumWhich side of its label a checkbox or switch sits on.
| Value | Description |
|---|---|
Start | Before the label (the default). |
End | After the label, at the end of the row, with the hint under the label. For settings lists of switches. |