Skip to content

SiBreadcrumbComponent documentation

selector
si-breadcrumb

Input Properties

NameTypeDefaultDescription
ariaLabel
TranslatableString$localize`:@@SI_BREADCRUMB:Breadcrumbs`Aria label for the main breadcrumb navigation. Needed for a11y.
items
Required
BreadcrumbItem[]Array of breadcrumb items.
showRootAsText
booleanfalseShows the "root" route as the provided title string instead of an icon.

Types Documentation

Represents a translatable string. This can either be a translation key, e.g. ACTIONS.EDIT that will be automatically translated when displayed on the UI or a pre-translated string, e.g. Edit . Equivalent to a normal string in usage and functionality.
Item that should be displayed in a breadcrumb. As input, we expect an optional title and link, which can be an URL or array of URL segments.
Properties
A function that will be invoked when clicking on the menu item. When passed as a string, use together with SiLinkActionService to receive events. This is meant for repetitive things in lists/tables/etc.
action?: (string | (param: any) => any) from action
A boolean that lets the link know whether it is disabled or not.
disabled?: boolean from disabled
Defines a href URI that the menu item will be linked to. Will be used to set the href attribute of the a element. Will only be used if link and function is not set.
href?: string from href
A boolean that lets the link know whether it is active or not. It is useful when action() is executed instead of link route.
isActive?: boolean from isActive
The navigation extras provide additional routing options when using the router link.
navigationExtras?: NavigationExtras from navigationExtras
The target attribute specifies where to open the linked document. If no target is specified, the link will open in the current tab.
target?: string from target
The title of the menu item. Can be either the title to be displayed or the translation key.
title: string
The optional tooltip of the link. Can be either the text to be displayed or the translation key.
tooltip?: TranslatableString from tooltip
Translatable
import

Except where otherwise noted, content on this site is licensed under MIT License.