SiInfoPageComponent documentation¶

selector

si-info-page

The component displays application info messages. A message uses an icon and a title, optionally a copy text, instructions and a link. Replace the integrated icon by content projection of another icon or image with the CSS class .si-info-image . Use content projection with the CSS class si-info-actions to inject more buttons and options to interact with the page.

Input Properties¶

Name	Type	Default	Description
copyText ¶	`TranslatableString`		A more detailed explanation of the error, outlining the reasoning for it and how a user can resolve it.
icon ¶	`string`	`'element-warning-filled'`	The element warning icon.
iconColor ¶	(`undefined` \| `string`)	`'status-warning'`	Icon color class, see https://element.siemens.io/fundamentals/typography/#color-variants-classes
instructions ¶	`TranslatableString`		A detailed instruction on how a user can resolve the error.
link ¶	`Link`		Use the link object if you have one option to follow. A link object has a title to be displayed and can be configured with an external link, a router link, or a custom action. If you want to provide multiple options, add your own content into the component.
titleText ¶	`TranslatableString`		A short and concise title to explain the error.

Types Documentation¶

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.

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

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

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