RayCraftDocs
v1.0.3 raycraft.dev
On this page

CheckboxGroup

Free

A group of check boxes for choosing several items from a list, inside a fieldset with a legend so screen readers announce the group name. ShowSelectAll adds a Select all box that shows the mixed state when only some items are chosen.

Example

CheckboxGroup control

Parameters

ParameterTypeDescription
ClassstringExtra CSS classes added to the root element.
DirectionStackDirectionColumn (default) or Row.
DisabledboolDisables interaction.
HelperTextstringHint shown below the field.
ItemDisabledFunc<string, bool>Returns true for items that cannot be changed; the other items stay editable.
ItemIconFunc<string, IconName?>Returns the icon of an item.
ItemsIEnumerable<string>The options to choose from.
ItemTextFunc<string, string>Converts an item to its display text (defaults to ToString()).
LabelstringVisible label text (charts: accessible name; IconButton: accessible name and tooltip).
MultipleboolAllows several selected rows: click, Ctrl+click, Shift+click, Shift+arrows, Ctrl+A (VirtualList).
ShowSelectAllboolShows a Select all box above the items.
StylestringInline style added to the root element.
ValuestringCurrent value. Use with @bind-Value.
ValuesIReadOnlyCollection<string>The chosen items. Use with @bind-Values.

Events

EventTypeDescription
ValueChangedEventCallback<string>Raised when the value changes.
ValuesChangedEventCallback<IReadOnlyCollection<string>>Raised when the chosen items change.

Package

CheckboxGroup is part of RayCraft Free. Package: RayCraft.Blazor. It comes from nuget.org. See Getting started.