SiToastNotificationService documentation¶

provided in root

✓

Name	Type	Default	Description
activeToasts ¶	`SiToast`[]	`[]`	List of currently active toasts to see details or close them.
hideToastNotification(...) ¶	(toast: `SiToast`) => `void`		Hide a toast notification Parameters toast: `SiToast` The toast object of the toast to be hidden, can be retrieved from activeToasts and is returned by queueToastNotification .
queueToastNotification(...) ¶	(state: `ToastStateName`, title: `string`, message: `string`, disableAutoClose: `boolean`, disableManualClose: `boolean`, action: `Link`) => `SiToast`		Queue a new toast to be shown. Returns the toast object Parameters state: `ToastStateName` title: `string` message: `string` disableAutoClose: `boolean` disableManualClose: `boolean` action: `Link` Passing a Link object will optionally add a clickable link to the toast which can contain an action.
showToastNotification(...) ¶	(toast: `SiToast`) => `SiToast`		Show a toast notification Parameters toast: `SiToast` The toast object of the toast to be shown, can also be constructed while calling this.

Properties
action?: `Link`¶
close?: () => `void`¶
closeAriaLabel?: `TranslatableString`¶
disableAutoClose?: `boolean`¶
disableManualClose?: `boolean`¶
hidden?: `Subject`<`void`>¶
message: `TranslatableString`¶
state: `ToastStateName`¶
timeout?: `number`¶
title: `TranslatableString`¶
translationParams?: { [ key: `string` ]: `any` } }¶

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`¶

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.

ToastStateName (`StatusType` \| `"connection"`)¶ Type alias

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

StatusType (`"success"` \| `"info"` \| `"warning"` \| `"danger"` \| `"caution"` \| `"critical"`)¶ Type alias

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