HxSwitch #

Switch input.
(Replaces the former HxInputSwitch component which was dropped in v4.0.0.)

HxSwitch replaces the former HxInputSwitch component, which was dropped in v4.0.0.

HxInputSwitch.Label is now HxSwitch.Text
new Label parameter coresponds to the optional .form-label

Basic usage #

HxSwitch

switch this

Checked: False

<HxSwitch Label="HxSwitch" Text="switch this" @bind-Value="isChecked" />

Checked: @isChecked

@code {
    private bool isChecked;
}

Reverse #

Put the switch on the opposite side by setting the Reverse parameter to true.

switch this

API #

Parameters #

Name	Type	Description
AdditionalAttributes	`IReadOnlyDictionary<string, object>`	A collection of additional attributes that will be applied to the created element.
ChipTemplate	`RenderFragment`	Chip template.
CssClass	`string`	Custom CSS class to render with wrapping div.
DisplayName	`string`	Gets or sets the display name for this field. This value is used when generating error messages when the input value fails to parse correctly.
Enabled	`bool?`	When `null` (default), the `Enabled` value is received from cascading `FormState`. When value is `false`, input is rendered as disabled. To set multiple controls as disabled use HxFormState.
GenerateChip	`bool`	When `true`, `HxChipGenerator` is used to generate chip item(s). Default is `true`.
Hint	`string`	Hint to render after input as form-text.
HintTemplate	`RenderFragment`	Hint to render after input as form-text.
Inline	`bool`	Allows grouping checkboxes on the same horizontal row by rendering them inline. Default is `false`. Works only when there is no label, no hint and no validation message.
InputCssClass	`string`	Custom CSS class to render with the input element.
Label	`string`	Label text.
LabelCssClass	`string`	Custom CSS class to render with the label.
LabelTemplate	`RenderFragment`	Label content.
Reverse	`bool`	Put the checkbox on the opposite side - first text, then checkbox.
Settings	`CheckboxSettings`	Set of settings to be applied to the component instance.
Text	`string`	Text to display next to the checkbox.
TextCssClass	`string`	CSS class to apply to the text.
TextTemplate	`RenderFragment`	Content to display next to the checkbox.
ValidationMessageMode	`ValidationMessageMode?`	Specifies how the validation message should be displayed. Default is `ValidationMessageMode.Regular`, you can override application-wide default for all inputs in `HxInputBase.Defaults`.
Value	`bool`	Value of the input. This should be used with two-way binding.
ValueChanged	`EventCallback<bool>`	A callback that updates the bound value.
ValueExpression	`Expression<Func<bool>>`	An expression that identifies the bound value.

Methods #

Method	Returns	Description
FocusAsync()	`ValueTask`	Gives focus to the input element.