CheckboxGroup
IzzyBlazor.CheckboxGroup<TValue, TItem> in the IzzyBlazor.Core package, generated from the 0.1.0-alpha.17 assembly
and its doc comments.
Properties (9)
ItemsIEnumerable<TItem>? requiredThe options. For an enum, pass its values: Items="Enum.GetValues<Topping>()".
ItemTextFunc<TItem, string>? (computed)The text for each option. Defaults to the enum value's [Display(Name)] or its string form.
ItemTemplateRenderFragment<TItem>?Markup for each option's label, such as an icon or a badge beside its name. All of it names the box; put a description in ItemDescription.
ItemDescriptionFunc<TItem, string?>?A line under each option's name, such as what choosing it does. Screen readers hear it as the box's description, after its name.
OrientationOrientation = Orientation.VerticalStack options vertically (the default) or in a row.
SelectAllbool = falseAdds a box above the options that checks or clears them all at once and shows a dash when only some are checked. It doesn't post; the options do. It works on static pages through the script, and isn't shown with JavaScript off. On an interactive page, ValueChanged runs once for each option it flips, so code that saves on every change sees the steps between.
With JavaScript off, the box isn't shown.
SelectAllTextstring? (computed)The SelectAll box's text. Defaults to SelectAll ("Select all"), also when empty.
@bind-ValueTValueThe 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.
Events (0)
No events.
Types (1)
Orientation
enumWhether items run across or down.
| Value | Description |
|---|---|
Vertical | Top to bottom. |
Horizontal | Side by side, wrapping when space runs out. |