Tabs view
A strip of captions over pages that come from a collection.
The strip is sorted on ITabItemModel.Order, so the collection's own order never changes for a drag to stick. A right press on a caption opens TabsViewComponent.TabMenu — the built-in entries TabsViewComponent.TabMenuEntries chose and the application's own — unless the tab template carries a context menu of its own, which then replaces it. A Draggable strip reorders by its captions, the server writing the orders.
new TabsViewComponent("tabs-view")
Properties
| Property | Type | Default | Binding | Description |
|---|---|---|---|---|
| Own | ||||
TabMenuEntriesSetTabMenuEntries · BindTabMenuEntries | UITabMenuEntries? | UITabMenuEntries.None | one-way | The built-in entries the tab menu offers, none by default. Assigning it directly skips the refusal of Close and Delete together that TabsViewComponent.SetTabMenuEntries applies. Pin sets the tab's ITabItemModel.Pinned and moves it to the boundary of the pinned tabs, written back as a drag writes its order. The remove entry raises what the tab's cross does, so it needs OnItemRemoveWithItemKey and is never offered on a pinned tab. |
ShowOverflowSetShowOverflow · BindShowOverflow | bool? | true | one-way | Whether the captions past the strip's room go behind a "…" list; off, the strip wraps them onto the next line. |
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. |
ShowEmptyTemplateSetShowEmptyTemplate · BindShowEmptyTemplate | bool? | true | one-way | Whether the empty template is drawn while the host holds nothing; on by 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. |
RemovableSetRemovable · BindRemovable | bool? | true | one-way | Whether the host's own gesture removes an item at all — a tree's Delete key, a tab's close; off, no tab shows a close and the strip reserves no room for one. An item refuses it alone with CanRemove. |
DraggableSetDraggable · BindDraggable | bool? | false | one-way | Whether an item that does not refuse it (CanDrag) can be dragged to another place, or moved one place by Alt with an arrow; the move raises move, and the server refuses the move of an item that says CanDrag false. |
RenamableSetRenamable · BindRenamable | bool? | false | one-way | Whether the component's or host's own gesture renames a title in place — F2 or double click; in a host, an item that says CanRename false keeps its title, while a rename the application asks for (RenameItemEffect, a menu's entry) opens the field either way. |
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 |
| From ItemsComponentBase | ||||
ItemsSetItems · BindItems | IReadOnlyList<ITabItemModel> | 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
OnItemMenuEntry(string command, string entryArgumentName = "entry", string tabArgumentName = "id")- Registers a command invoked when an entry
TabsViewComponent.AddTabMenuEntriesappended is clicked, passing the entry's key and the key of the tab the menu was opened on.
The built-in entries never reach it. OnItemMenuEntry(string command, params KeyValuePair<string, UIActionArgument>[] arguments)- Registers a command invoked when an appended tab menu entry is clicked, with UI action arguments —
UITabMenu.EntryandUITabMenu.Tabname its two keys.
Raised on the tab the menu was opened on, as its own events are, so the tab's state and abilities answer for it. OnItemMenuEntryLiteral(string command, params KeyValuePair<string, object>[] arguments)- Registers a command invoked when an appended tab menu entry is clicked, with literal argument values — neither key, for an entry the command needs no name of.
OnRemovableItemTemplates(Action<IVisualComponent> register)- Writes a remove registration on the tab template, now and on every one set later: a tab's close pressed, or the tab menu's remove entry; the controller removes the tab or leaves it.
OnRenamableItemTemplates(Action<IVisualComponent> register)- Writes a rename registration on the tab template, now and on every one set later: a caption renamed in place.
OnItemRemove(string command)- Registers a command invoked when an item is asked to be removed — the Delete key on a row that may be removed, or a tab's close.
OnItemRemove(string command, params KeyValuePair<string, UIActionArgument>[] arguments)- Registers a command invoked when an item is asked to be removed, with UI action arguments.
The controller removes the item or leaves it; a chosen group under the cursor raises it once per item. OnItemRemoveLiteral(string command, params KeyValuePair<string, object>[] arguments)- Registers a command invoked when an item is asked to be removed, with literal argument values.
OnItemRemoveWithItem(string command, string argumentName = "item")- Registers a command invoked when an item is asked to be removed, passing the item as an argument.
OnItemRemoveWithItemKey(string command, string argumentName = "id")- Registers a command invoked when an item is asked to be removed, passing the item's key as an argument.
OnItemRemoveWith(string command, string argumentName, UIActionArgumentKind argumentKind)- Registers a command invoked when an item is asked to be removed, with an argument derived from the specified
argumentKind. OnItemRename(string command)- Registers a command invoked after a rename in place wrote the item's new title back.
OnItemRename(string command, params KeyValuePair<string, UIActionArgument>[] arguments)- Registers a command invoked after a rename in place wrote the item's new title back, with UI action arguments.
Optional: the two-way title already carries the new text; this is for refusing or normalizing it. OnItemRenameLiteral(string command, params KeyValuePair<string, object>[] arguments)- Registers a command invoked after a rename in place wrote the item's new title back, with literal argument values.
OnItemRenameWithItem(string command, string argumentName = "item")- Registers a command invoked after a rename in place wrote the item's new title back, passing the item as an argument.
OnItemRenameWithItemKey(string command, string argumentName = "id")- Registers a command invoked after a rename in place wrote the item's new title back, passing the item's key as an argument.
OnItemRenameWith(string command, string argumentName, UIActionArgumentKind argumentKind)- Registers a command invoked after a rename in place wrote the item's new title back, with an argument derived from the specified
argumentKind.
Methods
AddTabMenuEntries(params MenuItem[] entries)- Adds entries to the tab menu, between Pin and the remove entry with a rule on either side.
A click on one raisesTabsViewComponent.OnItemMenuEntry's command with the entry's key and the tab's. SetPageTemplate(IVisualComponent page)- Sets the page rendered for every tab, leaving the built-in caption in place.
SetTemplate(ITabItemComponent visualTemplate)- Sets the item template.
AddTemplateVariant(string key, ITabItemComponent 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(ITabItemModel item)- Adds an item to the component.
AddItems(IEnumerable<ITabItemModel> 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>? | Stretch | one-way | Where the component sits within its grid cell along the horizontal axis, optionally overridden per breakpoint. |
VerticalAlignmentSetVerticalAlignment · BindVerticalAlignment | UIResponsive<UIAlignment>? | Stretch | 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. |