Skip to content

EnumeratedBreadcrumbItem Type documentation

extends BreadcrumbItem
Extends EnumeratedBreadcrumbItem and adds the level, if it is shortened, a shortened title and if it is the last item
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
Whether it is the last breadcrumb item and should be styled differently.
lastItem?: boolean
The current level relative to the root, the root is 0
level: number
The navigation extras provide additional routing options when using the router link.
navigationExtras?: NavigationExtras from navigationExtras
Whether the title is displayed in full length or it is shortened.
shortened?: boolean
The shortened title, if the title is not shortened, it is the same as the title.
shortenedTitle?: string
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 from title
The optional tooltip of the link. Can be either the text to be displayed or the translation key.
tooltip?: TranslatableString from tooltip

Types Documentation

extends Link
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
(string | (param: any) => any) from action
Property
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.
boolean from disabled
Property
A boolean that lets the link know whether it is disabled or not.
string from href
Property
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.
boolean from isActive
Property
A boolean that lets the link know whether it is active or not. It is useful when action() is executed instead of link route.
NavigationExtras from navigationExtras
Property
The navigation extras provide additional routing options when using the router link.
string from target
Property
The target attribute specifies where to open the linked document. If no target is specified, the link will open in the current tab.
string
Property
The title of the menu item. Can be either the title to be displayed or the translation key.
(string & Translatable)
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.
TranslatableString from tooltip
Property
The optional tooltip of the link. Can be either the text to be displayed or the translation key.
(string | (param: any) => any)
Property
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.
boolean
Property
A boolean that lets the link know whether it is disabled or not.
string
Property
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.
boolean
Property
A boolean that lets the link know whether it is active or not. It is useful when action() is executed instead of link route.
NavigationExtras
Property
The navigation extras provide additional routing options when using the router link.
string
Property
The target attribute specifies where to open the linked document. If no target is specified, the link will open in the current tab.
Translatable
import
TranslatableString
Property
The optional tooltip of the link. Can be either the text to be displayed or the translation key.

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