Tab item

One tab of a TabsViewComponent.

TabItemComponent · type key standard.tab-item · Navigation · property blocks: IItemAbilitiesComponent

Not a ButtonComponent: the caption carries a close button, and a button inside a button is invalid markup.

new TabItemComponent("tab-item")

Properties

Property	Type	Default	Binding	Description
`RenamedTitle` SetRenamedTitle · BindRenamedTitle	`string`	`null`	two-way	The caption as a rename wrote it back; the caption region itself draws the title.
`Order` SetOrder · BindOrder	`double?`	`null`	two-way	Where this tab sits in the strip, ascending. Two-way: a drag writes the dropped tab's new position back, so reordering changes the item, not the collection.
`Pinned` SetPinned · BindPinned	`bool?`	`false`	one-way	Whether the tab is pinned: drawn with a pin, without its close control, and left where it is by a drag. Whether a close from elsewhere is refused is the controller's answer.
`CanSelect` SetCanSelect · BindCanSelect	`bool?`	`null`	one-way	Whether the row may be chosen; unset means it may.
`CanDrag` SetCanDrag · BindCanDrag	`bool?`	`null`	one-way	Whether the row may be dragged, where its host drags at all; unset means it may.
`CanRemove` SetCanRemove · BindCanRemove	`bool?`	`null`	one-way	Whether the row may be removed by the host's own gesture; unset means it may.
`CanRename` SetCanRename · BindCanRename	`bool?`	`null`	one-way	Whether the row may be renamed in place, where its host renames at all; unset means it may.
`CanShowContextMenu` SetCanShowContextMenu · BindCanShowContextMenu	`bool?`	`null`	one-way	Whether a right-click on the row opens the menu its template carries; unset means it does.

Events

OnRemove(string command, params KeyValuePair<string, UIActionArgument>[] arguments): Registers a command invoked when this tab's close is pressed; the controller removes the tab or leaves it.
OnRename(string command, params KeyValuePair<string, UIActionArgument>[] arguments): Registers a command invoked when this tab's caption is renamed in place.

Methods

ConfigureDefaultCaption(Action<TabCaptionRegion> configure): Configures the built-in caption region.
SetPage(IVisualComponent page): Sets the page this tab opens.

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.