Pane container
A container whose panes the viewer moves between their places.
PaneContainerComponent.Layout names the panes in the order of their places, as chat,tasks,tree. Bound, it comes back from the page for the application to keep per viewer, and a value the controller sets moves the panes; unbound, the browser keeps it under the container's authored id. A pane the value leaves out or does not know takes the first place left, in the order the panes were added. Columns, rows, spacing and splitters are a container's own.
new PaneContainerComponent("pane-container")
Properties
| Property | Type | Default | Binding | Description |
|---|---|---|---|---|
| Own | ||||
LayoutSetLayout · BindLayout | string | null | two-way | The panes' names in the order of their places, joined by commas; unset, each pane at the place it was added at. |
Places | IReadOnlyList<UIPanePlace> | null | — | The panes in the order they were added, each with the place it was added at. |
| From ContainerComponent | ||||
Columns | IReadOnlyList<UIResponsive<UIGridUnit>> | null | — | The grid column definitions, each optionally per breakpoint. |
Rows | IReadOnlyList<UIResponsive<UIGridUnit>> | null | — | The grid row definitions, each optionally per breakpoint. |
ScrollbarAirSetScrollbarAir · BindScrollbarAir | UIResponsive<double>? | null | one-way | The free air its parent leaves after the container's end, optionally per breakpoint, which the scroller along that end takes for its overlay bar: the scroller keeps no room for the bar inside, so its rows end where the container's other children do (a list under its search field), and the bar stands in the air. Unset, a scroller keeps its room inside. The air is taken up to the bar's room ( ContainerComponent.ScrollbarRoom); what it lacks stays inside. Taken by the outermost scroller reached through containers and stacks with no padding, border or fill of their own — a padded, framed or filled box between, or a scroller framed or filled itself, keeps the room inside — whose own end margin gives way to it; a screen where nothing hovers keeps no room. |
OverflowSetOverflow · BindOverflow | UIOverflow? | UIOverflow.Hidden | one-way | Whether content that overflows this component's bounds is clipped. |
SpacingSetSpacing · BindSpacing | UIResponsive<double>? | null | one-way | The 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. |
| From ContainerComponentBase | ||||
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. |
Methods
AddPane(string name, UIResponsive<UIGridPlacement> place, IVisualComponent content, bool keepsSize = false)- Adds a pane, named for the layout, at the cells of a place of its own; the order panes are added in is the order of their places.
A name is letters, digits,-and_, as a layout separates names by commas. WithkeepsSize, the pane keeps its size where it trades with a place lined up beside its own, with no splitter on that axis: a 280 px column moved to the other side of a wide one stays 280 px, the wide one taking what is left; elsewhere it takes the place's size. SetColumn(int index, UIGridUnit unit, UIGridUnit? sm = null, UIGridUnit? md = null, UIGridUnit? xl = null, UIGridUnit? xxl = null)- Sets a grid column definition, optionally per breakpoint (an auto column on a phone, a fixed one wider up).
indexis 1-based, matchingUIGridPlacement.Column. SetRow(int index, UIGridUnit unit, UIGridUnit? sm = null, UIGridUnit? md = null, UIGridUnit? xl = null, UIGridUnit? xxl = null)- Sets a grid row definition, optionally per breakpoint.
indexis 1-based, matchingUIGridPlacement.Row.
A container starts with one star row, soSetRow(1, …)sets it andContainerComponent.AddRowadds the second: a three-row container isSetRow(1, Auto).AddRow(Star).AddRow(Auto). AddRow(UIGridUnit unit, UIGridUnit? sm = null, UIGridUnit? md = null, UIGridUnit? xl = null, UIGridUnit? xxl = null)- Adds a grid row definition, optionally per breakpoint, after the ones there are — after the star row a container starts with, which
ContainerComponent.SetRowsets. AddChild(IVisualComponent child)- Adds a child component.
AddChildren(params IVisualComponent[] children)- Adds child components.
AddChildren(IEnumerable<IVisualComponent> children)- Adds child components.
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. |