Expander header region
The built-in header region rendering an expander's title, description and badge.
new ExpanderHeaderRegion("expander-header-region")
Properties
| Property | Type | Default | Binding | Description |
|---|---|---|---|---|
| From TextComponent | ||||
IconAlignmentSetIconAlignment | UITextIconAlignment? | UITextIconAlignment.Content | — | Where the leading icon sits against the text beside it: Content (the default) centres it across title and description, while Title keeps it on the title's own line. |
BadgeAlignmentSetBadgeAlignment | UITextBadgeAlignment? | UITextBadgeAlignment.Title | — | Where a trailing badge sits against the text beside it: Title (the default) keeps it at the far end of the title's own line, while Content centres it against title and description. |
| From TextComponentBase | ||||
DescriptionSetDescription · BindDescription | string | null | one-way | The secondary text. translatable |
DescriptionTypeSetDescriptionType · BindDescriptionType | UITextAppearance? | Body | one-way | The secondary text type. |
DescriptionColorSetDescriptionColor · BindDescriptionColor | UIThemeColor? | Muted | one-way | The secondary text color. |
TextAlignmentSetTextAlignment · BindTextAlignment | UITextAlignment? | UITextAlignment.Start | one-way | How the title and description align within their box — Start, Center, End, or Justify; default Start. |
IconSetIcon · BindIcon | string | null | one-way | The icon shown before the title, by name from the registered icon font/set. translatable |
IconColorSetIconColor · BindIconColor | UIThemeColor? | Default | one-way | The leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor. |
IconSizeSetIconSize · BindIconSize | UIIconSize? | null | one-way | The leading icon size; left unset the glyph is as tall as the title beside it. |
TitleSetTitle · BindTitle | string | null | one-way | The label text drawn as the title; nothing renders when it is unset. translatable |
TitleTypeSetTitleType · BindTitleType | UITextAppearance? | Title | one-way | The primary text type. |
TitleColorSetTitleColor · BindTitleColor | UIThemeColor? | Default | one-way | The primary text colour, which also colours the icon and the description unless either is overridden by ITextModel.DescriptionColor or IconColor. |
SelectableSetSelectable · BindSelectable | bool? | true | one-way | Whether the text can be selected with the pointer; content says yes, a control's caption says no. |
BadgePlacementSetBadgePlacement · BindBadgePlacement | UITextBadgePlacement? | UITextBadgePlacement.Inline | one-way | Where badge content is placed. |
BadgeStyleSetBadgeStyle · BindBadgeStyle | UIBadgeType? | UIBadgeType.Info | one-way | The badge visual variant. |
BadgeColorSetBadgeColor · BindBadgeColor | UIThemeColor? | null | one-way | The badge's own colour, overriding IBadgeModel.BadgeStyle when set — a tag or a category swatch, which the closed style enum cannot name. |
BadgeIconSetBadgeIcon · BindBadgeIcon | string | null | one-way | The icon shown beside the badge text, by name from the registered icon font/set. translatable |
BadgeIconColorSetBadgeIconColor · BindBadgeIconColor | UIThemeColor? | Default | one-way | The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor. |
BadgeIconSizeSetBadgeIconSize · BindBadgeIconSize | UIIconSize? | null | one-way | The badge icon size. Left unset the glyph is as tall as the badge's own text. |
BadgeTextSetBadgeText · BindBadgeText | string | null | one-way | The short text drawn inside the badge, beside its icon. translatable |
BadgeTextTypeSetBadgeTextType · BindBadgeTextType | UITextAppearance? | Overline | one-way | The badge text's role, defaulting to IBadgeModel.DefaultBadgeTextType. |
BadgeTooltipSetBadgeTooltip · BindBadgeTooltip | string | null | one-way | The tooltip for the badge content. translatable |
BadgeTooltipPlacementSetBadgeTooltipPlacement · BindBadgeTooltipPlacement | UIPopupPlacement? | UIPopupPlacement.Top | one-way | The side the badge's own tooltip prefers, placed against the badge rather than against the row. |
TooltipSetTooltip · BindTooltip | string | null | one-way | The tooltip shown on hover and on focus. On a button-shaped control with no title of its own — an icon button — it is also the name a screen reader gets. translatable |
TooltipPlacementSetTooltipPlacement · BindTooltipPlacement | UIPopupPlacement? | UIPopupPlacement.Top | one-way | The side the tooltip prefers; flips to the opposite side when there is no room for it there. |
Common properties (16) — 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). |
EnabledSetEnabled · BindEnabled | bool? | true | one-way | Whether the component responds to input; false dims it and marks it, and its subtree, inert. |
ThemeSetTheme · BindTheme | UIThemeMode? | null | one-way | The theme mode forced on this component's subtree, or null to inherit the ambient theme. |
HorizontalAlignmentSetHorizontalAlignment · BindHorizontalAlignment | UIAlignment? | UIAlignment.Stretch | one-way | Where the component sits within its grid cell along the horizontal axis. |
VerticalAlignmentSetVerticalAlignment · BindVerticalAlignment | UIAlignment? | UIAlignment.Stretch | one-way | Where the component sits within its grid cell along the vertical axis. |
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. |
LoadingSetLoading · BindLoading | bool? | false | one-way | Whether the component is in loading state — a live state a controller turns on and off. |
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. |