CheckboxListInput
This documentation provides a comprehensive reference for the CheckboxListInput<TValue> component, including its typed item collection, selected values binding, and developer-focused customization options.
Preview #
Parameters #
| Name | Type | Default | Required | Description | Added Version |
|---|---|---|---|---|---|
| AdditionalAttributes | Dictionary<string, object> | null | Gets or sets additional attributes that will be applied to the component. | 1.0.0 | |
| Class | string? | null | Gets or sets the CSS class name(s) to apply to the component. | 1.0.0 | |
| Disabled | bool | False | Gets or sets the disabled state for the entire checkbox list. | 1.2.0 | |
| Id | string? | null | Gets or sets the ID. If not set, a unique ID will be generated. | 1.0.0 | |
| Items | IEnumerable<CheckboxListInputItem<TValue>>? | null | Gets or sets the checkbox items rendered by the component. | 1.2.0 | |
| ItemTemplate | RenderFragment<CheckboxListInputItem<TValue>>? | null | Gets or sets the content template used for each checkbox item. | 1.2.0 | |
| Name | string | null | Gets or sets the checkbox input name shared by each rendered input. | 1.2.0 | |
| Orientation | CheckboxListInputOrientation | Horizontal | Gets or sets the orientation. | 1.2.0 | |
| Size | CheckboxListInputSize | None | Gets or sets the size. | 1.2.0 | |
| Style | string? | null | Gets or sets the CSS style string that defines the inline styles for the component. | 1.0.0 | |
| Values | List<TValue>? | null | Gets or sets the selected values. | 1.2.0 | |
| ValuesExpression | Expression<Func<List<TValue>?>>? | null | Gets or sets the expression. | 1.2.0 |
Methods #
| Name | Return type | Description | Added Version |
|---|---|---|---|
| ClearAsync() | Task | Clears all selected values. | 1.2.0 |
| Disable() | Void | Disables the CheckboxListInput<TValue>. |
1.2.0 |
| Enable() | Void | Enables the CheckboxListInput<TValue>. |
1.2.0 |
| SelectAllAsync() | Task | Selects all enabled checkbox items. | 1.2.0 |
Events #
| Name | Return Type | Description | Added Version |
|---|---|---|---|
| ValuesChanged | EventCallback<List<TValue>> | This event fires when the CheckboxListInput<TValue> values change. |
1.2.0 |