Default breadcrumb item template

The built-in template rendering an IBreadcrumbItemModel as one step of a trail.

DefaultBreadcrumbItemTemplate · type key standard.default.breadcrumb-item.template · Templates

new DefaultBreadcrumbItemTemplate("default-breadcrumb-item-template")

Properties

Property	Type	Default	Binding	Description
From BreadcrumbItemComponent
`Url` SetUrl · BindUrl	`string`	`null`	one-way	The destination this step leads back to. translatable
From ButtonComponent
`Type` SetType · BindType	`UIButtonType?`	`UIButtonType.Primary`	one-way	The button's visual variant — Primary, Accent, Danger, Outline, Ghost, Link, or Surface.
`IconColor` SetIconColor · BindIconColor	`UIThemeColor?`	`Default`	one-way	The leading icon's colour, defaulting to `ITextBaseModel.DefaultIconColor`. `Default` resolves to `color: inherit`, so the glyph follows the button's contrast colour.
`TitleType` SetTitleType · BindTitleType	`UITextAppearance?`	`Body`	one-way	The primary text type.
`BadgePlacement` SetBadgePlacement · BindBadgePlacement	`UITextBadgePlacement?`	`UITextBadgePlacement.Trailing`	one-way	Where badge content is placed.
`Selectable` SetSelectable · BindSelectable	`bool?`	`false`	one-way	Whether the text can be selected with the pointer; content says yes, a control's caption says no. A button's label is a control's caption, not content: a press must not start a selection.
`DescriptionType` SetDescriptionType · BindDescriptionType	`UITextAppearance?`	`Caption`	one-way	The secondary text type.
`TextAlignment` SetTextAlignment · BindTextAlignment	`UITextAlignment?`	`UITextAlignment.Center`	one-way	How the title and description align within their box — Start, Center, End, or Justify; default Start. A button's label sits in the middle of the button, however wide it is stretched; a row-shaped control that wears the button (an action, a menu entry, a breadcrumb) puts its label at the start in its own constructor.
`Size` SetSize · BindSize	`UIButtonSize?`	`UIButtonSize.Medium`	one-way	How much room the button takes.
`SubmitFormId` SetSubmitFormId · BindSubmitFormId	`string`	`null`	one-way	The id of the form this button submits, scoping the Submit-trigger validation that runs before the click command.
`Background` SetBackground · BindBackground	`UIThemeColor?`	`null`	one-way	The surface's background colour; unset leaves whatever the theme paints underneath.
`Padding` SetPadding · BindPadding	`UIResponsive<UIThickness>?`	`null`	one-way	The inner spacing between this component's edges and its content, optionally overridden per breakpoint.
`BackgroundImage` SetBackgroundImage · BindBackgroundImage	`string`	`null`	one-way	The picture painted over the background colour, centred and never repeated: a URL or a data URI.
`BackgroundImageFit` SetBackgroundImageFit · BindBackgroundImageFit	`UIImageFit?`	`UIImageFit.Cover`	one-way	How the picture fills the surface.
`BorderColor` SetBorderColor · BindBorderColor	`UIThemeColor?`	`null`	one-way	The border's colour, written as CSS `border-color`; unset leaves the stylesheet's own.
`BorderThickness` SetBorderThickness · BindBorderThickness	`UIThickness?`	`null`	one-way	The border's thickness, written as CSS `border-width`; unset leaves the stylesheet's own.
`BorderRadius` SetBorderRadius · BindBorderRadius	`UICornerRadius?`	`null`	one-way	The corner rounding, written as CSS `border-radius`; unset leaves the stylesheet's own.
`Overflow` SetOverflow · BindOverflow	`UIOverflow?`	`UIOverflow.Hidden`	one-way	Whether content that overflows this component's bounds is clipped.
`Description` SetDescription · BindDescription	`string`	`null`	one-way	The secondary text. translatable
`DescriptionColor` SetDescriptionColor · BindDescriptionColor	`UIThemeColor?`	`Muted`	one-way	The secondary text color.
`Icon` SetIcon · BindIcon	`string`	`null`	one-way	The icon shown before the title, by name from the registered icon font/set. translatable
`IconSize` SetIconSize · BindIconSize	`UIIconSize?`	`null`	one-way	The leading icon size; left unset the glyph is as tall as the title beside it.
`Title` SetTitle · BindTitle	`string`	`null`	one-way	The label text drawn as the title; nothing renders when it is unset. translatable
`TitleColor` SetTitleColor · 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`.
`BadgeStyle` SetBadgeStyle · BindBadgeStyle	`UIBadgeType?`	`UIBadgeType.Info`	one-way	The badge visual variant.
`BadgeColor` SetBadgeColor · 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.
`BadgeIcon` SetBadgeIcon · BindBadgeIcon	`string`	`null`	one-way	The icon shown beside the badge text, by name from the registered icon font/set. translatable
`BadgeIconColor` SetBadgeIconColor · BindBadgeIconColor	`UIThemeColor?`	`Default`	one-way	The badge icon's colour, defaulting to `IBadgeModel.DefaultBadgeIconColor`.
`BadgeIconSize` SetBadgeIconSize · BindBadgeIconSize	`UIIconSize?`	`null`	one-way	The badge icon size. Left unset the glyph is as tall as the badge's own text.
`BadgeText` SetBadgeText · BindBadgeText	`string`	`null`	one-way	The short text drawn inside the badge, beside its icon. translatable
`BadgeTextType` SetBadgeTextType · BindBadgeTextType	`UITextAppearance?`	`Overline`	one-way	The badge text's role, defaulting to `IBadgeModel.DefaultBadgeTextType`.
`BadgeTooltip` SetBadgeTooltip · BindBadgeTooltip	`string`	`null`	one-way	The tooltip for the badge content. translatable
`BadgeTooltipPlacement` SetBadgeTooltipPlacement · BindBadgeTooltipPlacement	`UIPopupPlacement?`	`UIPopupPlacement.Top`	one-way	The side the badge's own tooltip prefers, placed against the badge rather than against the row.
`Tooltip` SetTooltip · 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
`TooltipPlacement` SetTooltipPlacement · BindTooltipPlacement	`UIPopupPlacement?`	`UIPopupPlacement.Top`	one-way	The side the tooltip prefers; flips to the opposite side when there is no room for it there.
`IconAlignment` SetIconAlignment	`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.
`BadgeAlignment` SetBadgeAlignment	`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.

Events

OnClickShowingLoading(string command): Runs the command on a click and shows the button waiting for exactly the round trip: two client interactions on Loading, one before the dispatch and one after the result, nothing bound and nothing for a controller to clear.
Named for what it shows, not for what it carries: With elsewhere in this API names an argument the command receives (OnItemClickWithItem), and nothing is passed here.
OnClick(string command): Registers a click handler that invokes the specified command.
OnClick(string command, params KeyValuePair<string, UIActionArgument>[] arguments): Registers a click handler that invokes the specified command with UI action arguments.
OnClickLiteral(string command, params KeyValuePair<string, object>[] arguments): Registers a click handler that invokes the specified command with literal argument values.
OnSubmit(string formId, string command): Registers a click command that first runs Submit-trigger validation for every input sharing formId, dispatching the command only if all of them pass.
OnSubmit(string formId, string command, params KeyValuePair<string, UIActionArgument>[] arguments): Registers a click command that first runs Submit-trigger validation for every input sharing formId, dispatching the command only if all of them pass.
OnSubmitLiteral(string formId, string command, params KeyValuePair<string, object>[] arguments): Registers a click command that first runs Submit-trigger validation for every input sharing formId, dispatching the command only if all of them pass.

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.