Button group
A strip of segments pressed flush against each other, one of them current.
Navigation, not an input: the chosen segment is a key, never a validated value. Segments are IButtonModels drawn as ghost buttons on the field's ground, ruled between segments; the current one fills primary unless SelectionStyle says otherwise. Always horizontal.
new ButtonGroupComponent("button-group")
Properties
| Property | Type | Default | Binding | Description |
|---|---|---|---|---|
| Own | ||||
SizeSetSize · BindSize | UIResponsive<UISize>? | Medium | one-way | How much room the strip takes, optionally per breakpoint; every segment follows it. |
BackgroundSetBackground · BindBackground | UIThemeColor? | null | one-way | The surface's background colour; unset leaves whatever the theme paints underneath. |
PaddingSetPadding · BindPadding | UIResponsive<UIThickness>? | null | one-way | The inner spacing between this component's edges and its content, optionally overridden per breakpoint. |
BackgroundImageSetBackgroundImage · BindBackgroundImage | string | null | one-way | The picture painted over the background colour, centred and never repeated: a URL or a data URI. |
BackgroundImageFitSetBackgroundImageFit · BindBackgroundImageFit | UIImageFit? | UIImageFit.Cover | one-way | How the picture fills the surface. |
BackgroundImageDimSetBackgroundImageDim · BindBackgroundImageDim | double? | null | one-way | How far the picture is dimmed, from 0 (not at all) to 1 (gone): the ground the content reads on, laid over it — darker in a dark theme, lighter in a light one. Drawn by the browser; unset, the picture is not dimmed. |
BackgroundImageDimModeSetBackgroundImageDimMode · BindBackgroundImageDimMode | UIBackgroundDimMode? | UIBackgroundDimMode.Uniform | one-way | How ISurfaceComponent.BackgroundImageDim is spread over the picture: evenly, or at the edges alone. |
BackgroundImageBlurSetBackgroundImageBlur · BindBackgroundImageBlur | double? | null | one-way | The blur of the picture, in the platform's device-independent units, zero or more; the content over it stays sharp. Drawn by the browser; unset, the picture is not blurred. |
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. |
SelectionStyleSetSelectionStyle · BindSelectionStyle | UISelectionStyle? | null | one-way | What a chosen item looks like. Unset, and every unset part of it, is the control's own default. |
SelectedKeySetSelectedKey · BindSelectedKey | string | null | two-way | The key of the chosen part — a host's row under UISelectionMode.One, a strip's segment, the tab shown; two-way, so the reader's choice writes the new key back. |
| From ItemsComponentBase | ||||
ItemsSetItems · BindItems | IReadOnlyList<IButtonModel> | null | one-way | The component items. |
ItemsViewBindItemsView | UIItemsView | null | one-way | Filtering and sorting rules applied to the items collection. |
QuerySetQuery · BindQuery | UIItemsQuery | null | two-way | The terms the viewer set after the view compiled (a header's sort, a filter row), applied beside the authored rules; two-way bound, so a windowed source is asked with them. |
ItemReads | UIItemReads | null | — | What the page reads off the rows beyond what the templates, rules and keys read — a client engine reading items raw — or null for nothing more; a row carries only what is read (UIItemReads.Whole sends it whole). |
| From TemplatedComponentBase | ||||
TemplateKeyPropertySetTemplateKeyProperty | string | null | — | The name of the item field whose value selects a named template variant. Render-time only: the renderer and the runtime read it off the compiled state to pick a variant, so a binding would change nothing. |
FallbackTemplateKeySetFallbackTemplateKey | string | null | — | The fallback template key used when ITemplatedComponent.TemplateKeyProperty does not resolve to a template. |
Events
OnClickableItemTemplates(Action<IVisualComponent> register)- Writes a click registration on the item template, now and on every one set later.
OnItemClick(string command)- Registers a click command invoked when an item is clicked.
OnItemClick(string command, params KeyValuePair<string, UIActionArgument>[] arguments)- Registers a click command invoked when an item is clicked, with UI action arguments.
OnItemClick(ClientEffect effect)- Runs a client effect when any item is clicked — a menu's or a split button's entries inserting their own key with
InsertTextEffect.CurrentItemKey— with no round trip. OnItemClick(string key, ClientEffect effect)- Runs a client effect when the item whose key is
keyis clicked — a menu's Copy, a context menu's or an action bar's entry, a split button's — with no round trip; the other items keep the commandOnItemClickgave them.
The key is the item's, so a bound list's entries take it as a declared one's do; an effect aimed at the row the menu stands in (a message's text) finds it there. Only an effect an interaction may run is taken. Given twice for one key, both run. OnItemClickLiteral(string command, params KeyValuePair<string, object>[] arguments)- Registers a click command invoked when an item is clicked, with literal argument values.
OnItemClickWithItem(string command, string argumentName = "item")- Registers a click command that passes the clicked item as an argument.
OnItemClickWithItemKey(string command, string argumentName = "id")- Registers a click command that passes the clicked item's key as an argument.
OnItemClickWith(string command, string argumentName, UIActionArgumentKind argumentKind)- Registers a click command with an argument derived from the specified
argumentKind.
Methods
SetTemplate(IButtonComponent visualTemplate)- Sets the item template.
AddTemplateVariant(string key, IButtonComponent visualTemplate)- Adds or replaces a named template variant.
AddItemReads(params Expression<Func<TRow, object>>[] paths)- Names item paths the page reads off the rows beyond what the templates bind, so each row carries them.
AddItemReads(params string[] paths)- Names item paths the page reads off the rows beyond what the templates bind (a client engine reading
rows.itemOf), so each row carries them; dotted, as a binding's path. ReadsWholeItems()- Sends every row's item whole: something on the page reads it raw, past what the compile can see.
AddItem(IButtonModel item)- Adds an item to the component.
AddItems(IEnumerable<IButtonModel> items)- Adds items to the component.
FilterBy(UIProperty source, Expression<Func<TRow, object>> itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)- Adds a filter controlled by a local component property.
FilterBy(UIProperty source, string itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)- Adds a filter controlled by a local component property.
Defaults to a case-insensitive substring match; pass the operator explicitly where case matters. FilterBy(string sourceComponentId, UIProperty source, Expression<Func<TRow, object>> itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)- Adds a filter controlled by another component property.
FilterBy(string sourceComponentId, UIProperty source, string itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)- Adds a filter controlled by another component property.
FilterBy(UIPropertyReference source, Expression<Func<TRow, object>> itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)- Adds a filter controlled by a property reference.
FilterBy(UIPropertyReference source, string itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, UIComparisonOperator activeOperator = UIComparisonOperator.Required, object? activeValue = null)- Adds a filter controlled by a property reference.
FilterBy(Expression<Func<TRow, object>> itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, object? value = null)- Adds an unconditionally active filter with no source, comparing against a constant value.
FilterBy(string itemProperty, UIComparisonOperator operator = UIComparisonOperator.LikeIgnoreCase, object? value = null)- Adds an unconditionally active filter with no source, comparing against a constant value.
SortBy(UIProperty source, Expression<Func<TRow, object>> itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)- Adds a sort rule controlled by a local component property.
SortBy(UIProperty source, string itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)- Adds a sort rule controlled by a local component property.
SortBy(string sourceComponentId, UIProperty source, Expression<Func<TRow, object>> itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)- Adds a sort rule controlled by another component property.
SortBy(string sourceComponentId, UIProperty source, string itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)- Adds a sort rule controlled by another component property.
SortBy(UIPropertyReference source, Expression<Func<TRow, object>> itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)- Adds a sort rule controlled by a property reference.
SortBy(UIPropertyReference source, string itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, UIComparisonOperator activeOperator = UIComparisonOperator.Equal, object? activeValue = null, int priority = 0)- Adds a sort rule controlled by a property reference.
SortBy(Expression<Func<TRow, object>> itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, int priority = 0)- Adds an unconditionally active sort rule with no source.
SortBy(string itemProperty, UIItemsSortDirection direction = UIItemsSortDirection.Ascending, int priority = 0)- Adds an unconditionally active sort rule with no source.
SetEmptyTemplate(IVisualComponent visualTemplate)- Sets the template used when there are no items or no content.
ConfigureDefaultEmptyTemplate(Action<DefaultEmptyTemplate> configure)- Configures the built-in default empty template, putting it in where the host has none, and throwing if a different template has been set.
On demand on every host, so a menu or a key-value list that starts with none (an empty context menu says nothing) and a list that starts with one are worded alike. ConfigureTemplate(TTemplate? current, Action<TTemplate> configure, string what)- Configures
currentwhen it is aTTemplate, throwing when a different one was set.
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>? | Start | 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. |