NE.Standard

Items view

An items view that lays out a collection, held whole, virtualized or windowed from a source.

ItemsViewComponent · type key standard.items-view · Items · property blocks: IOrientationComponent, ISpacingComponent, IItemsHostComponent, IScrollableComponent, ISelectableItemsComponent, ISelectionStyleComponent, IRowHoverableComponent, IEmptyStateComponent, IDraggableRowsComponent, IDragSourceComponent, IAccessibleNameComponent

Row choice is two-way through SelectionMode; SelectionStyle says what a chosen row looks like. Unset, Spacing is the stylesheet's by the shape: none down a column or across a wrap, whose rows and tiles keep their own air, and a step between rows laid across, which would otherwise run their words together.

new ItemsViewComponent("items-view")

Properties

PropertyTypeDefaultBindingDescription
Own
LoadingLook
SetLoadingLook
UIItemsLoadingLook?UIItemsLoadingLook.Skeleton—What a windowed view shows while it reads rows it does not have yet: grey bars in the rows' shape, the default, or a small ring at the edge the rows come in at, for rows unlike each other — a conversation's messages.
Decided at render: it is how the view draws the rows it stands for, not a state.
LayoutType
SetLayoutType · BindLayoutType
UIResponsive<UIItemsLayoutType>?Stackone-wayThe layout algorithm used to arrange items, optionally per breakpoint: a stack on a phone, a wrap of tiles wider up.
Padding
SetPadding · BindPadding
UIResponsive<UIThickness>?nullone-wayThe room inside the view's scroll around its rows, optionally overridden per breakpoint: the rows scroll through it, so a list ending under something laid over its foot (a composer) shows its last row clear of it. A list held at its end stays there as the padding changes.
On the side the bar is drawn it is at least the overlay bar's room (--ui-scrollbar-room), whether the rows overflow or not, so a padding of 12 or more holds the thumb and a smaller one is widened; the classic bar's own strip stands past it while they do. A screen where nothing hovers (a touch screen) keeps none.
ContentMaxWidth
SetContentMaxWidth · BindContentMaxWidth
UIResponsive<double>?nullone-wayThe widest the rows' column stands inside the view, optionally overridden per breakpoint: wider, the column is centred and the view's own width stays the scroll's, so its bar stands at the region's edge rather than beside the words — a conversation's or a document's column in a wide pane. Unset, the rows take the view's width.
RowBleed
SetRowBleed · BindRowBleed
bool?falseone-wayWhether a vertical stack whose rows wear a hover or selection wash aligns its row content with the view's inline edges and bleeds those washes 8 px into the parent's padding on each side; use inside a container padded at least 8 px.
FirstVisibleKey
BindFirstVisibleKey
stringnulltwo-wayThe key of the row at the top of the view where the reader stands: the first row whose box shows below the scroll's top edge, past the view's ItemsViewComponent.Padding and a group header held over it. Written by the page once the reader's scroll settles, once after the first layout, and again as the rows under the top change; follow it in the bound property's setter.
Bound one way, from the page: a value the controller sets scrolls nothing and is not sent. Unbound, the page reports nothing. A windowed view reports a row of the window it holds; while only rows still on their way stand in view, it reports nothing.
LastVisibleKey
BindLastVisibleKey
stringnulltwo-wayThe key of the row at the foot of the view where the reader stands: the last row whose box shows above the scroll's bottom edge, past the view's ItemsViewComponent.Padding (room a composer laid over the list's foot stands in). Written as ItemsViewComponent.FirstVisibleKey is: once the reader's scroll settles, once after the first layout, and again as the rows change.
Bound one way, from the page: a value the controller sets scrolls nothing and is not sent. Unbound, the page reports nothing. A windowed view reports a row of the window it holds; while only rows still on their way stand in view, it reports nothing.
Orientation
SetOrientation · BindOrientation
UIResponsive<UIOrientation>?Verticalone-wayWhich way the component runs, optionally per breakpoint (a column on a phone, a row wider up); vertical unless the component says otherwise.
Spacing
SetSpacing · BindSpacing
UIResponsive<double>?nullone-wayThe gap between the component's children or entries, optionally overridden per breakpoint.
Unset, the stylesheet's own gap for the component applies, which may depend on its shape.
HostModeUIItemsHostMode?UIItemsHostMode.Plain—How the host holds its rows. Set by Virtualized() or by binding a source, never directly.
WindowSize
SetWindowSize
int?50—How many items one window holds.
Paging
SetPaging · BindPaging
bool?falseone-wayWhether a windowed host shows its window as a page of IItemsHostComponent.WindowSize rows: the scroll asks for no window, and a pager aimed at the host, or Page Up and Page Down in it, asks for another by offset. A host holding its rows whole has nothing to page.
WindowOffsetint?null—Where the realized window starts, as the source last reported it. This and the three below are bound by the compiler only; binding one by hand is refused.
WindowTotalCountint?null—How many items the source holds, as it last reported.
WindowHasMoreBeforebool?false—Whether the source has items before the realized window.
WindowHasMoreAfterbool?false—Whether the source has items after the realized window.
WindowGroupBeforestringnull—The group of the item just before the realized window, as the source last reported it; bound by the compiler only.
WindowAggregatesIReadOnlyDictionary<string, object>null—What the source computed over every item the query leaves, by item property, as it last reported; bound by the compiler only.
HorizontalScroll
SetHorizontalScroll · BindHorizontalScroll
UIScrollMode?UIScrollMode.Disabledone-wayWhether the viewport scrolls horizontally — Disabled, Auto, or Always; default Disabled.
VerticalScroll
SetVerticalScroll · BindVerticalScroll
UIScrollMode?UIScrollMode.Autoone-wayWhether the viewport scrolls vertically — Disabled, Auto, or Always; default Auto.
ScrollSnap
SetScrollSnap · BindScrollSnap
UIScrollSnapMode?UIScrollSnapMode.Disabledone-wayWhether a scroll comes to rest on a child's edge rather than wherever it was let go.
ScrollAnchor
SetScrollAnchor · BindScrollAnchor
UIScrollAnchor?UIScrollAnchor.Noneone-wayHow the viewport reacts when its content grows.
Applies to the component's own scrolling element, reaching a windowed host a wrapping ScrollContainer could not.
ScrollFade
SetScrollFade · BindScrollFade
bool?falseone-wayWhether the viewport softly fades its top and bottom edges while content is scrolled beneath them; default false.
SelectionMode
SetSelectionMode · BindSelectionMode
UISelectionMode?UISelectionMode.Noneone-wayHow many rows may be chosen at once.
SelectedKeys
SetSelectedKeys · BindSelectedKeys
IReadOnlyList<string>nulltwo-wayThe keys of the chosen rows under UISelectionMode.Many, in the order they were chosen.
SelectedKey
SetSelectedKey · BindSelectedKey
stringnulltwo-wayThe 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.
SelectionStyle
SetSelectionStyle · BindSelectionStyle
UISelectionStyle?nullone-wayWhat a chosen item looks like. Unset, and every unset part of it, is the control's own default.
RowHoverable
SetRowHoverable · BindRowHoverable
bool?falseone-wayWhether rows highlight under the pointer; off by default unless the host turns it on for itself.
ShowEmptyTemplate
SetShowEmptyTemplate · BindShowEmptyTemplate
bool?trueone-wayWhether the empty template is drawn while the host holds nothing; on by default.
DragHandle
SetDragHandle · BindDragHandle
bool?falseone-wayWhether a IDraggableItemsComponent.Draggable row is dragged only by its grip (IDraggableRowsComponent.DragHandlePlacement); the rest of the row keeps its text selection and its presses, and the keyboard still moves rows by Alt+Up and Alt+Down. A table draws the grips in a narrow track of their own; a wrapped items view draws none, and its tiles drag whole.
DragHandlePlacement
SetDragHandlePlacement · BindDragHandlePlacement
UIDragHandlePlacement?UIDragHandlePlacement.Endone-wayWhere a row's grip stands (IDraggableRowsComponent.DragHandle): at its end by default, or at its start — in a table, the grips' track past the last column or before the first, pinned with it where the first column is pinned.
Draggable
SetDraggable · BindDraggable
bool?falseone-wayWhether 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.
DragKind
SetDragKind
stringnull—The kind the host's items are offered as, dragged or cut out of it — lower-case letters, digits and hyphens — or null for none. A tree's folder goes with what it holds.
DragEffects
SetDragEffects
UIDragEffects?UIDragEffects.All—What a drop may do with the items: move them out of the host, copy them, or either, the drop deciding.
AccessibleName
SetAccessibleName · BindAccessibleName
UIPhrasenullone-wayThe 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
Items
SetItems · BindItems
IReadOnlyList<object>nullone-wayThe component items.
ItemsView
BindItemsView
UIItemsViewnullone-wayFiltering and sorting rules applied to the items collection.
Query
SetQuery · BindQuery
UIItemsQuerynulltwo-wayThe 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.
ItemReadsUIItemReadsnull—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
TemplateKeyProperty
SetTemplateKeyProperty
stringnull—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.
FallbackTemplateKey
SetFallbackTemplateKey
stringnull—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.
OnOpenableItemTemplates(Action<IVisualComponent> register)
Writes an open registration on the item template — Enter on the keyboard's item, or a double click —, now and on every one set later.
OnMovableItemTemplates(Action<IVisualComponent> register)
Writes a move registration on the item template, now and on every one set later: a row dropped at another place among the rows by a drag with Draggable on, or Alt+Up and Alt+Down.
The row stands there at once; the controller's Move of it keeps it there or puts it where the controller did, and an answer without one puts it back. The index is where RecursiveCollection.Move puts it; in a windowed host, its place in the source's whole query.
OnRemovableItemTemplates(Action<IVisualComponent> register)
Writes a remove registration on the item template — the Delete key on an item that may be removed —, 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 key is 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 command OnItemClick gave 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.
OnItemMove(string command)
Registers a command invoked when an item is moved to another place — a drag with Draggable on, or Alt with an arrow.
OnItemMove(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Registers a command invoked when an item is moved to another place, with UI action arguments.
The controller moves the item, keeps it where the page put it, or refuses by doing nothing.
OnItemMoveLiteral(string command, params KeyValuePair<string, object>[] arguments)
Registers a command invoked when an item is moved to another place, with literal argument values.
OnItemMoveWithItem(string command, string argumentName = "item", string indexArgumentName = "index")
Registers a command invoked when an item is moved to another place, passing the item and the index it takes.
OnItemMoveWithItemKey(string command, string keyArgumentName = "id", string indexArgumentName = "index")
Registers a command invoked when an item is moved to another place, passing the item's key and the index it takes.
OnItemMoveWith(string command, string argumentName, UIActionArgumentKind argumentKind, string indexArgumentName = "index")
Registers a command invoked when an item is moved to another place, passing an argument derived from the specified argumentKind and the index it takes.
OnItemOpen(string command)
Registers a command invoked when an item is opened — Enter on the keyboard's row, or a double click.
OnItemOpen(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Registers a command invoked when an item is opened, with UI action arguments.
OnItemOpenLiteral(string command, params KeyValuePair<string, object>[] arguments)
Registers a command invoked when an item is opened, with literal argument values.
OnItemOpenWithItem(string command, string argumentName = "item")
Registers a command invoked when an item is opened, passing the item as an argument.
OnItemOpenWithItemKey(string command, string argumentName = "id")
Registers a command invoked when an item is opened, passing the item's key as an argument.
OnItemOpenWith(string command, string argumentName, UIActionArgumentKind argumentKind)
Registers a command invoked when an item is opened, with an argument derived from the specified argumentKind.
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.

Methods

Virtualized()
Keeps only the rows in view in the document, for a collection the client holds whole.
BindSource(string path, UIBindingScope scope = UIBindingScope.Root)
Binds the view's items to a windowed source on the controller.
The path names the source; the compiler appends the property holding its realized window.
BindSource(Expression<Func<TSource, object>> path, UIBindingScope scope = UIBindingScope.Root)
Binds the view's items to a windowed source on the controller.
The path names the source; the compiler appends the property holding its realized window.
ConfigureDefaultTemplate(Action<DefaultTextTemplate> configure)
Configures the built-in default text template, throwing if a different template has been set.
ConfigureDefaultGroupTemplate(Action<DefaultGroupTemplate> configure)
Configures the built-in default group template, throwing if a different template has been set.
SetGroupTemplate(IVisualComponent template)
Sets the template used to render item groups.
SetTemplate(IVisualComponent visualTemplate)
Sets the item template.
AddTemplateVariant(string key, IVisualComponent 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(object item)
Adds an item to the component.
AddItems(IEnumerable<object> 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 current when it is a TTemplate, throwing when a different one was set.
AnchorToEnd()
Follows content appended at the end while the viewer is already at the end.
DisableScroll()
Disables both horizontal and vertical scrolling.
VerticalScrollOnly()
Enables vertical scrolling only.
HorizontalScrollOnly()
Enables horizontal scrolling only.
BothScroll()
Enables both horizontal and vertical scrolling.
SetScroll(UIScrollMode horizontalScroll, UIScrollMode verticalScroll)
Sets the horizontal and vertical scroll behaviors.
Common properties (23) — layout, visibility, theme, and the rest every component shares
PropertyTypeDefaultBindingDescription
Visibility
SetVisibility · BindVisibility
UIResponsive<UIVisibility>?Visibleone-wayWhat 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.
Enabled
SetEnabled · BindEnabled
bool?trueone-wayWhether 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.
Theme
SetTheme · BindTheme
UIThemeMode?nullone-wayThe theme mode forced on this component's subtree, or null to inherit the ambient theme.
HorizontalAlignment
SetHorizontalAlignment · BindHorizontalAlignment
UIResponsive<UIAlignment>?Stretchone-wayWhere the component sits within its grid cell along the horizontal axis, optionally overridden per breakpoint.
VerticalAlignment
SetVerticalAlignment · BindVerticalAlignment
UIResponsive<UIAlignment>?Stretchone-wayWhere the component sits within its grid cell along the vertical axis, optionally overridden per breakpoint.
Width
SetWidth · BindWidth
UIResponsive<UILayoutLength>?nullone-wayThe component width, optionally overridden per breakpoint.
MinWidth
SetMinWidth · BindMinWidth
UIResponsive<UILayoutLength>?nullone-wayThe component minimum width, optionally overridden per breakpoint.
MaxWidth
SetMaxWidth · BindMaxWidth
UIResponsive<UILayoutLength>?nullone-wayThe component maximum width, optionally overridden per breakpoint.
Height
SetHeight · BindHeight
UIResponsive<UILayoutLength>?nullone-wayThe component height, optionally overridden per breakpoint.
MinHeight
SetMinHeight · BindMinHeight
UIResponsive<UILayoutLength>?nullone-wayThe component minimum height, optionally overridden per breakpoint.
MaxHeight
SetMaxHeight · BindMaxHeight
UIResponsive<UILayoutLength>?nullone-wayThe component maximum height, optionally overridden per breakpoint.
ZIndex
SetZIndex · BindZIndex
int?0one-wayThe stacking order within the visual tree.
Margin
SetMargin · BindMargin
UIResponsive<UIThickness>?nullone-wayThe outer spacing around the component, optionally overridden per breakpoint.
Placement
SetPlacement · BindPlacement
UIResponsive<UIGridPlacement>?nullone-wayThe grid placement, optionally overridden per breakpoint.
AlignWithFieldBoxes
SetAlignWithFieldBoxes
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.
Loading
SetLoading · BindLoading
bool?falseone-wayWhether 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.
LoadingStyle
SetLoadingStyle · BindLoadingStyle
UILoadingStyle?nullone-wayThe visual indicator shown while this component or spinner is loading, or null to inherit the ambient or theme loading style.
ShowContextMenu
SetShowContextMenu · BindShowContextMenu
bool?trueone-wayWhether 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.
ActionBar
SetActionBar
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.
ActionBarRepeatInMore
SetActionBarRepeatInMore
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.
ScrollGroup
SetScrollGroup · BindScrollGroup
stringnullone-wayThe 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.
TextSelectable
SetTextSelectable · BindTextSelectable
bool?nullone-wayWhether 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.
WindowFoot
SetWindowFoot
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.