MenuItemRouterLink Type documentation¶

Represents a menu item that navigates using the Angular Router.

Requires a configured Angular Router.

Properties
Badge that is rendered after the label. badge?: (`string` \| `number`) from `badge`¶
Color of the badge (not iconBadge). badgeColor?: `string` from `badgeColor`¶
Whether the menu item id disabled. disabled?: `boolean` from `disabled`¶
Navigation extras that are passed to the `RouterLink` . extras?: `NavigationExtras`¶
Optional icon that will be rendered before the label. icon?: `string` from `icon`¶
Badge (always red) that is attached to the icon. If value===true, an empty red dot will be rendered. iconBadge?: (`string` \| `number` \| `boolean`) from `iconBadge`¶
ID that will be attached to the DOM node. id?: `string` from `id`¶
Label that is shown to the user. label: `TranslatableString` from `label`¶
Link for the angular router. Accepts the same values as `RouterLink` . routerLink: (`string` \| `any`[])¶
type: `"router-link"`¶

Properties
Badge that is rendered after the label. badge?: (`string` \| `number`)¶
Color of the badge (not iconBadge). badgeColor?: `string`¶
Whether the menu item id disabled. disabled?: `boolean`¶
Optional icon that will be rendered before the label. icon?: `string`¶
Badge (always red) that is attached to the icon. If value===true, an empty red dot will be rendered. iconBadge?: (`string` \| `number` \| `boolean`)¶
ID that will be attached to the DOM node. id?: `string`¶
Label that is shown to the user. label: `TranslatableString`¶

badge? (`string` \| `number`)¶ Property Badge that is rendered after the label.

badgeColor? `string`¶ Property Color of the badge (not iconBadge).

disabled? `boolean`¶ Property Whether the menu item id disabled.

icon? `string`¶ Property Optional icon that will be rendered before the label.

iconBadge? (`string` \| `number` \| `boolean`)¶ Property Badge (always red) that is attached to the icon. If value===true, an empty red dot will be rendered.

id? `string`¶ Property ID that will be attached to the DOM node.

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.

label `TranslatableString`¶ Property Label that is shown to the user.

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

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