Skip to content
IzzyBlazor 0.1.0-alpha.17

Enter all results ↑ ↓ move Esc close

CheckboxGroup

Several choices as checkboxes.

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>? required

The 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?>?Added in 0.1.0-alpha.13

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.Vertical

Stack options vertically (the default) or in a row.

SelectAllbool = falseAdded in 0.1.0-alpha.13Needs JavaScript

Adds 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)Added in 0.1.0-alpha.13

The SelectAll box's text. Defaults to SelectAll ("Select all"), also when empty.

The 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 = false

Keeps 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 = false

Disables the field. Disabled fields are not posted with the form.

SizeControlSize = ControlSize.Md

Height, 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.

HiddenFromBreakpoint?

Hides the field from this breakpoint up.

VisibleFromBreakpoint?

Shows the field only from this breakpoint up.

MarginResponsive<int>Responsive

Margin on all sides, in spacing steps (-16 to 16; one step = 4px).

MarginXResponsive<int>Responsive

Horizontal margin. When set, replaces Margin on this axis.

MarginYResponsive<int>Responsive

Vertical margin. When set, replaces Margin on this axis.

MarginTopResponsive<int>Responsive

Top margin. When set, replaces MarginY and Margin on this side.

MarginBottomResponsive<int>Responsive

Bottom margin. When set, replaces MarginY and Margin on this side.

MarginStartResponsive<int>Responsive

Margin at the start (left in left-to-right text). Replaces MarginX and Margin on this side.

MarginEndResponsive<int>Responsive

Margin at the end (right in left-to-right text). Replaces MarginX and Margin on this side.

WidthResponsive<Length>Responsive

Width of the whole field (label, control, hint).

MinWidthResponsive<Length>Responsive

Minimum width of the whole field.

MaxWidthResponsive<Length>Responsive

Maximum width of the whole field.

Growbool = false

Whether to grow into free space inside a Stack, Row or Column: <TextField Grow />.

Shrinkbool = true

Whether to shrink when space is short inside a Stack, Row or Column. Defaults to true.

BasisResponsive<Length>Responsive

Starting size inside a Stack, before growing or shrinking.

AlignSelfResponsive<Align>Responsive

Alignment across the parent's direction, overriding the parent's Align for this field only.

ColSpanResponsive<int>Responsive

How many columns the field spans in a Form or Fieldset with Columns; GridSpan.Full for the whole row. Never more than the columns shown.

NewRowbool = false

Starts a new row in a Form or Fieldset with Columns, or a Grid, leaving the rest of the row before it empty.

Events (0)

No events.

Types (1)

Orientation

enum

Whether items run across or down.

Orientation values
ValueDescription
Vertical

Top to bottom.

Horizontal

Side by side, wrapping when space runs out.