Switch

A toggle switch input that represents a boolean value.

SwitchComponent · type key standard.input.switch · Inputs

new SwitchComponent("switch")

Properties

Property	Type	Default	Binding	Description
From CheckboxComponent
`Description` SetDescription · BindDescription	`string`	`null`	one-way	The secondary text. translatable
`DescriptionType` SetDescriptionType · BindDescriptionType	`UITextAppearance?`	`Body`	one-way	The secondary text type.
`DescriptionColor` SetDescriptionColor · BindDescriptionColor	`UIThemeColor?`	`Muted`	one-way	The secondary text color.
`TextAlignment` SetTextAlignment · BindTextAlignment	`UITextAlignment?`	`UITextAlignment.Start`	one-way	How the title and description align within their box — Start, Center, End, or Justify; default Start.
From TextInputComponentBase
`BorderColor` SetBorderColor · BindBorderColor	`UIThemeColor?`	`null`	one-way	The border's colour, written as CSS `border-color`; unset leaves the stylesheet's own.
`BorderThickness` SetBorderThickness · BindBorderThickness	`UIThickness?`	`null`	one-way	The border's thickness, written as CSS `border-width`; unset leaves the stylesheet's own.
`BorderRadius` SetBorderRadius · BindBorderRadius	`UICornerRadius?`	`null`	one-way	The corner rounding, written as CSS `border-radius`; unset leaves the stylesheet's own.
From InputComponentBase
`Value` SetValue · BindValue	`bool?`	`null`	two-way	The input's current value, boxed to `Object`; a concrete input also exposes its own typed `Value` alongside this one.
`IconColor` SetIconColor · BindIconColor	`UIThemeColor?`	`Primary`	one-way	The leading icon's colour, defaulting to `ITextBaseModel.DefaultIconColor`.
`TitleType` SetTitleType · BindTitleType	`UITextAppearance?`	`Caption`	one-way	The primary text type.
`Selectable` SetSelectable · BindSelectable	`bool?`	`false`	one-way	Whether the text can be selected with the pointer; content says yes, a control's caption says no. A field's caption is part of the control, not content: it is not selectable unless asked.
`BadgePlacement` SetBadgePlacement · BindBadgePlacement	`UITextBadgePlacement?`	`UITextBadgePlacement.Trailing`	one-way	Where badge content is placed.
`IsReadOnly` SetIsReadOnly · BindIsReadOnly	`bool?`	`false`	one-way	Whether the input can be seen but not edited; unlike `IVisualComponent.Enabled`, a read-only value still submits and stays focusable.
`FormId` SetFormId · BindFormId	`string`	`null`	one-way	The id of the form this input belongs to, used to scope Submit-trigger validation.
`Validation` SetValidation · BindValidation	`UIValidationMessage?`	`null`	one-way	A message the controller puts on the field, beside whatever the client rules say; the strongest one shows.
`ValidationPresentation` SetValidationPresentation	`UIValidationPresentation?`	`UIValidationPresentation.Auto`	—	Where the message goes: a line under the field, or a mark at its edge with the message in a tooltip. Decided once at render; `UIValidationPresentation.Auto` is the line except in a cell of a grid.
`Icon` SetIcon · BindIcon	`string`	`null`	one-way	The icon shown before the title, by name from the registered icon font/set. translatable
`IconSize` SetIconSize · BindIconSize	`UIIconSize?`	`null`	one-way	The leading icon size; left unset the glyph is as tall as the title beside it.
`Title` SetTitle · BindTitle	`string`	`null`	one-way	The label text drawn as the title; nothing renders when it is unset. translatable
`TitleColor` SetTitleColor · BindTitleColor	`UIThemeColor?`	`Default`	one-way	The primary text colour, which also colours the icon and the description unless either is overridden by `ITextModel.DescriptionColor` or `IconColor`.
`BadgeStyle` SetBadgeStyle · BindBadgeStyle	`UIBadgeType?`	`UIBadgeType.Info`	one-way	The badge visual variant.
`BadgeColor` SetBadgeColor · BindBadgeColor	`UIThemeColor?`	`null`	one-way	The badge's own colour, overriding `IBadgeModel.BadgeStyle` when set — a tag or a category swatch, which the closed style enum cannot name.
`BadgeIcon` SetBadgeIcon · BindBadgeIcon	`string`	`null`	one-way	The icon shown beside the badge text, by name from the registered icon font/set. translatable
`BadgeIconColor` SetBadgeIconColor · BindBadgeIconColor	`UIThemeColor?`	`Default`	one-way	The badge icon's colour, defaulting to `IBadgeModel.DefaultBadgeIconColor`.
`BadgeIconSize` SetBadgeIconSize · BindBadgeIconSize	`UIIconSize?`	`null`	one-way	The badge icon size. Left unset the glyph is as tall as the badge's own text.
`BadgeText` SetBadgeText · BindBadgeText	`string`	`null`	one-way	The short text drawn inside the badge, beside its icon. translatable
`BadgeTextType` SetBadgeTextType · BindBadgeTextType	`UITextAppearance?`	`Overline`	one-way	The badge text's role, defaulting to `IBadgeModel.DefaultBadgeTextType`.
`BadgeTooltip` SetBadgeTooltip · BindBadgeTooltip	`string`	`null`	one-way	The tooltip for the badge content. translatable
`BadgeTooltipPlacement` SetBadgeTooltipPlacement · BindBadgeTooltipPlacement	`UIPopupPlacement?`	`UIPopupPlacement.Top`	one-way	The side the badge's own tooltip prefers, placed against the badge rather than against the row.
`Tooltip` SetTooltip · BindTooltip	`string`	`null`	one-way	The tooltip shown on hover and on focus. On a button-shaped control with no title of its own — an icon button — it is also the name a screen reader gets. translatable
`TooltipPlacement` SetTooltipPlacement · BindTooltipPlacement	`UIPopupPlacement?`	`UIPopupPlacement.Top`	one-way	The side the tooltip prefers; flips to the opposite side when there is no room for it there.

Events

OnChange(string command): Registers a change event command.
OnChange(string command, params KeyValuePair<string, UIActionArgument>[] arguments): Registers a change event command with action arguments.
OnBlur(string command): Registers a blur event command.
OnBlur(string command, params KeyValuePair<string, UIActionArgument>[] arguments): Registers a blur event command with action arguments.

Methods

ValidationInto(string componentId, UIProperty property): Sends this field's validation message to another component's property, leaving the field its edge colour alone.
Required(string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error): Adds a required-value validation rule.
Regex(string pattern, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error): Adds a regular-expression validation rule.

Common properties (16) — layout, visibility, theme, and the rest every component shares

Property	Type	Default	Binding	Description
`Visibility` SetVisibility · BindVisibility	`UIResponsive<UIVisibility>?`	`Visible`	one-way	What the component does with the room it was given, optionally overridden per breakpoint (e.g. collapsed from a given width up).
`Enabled` SetEnabled · BindEnabled	`bool?`	`true`	one-way	Whether the component responds to input; false dims it and marks it, and its subtree, inert.
`Theme` SetTheme · BindTheme	`UIThemeMode?`	`null`	one-way	The theme mode forced on this component's subtree, or `null` to inherit the ambient theme.
`HorizontalAlignment` SetHorizontalAlignment · BindHorizontalAlignment	`UIAlignment?`	`UIAlignment.Stretch`	one-way	Where the component sits within its grid cell along the horizontal axis.
`VerticalAlignment` SetVerticalAlignment · BindVerticalAlignment	`UIAlignment?`	`UIAlignment.Stretch`	one-way	Where the component sits within its grid cell along the vertical axis.
`Width` SetWidth · BindWidth	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component width, optionally overridden per breakpoint.
`MinWidth` SetMinWidth · BindMinWidth	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component minimum width, optionally overridden per breakpoint.
`MaxWidth` SetMaxWidth · BindMaxWidth	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component maximum width, optionally overridden per breakpoint.
`Height` SetHeight · BindHeight	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component height, optionally overridden per breakpoint.
`MinHeight` SetMinHeight · BindMinHeight	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component minimum height, optionally overridden per breakpoint.
`MaxHeight` SetMaxHeight · BindMaxHeight	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component maximum height, optionally overridden per breakpoint.
`ZIndex` SetZIndex · BindZIndex	`int?`	`0`	one-way	The stacking order within the visual tree.
`Margin` SetMargin · BindMargin	`UIResponsive<UIThickness>?`	`null`	one-way	The outer spacing around the component, optionally overridden per breakpoint.
`Placement` SetPlacement · BindPlacement	`UIResponsive<UIGridPlacement>?`	`null`	one-way	The grid placement, optionally overridden per breakpoint.
`Loading` SetLoading · BindLoading	`bool?`	`false`	one-way	Whether the component is in loading state — a live state a controller turns on and off.
`ShowContextMenu` SetShowContextMenu · BindShowContextMenu	`bool?`	`true`	one-way	Whether a right-click opens the `IVisualComponent.ContextMenu`; on a host with rows, whether it opens any row's. Off, the menu stays in the tree and nothing opens it.