SiBreadcrumbResolverService Type documentation¶

Service interface to resolve the breadcrumb items on the base of a route.

Methods

(route: ActivatedRouteSnapshot) => (BreadcrumbItem[] | Observable<BreadcrumbItem[]>)¶

Parameters
route: `ActivatedRouteSnapshot`¶

Types Documentation¶

BreadcrumbItem

extends Link¶

Interface

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`¶
Defines the link of the menu item within the application using the angular router link concept. Accepts an array of `any` as per [routerLink API definition] https://angular.dev/api/router/RouterLink . link?: (`string` \| `any`[]) from `link`¶
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`¶

Link

¶

Interface

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`)¶
A boolean that lets the link know whether it is disabled or not. disabled?: `boolean`¶
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`¶
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`¶
Defines the link of the menu item within the application using the angular router link concept. Accepts an array of `any` as per [routerLink API definition] https://angular.dev/api/router/RouterLink . link?: (`string` \| `any`[])¶
The navigation extras provide additional routing options when using the router link. navigationExtras?: `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`¶
The title of the menu item. Can be either the title to be displayed or the translation key. title?: `TranslatableString`¶
The optional tooltip of the link. Can be either the text to be displayed or the translation key. tooltip?: `TranslatableString`¶

action? (`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.

disabled? `boolean`¶ Property A boolean that lets the link know whether it is disabled or not.

href? `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.

isActive? `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.

link? (`string` \| `any`[])¶ Property Defines the link of the menu item within the application using the angular router link concept. Accepts an array of `any` as per [routerLink API definition] https://angular.dev/api/router/RouterLink .

navigationExtras? `NavigationExtras`¶ Property The navigation extras provide additional routing options when using the router link.

target? `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.

TranslatableString (`string` & `Translatable`)¶ Type alias 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.

tooltip? `TranslatableString`¶ Property The optional tooltip of the link. Can be either the text to be displayed or the translation key.

Translatable ¶ import imported from @siemens/element-translate-ng

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