Switch
A toggle switch input that represents a boolean value.
Its words keep one line each, as a checkbox's: a longer explanation is the field's hint (UIForm.Field(toggle, hint)).
new SwitchComponent("switch")
Properties
| Property | Type | Default | Binding | Description |
|---|---|---|---|---|
| From CheckboxComponent | ||||
BorderColorSetBorderColor · BindBorderColor | UIThemeColor? | null | one-way | The border's colour, written as CSS border-color; unset leaves the stylesheet's own. |
BorderThicknessSetBorderThickness · BindBorderThickness | UIResponsive<UIThickness>? | null | one-way | The border's thickness, optionally overridden per breakpoint; unset leaves the stylesheet's own. A frame on a wide screen may run edge to edge on a phone: SetBorderThickness(UIThickness.Uniform(0), md: UIThickness.Uniform(1)). |
BorderRadiusSetBorderRadius · BindBorderRadius | UIResponsive<UICornerRadius>? | null | one-way | The corner rounding, optionally overridden per breakpoint; unset leaves the stylesheet's own. |
DescriptionPlainSetDescriptionPlain | bool? | false | — | Whether the description is shown as written, its asterisks, brackets and braces as characters, rather than read as inline markup: words a person typed — a chat's message, an error's text from an address — bound to it; unset, it is markup. Render-time only: the first paint and every value pushed later are written the same way. |
DescriptionAutolinksSetDescriptionAutolinks | bool? | false | — | Whether a bare http:// or https:// address in the description is a link, as [words](address) is; unset, it is text. ITextComponent.DescriptionPlain wins over it.Render-time only: the first paint and every value pushed later are read the same way. An address in a phrase's argument links too, escaped or not. |
HeadingLevelSetHeadingLevel | int? | null | — | The heading level (1 through 6) the title stands at in the page's outline; unset, the title is plain text. Render-time only: the title's element ( h1 through h6) is chosen when the block is drawn. |
DescriptionSetDescription · BindDescription | UIPhrase | null | one-way | The secondary text. translatable |
DescriptionTypeSetDescriptionType · BindDescriptionType | UITextAppearance? | Caption | one-way | The secondary text type. |
DescriptionColorSetDescriptionColor · BindDescriptionColor | UIThemeColor? | Muted | one-way | The secondary text color. |
TextAlignmentSetTextAlignment · BindTextAlignment | UITextAlignment? | UITextAlignment.Start | one-way | How the title and description align within their box — Start, Center, End, or Justify; default Start. |
SizeSetSize · BindSize | UIResponsive<UISize>? | Medium | one-way | How much room the input takes, optionally per breakpoint: a field's height, side padding and text; a toggle's box and text; a slider's track and handle. |
IconAlignmentSetIconAlignment | UITextIconAlignment? | UITextIconAlignment.Title | — | Where the leading icon sits against the text beside it: Content (the default) centres it across title and description, while Title keeps it on the title's own line. |
BadgeAlignmentSetBadgeAlignment | UITextBadgeAlignment? | UITextBadgeAlignment.Title | — | Where a trailing badge sits against the text beside it: Title (default) keeps it at the title line's end; Content centres it across title and description. |
| From InputComponentBase | ||||
ValueSetValue · 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. |
IsReadOnlySetIsReadOnly · 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.True by a static value or a controller binding, the server refuses a value the input sends and answers it with the value it holds. A guard against a stale or forged page, not the permission itself: who may change the value belongs in the setter. |
FormIdSetFormId · BindFormId | string | null | one-way | The id of the form this input belongs to, used to scope Submit-trigger validation. Settable through the contract, so a preset can join the fields it holds to its form ( UIDialogs.Form). |
ValidationSetValidation · BindValidation | UIValidationMessage? | null | one-way | A message the controller puts on the field, beside whatever the client rules say; the strongest one shows. |
ValidationPresentationSetValidationPresentation | UIValidationPresentation? | UIValidationPresentation.Auto | — | Where the message goes: a line under the field, or an edge mark with the message in a tooltip. Decided once at render; UIValidationPresentation.Auto is the line except in a grid cell. |
IconSetIcon · BindIcon | string | null | one-way | The icon shown before the title, by name from the registered icon font/set. |
IconColorSetIconColor · BindIconColor | UIThemeColor? | Default | one-way | The leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor. |
IconSizeSetIconSize · BindIconSize | UISize? | null | one-way | The leading icon size; left unset the glyph is as tall as the title beside it. |
IconShapeSetIconShape · BindIconShape | UIShape? | null | one-way | The shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own. |
IconFallbackSetIconFallback · BindIconFallback | string | null | one-way | The glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other. |
TitleSetTitle · BindTitle | UIPhrase | null | one-way | The label text drawn as the title; nothing renders when it is unset. translatable A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it. |
TitleTypeSetTitleType · BindTitleType | UITextAppearance? | Body | one-way | The primary text type. |
TitleColorSetTitleColor · BindTitleColor | UIThemeColor? | Default | one-way | The primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default. |
BadgePlacementSetBadgePlacement · BindBadgePlacement | UITextBadgePlacement? | UITextBadgePlacement.Trailing | one-way | Where badge content is placed. |
BadgeVariantSetBadgeVariant · BindBadgeVariant | UIBadgeVariant? | UIBadgeVariant.Info | one-way | The badge visual variant. |
BadgeColorSetBadgeColor · BindBadgeColor | UIThemeColor? | null | one-way | The badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name. |
BadgeFillSetBadgeFill · BindBadgeFill | UIBadgeFill? | null | one-way | How the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it. |
BadgeIconSetBadgeIcon · BindBadgeIcon | string | null | one-way | The icon shown beside the badge's title, by name from the registered icon font/set. |
BadgeIconColorSetBadgeIconColor · BindBadgeIconColor | UIThemeColor? | Default | one-way | The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor. |
BadgeIconSizeSetBadgeIconSize · BindBadgeIconSize | UISize? | null | one-way | The badge icon size. Left unset the glyph is as tall as the badge's title. |
BadgeTitleSetBadgeTitle · BindBadgeTitle | UIPhrase | null | one-way | The short text drawn inside the badge, beside its icon. translatable |
BadgeTitleTypeSetBadgeTitleType · BindBadgeTitleType | UITextAppearance? | Overline | one-way | The role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType. |
BadgeTooltipSetBadgeTooltip · BindBadgeTooltip | UIPhrase | null | one-way | The tooltip for the badge content. translatable |
BadgeTooltipPlacementSetBadgeTooltipPlacement · BindBadgeTooltipPlacement | UIPopupPlacement? | UIPopupPlacement.Top | one-way | The side the badge's own tooltip prefers, placed against the badge rather than against the row. |
TooltipPlainSetTooltipPlain | bool? | false | — | Whether the tooltip is shown as written, its asterisks, brackets and braces as characters, rather than read as inline markup: words the controller holds bound to it — a person's name, a note's status; unset, it is markup. Render-time only: the first paint and every value pushed later are shown the same way. |
TooltipSetTooltip · BindTooltip | UIPhrase | null | one-way | The tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable |
TooltipPlacementSetTooltipPlacement · BindTooltipPlacement | UIPopupPlacement? | UIPopupPlacement.Top | one-way | The side the tooltip prefers; flips to the opposite side when there is no room for it there. |
AccessibleNameSetAccessibleName · BindAccessibleName | UIPhrase | null | one-way | The name a screen reader announces in place of the visible words; unset, the control is named by what it shows. The set is a wrapper's hand (a labelled control is named by its label), an author's own words said at the component. translatable |
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.
OnChangeLiteral(string command, params KeyValuePair<string, object>[] arguments)- Registers a change event command with literal argument values.
OnBlur(string command)- Registers a blur event command.
OnBlur(string command, params KeyValuePair<string, UIActionArgument>[] arguments)- Registers a blur event command with action arguments.
OnBlurLiteral(string command, params KeyValuePair<string, object>[] arguments)- Registers a blur event command with literal argument values.
Methods
SetHeaderAction(IVisualComponent action)- Sets the control the caption row carries at its far edge, keeping the row at one caption line's height.
ConfigureTemplate(TTemplate? current, Action<TTemplate> configure, string what)- Configures
currentwhen it is aTTemplate, throwing when a different one was set. ValidationInto(IVisualComponent targetComponent, UIProperty property)- Sends this field's validation message to another component's property, leaving the field its edge colour alone.
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; its message is the author's text or a key.
Required(UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)- Adds a required-value validation rule whose message is a phrase, such as a key with its arguments.
Regex(string pattern, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)- Adds a regular-expression validation rule; its message is the author's text or a key.
Regex(string pattern, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)- Adds a regular-expression validation rule whose message is a phrase, such as a key with its arguments.
RegexEach(string pattern, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)- Adds a rule every item of a list value must match — a multi-select's each key, and a tag typed into one with free text is refused before it becomes a chip; its message is the author's text or a key.
RegexEach(string pattern, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)- Adds a rule every item of a list value must match, whose message is a phrase, such as a key with its arguments.
Validate(UIValidationTrigger trigger, UIComparisonOperator operator, object? value, string message, UIValidationSeverity severity = UIValidationSeverity.Error)- Adds a validation rule; its message is the author's text or a key, looked up as a plain value on a translatable property is.
Validate(UIValidationTrigger trigger, UIComparisonOperator operator, object? value, UIPhrase message, UIValidationSeverity severity = UIValidationSeverity.Error)- Adds a validation rule whose message is a phrase: a key with its arguments — a limit's
{max}— orUIPhrase.Text. ValidateAgainst(IInputComponent sourceComponent, UIComparisonOperator operator, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)- Adds a rule comparing the value with another field's — "Password again"
Equalto "New password" — judged in the browser as either changes; its message is the author's text or a key. ValidateAgainst(string componentId, UIComparisonOperator operator, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)- Adds a rule comparing the value with another field's — "Password again"
Equalto "New password" — judged in the browser as either changes; its message is the author's text or a key. ValidateAgainst(IInputComponent sourceComponent, UIComparisonOperator operator, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)- Adds a rule comparing the value with another field's, whose message is a phrase, such as a key with its arguments.
ValidateAgainst(string componentId, UIComparisonOperator operator, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)- Adds a rule comparing the value with another field's, whose message is a phrase, such as a key with its arguments.
Common properties (23) — layout, visibility, theme, and the rest every component shares
| Property | Type | Default | Binding | Description |
|---|---|---|---|---|
VisibilitySetVisibility · 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). Hidden at every width — by a static value or a controller binding — the server refuses a command or a value the component or anything inside it sends. That is a guard against a stale or forged page, not the permission itself: an interaction that hides it ( HiddenWhen) lives on the client alone, so who may act belongs in the command or the setter. |
EnabledSetEnabled · BindEnabled | bool? | true | one-way | Whether the component responds to input; false dims it and marks it, and its subtree, inert. False by a static value or a controller binding, the server refuses a command or a value the component or anything inside it sends. That is a guard against a stale or forged page, not the permission itself: an interaction that disables it ( EnabledWhen) lives on the client alone, so who may act belongs in the command or the setter. |
ThemeSetTheme · BindTheme | UIThemeMode? | null | one-way | The theme mode forced on this component's subtree, or null to inherit the ambient theme. |
HorizontalAlignmentSetHorizontalAlignment · BindHorizontalAlignment | UIResponsive<UIAlignment>? | Stretch | one-way | Where the component sits within its grid cell along the horizontal axis, optionally overridden per breakpoint. |
VerticalAlignmentSetVerticalAlignment · BindVerticalAlignment | UIResponsive<UIAlignment>? | Center | one-way | Where the component sits within its grid cell along the vertical axis, optionally overridden per breakpoint. |
WidthSetWidth · BindWidth | UIResponsive<UILayoutLength>? | null | one-way | The component width, optionally overridden per breakpoint. |
MinWidthSetMinWidth · BindMinWidth | UIResponsive<UILayoutLength>? | null | one-way | The component minimum width, optionally overridden per breakpoint. |
MaxWidthSetMaxWidth · BindMaxWidth | UIResponsive<UILayoutLength>? | null | one-way | The component maximum width, optionally overridden per breakpoint. |
HeightSetHeight · BindHeight | UIResponsive<UILayoutLength>? | null | one-way | The component height, optionally overridden per breakpoint. |
MinHeightSetMinHeight · BindMinHeight | UIResponsive<UILayoutLength>? | null | one-way | The component minimum height, optionally overridden per breakpoint. |
MaxHeightSetMaxHeight · BindMaxHeight | UIResponsive<UILayoutLength>? | null | one-way | The component maximum height, optionally overridden per breakpoint. |
ZIndexSetZIndex · BindZIndex | int? | 0 | one-way | The stacking order within the visual tree. |
MarginSetMargin · BindMargin | UIResponsive<UIThickness>? | null | one-way | The outer spacing around the component, optionally overridden per breakpoint. |
PlacementSetPlacement · BindPlacement | UIResponsive<UIGridPlacement>? | null | one-way | The grid placement, optionally overridden per breakpoint. |
AlignWithFieldBoxesSetAlignWithFieldBoxes | UIResponsive<UIFieldBoxAlignment>? | null | — | Whether the component stands level with the boxes of captioned fields beside it — a caption line down, centred on the box — and on which boxes, per breakpoint. Unset, the compiler decides it wherever the component stands side by side with a thing that draws a caption row (UIFieldBoxes); UIFieldBoxAlignment.None keeps it where it is laid out.Render-time only. A panel draws it as its top padding and its least height, anything else as its top margin, set down onto the band's middle; an authored Padding, MinHeight or Margin replaces them. |
LoadingSetLoading · BindLoading | bool? | false | one-way | Whether the component is in loading state — a live state a controller turns on and off. While it holds, by a static value or a controller binding, the server refuses a command or a value the component or anything inside it sends — as the page does. |
LoadingStyleSetLoadingStyle · BindLoadingStyle | UILoadingStyle? | null | one-way | The visual indicator shown while this component or spinner is loading, or null to inherit the ambient or theme loading style. |
ShowContextMenuSetShowContextMenu · 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. |
ActionBarSetActionBar | UIActionBarAlignment? | null | — | How the component's action bar lines up with it, or null for none: the IVisualComponent.ContextMenu's entries marked for the bar (a menu item's InActionBar) as icons, and "more" opening the menu itself, floating above the component once the reader chooses it — a press, a tap, the keyboard's cursor — until a press elsewhere, Escape, or another chosen.A quick view of the menu, not a second list: a press on an icon is that entry's press. Render-time only; a component with an action bar and no context menu is refused when the view compiles. |
ActionBarRepeatInMoreSetActionBarRepeatInMore | bool? | true | — | Whether the menu the IVisualComponent.ActionBar's "more" opens repeats the entries the bar shows (the default), or holds the rest alone — no caption or rule left with nothing to stand over or between. A right-click and a long press open the whole menu either way, and a bar whose menu holds nothing more draws no "more".Render-time only. |
ScrollGroupSetScrollGroup · BindScrollGroup | string | null | one-way | The scroll group this component belongs to: every component sharing the name scrolls together. Driven by whichever one the reader scrolls. Components that mark their shown source lines (e.g. a code field and a Markdown display) sync line-for-line; otherwise by scroll fraction. |
TextSelectableSetTextSelectable · BindTextSelectable | bool? | null | one-way | Whether the reader can select the words in this component and everything inside it: true lets them (a table whose cells are copied, a chat bubble), false keeps them out; unset, the place decides — a Text's and a Paragraph's words and a validation message select, unless they stand in a row, a menu or another control, and nothing else does. The nearest component that says wins. A control's own words (a button's label, a tab, a menu entry, a field's caption), a surface the pointer drags (a row that drags by itself, a canvas, a grip) and, on a touch screen, anything a long press opens a menu on never select; a field's value always does. |
WindowFootSetWindowFoot | bool? | null | — | Whether this component is the window's foot (a chat's composer, a pane's last row): where it stands at the window's bottom edge the phone's system bar takes its background colour, dimmed by any open modal drawer or dialog veil, and its content sits above the bar. The page's bottom bar is one by itself. Render-time only. |