SiAboutComponent documentation¶

selector

si-about

Name	Type	Default	Description
aboutTitle ¶	`string`		Title shown above the about information.
acceptableUsePolicyLink ¶	`Link`		Link to `Acceptable Use Policy` .
appName ¶	`string`		Title of this application.
cookieNoticeLink ¶	`Link`		Link to `Cookie Notice` .
copyrightDetails ¶	`CopyrightDetails`		Copyright information to be displayed. Alternatively, you can use the SI_COPYRIGHT_DETAILS global inject.
icon ¶	`string`		Path to the application logo. Use for image
iconName ¶	`string`		Name of element icon. Use as alternative to image
imprintLink ¶	`Link`		Link to `Corporate Information` .
licenseInfo ¶	`LicenseInfo`		Define mode to display the licenses. See LicenseInfo
links ¶	`Link`[]	`[]`	Additional links listed in the about section.
privacyLink ¶	`Link`		Link to `Privacy Notice` .
subheading ¶	`string`[]		Sub titles of the application. Shown as a list below the application name. (Optional)
termsLink ¶	`Link`		Link to `Terms of Use` .

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

Properties
The company name to be displayed in the copyright notice (not to be translated). If empty (recommended), the company name from the theme will be used. company?: `string`¶
The year when the app was last updated. Must be left blank if it equals startYear lastUpdateYear?: `number`¶
The year when the app was first released. startYear: `number`¶

SI_COPYRIGHT_DETAILS `InjectionToken`<`CopyrightDetails`> = ...¶ Variable The injection token to be used when used globally across the app

Properties
URL to license REST end point. License texts are lazy loaded separately for each component. Requires a service to provide license data. api?: `string`¶
In API View, custom license file icon. icon?: `string`¶
URL to license file to be shown in iFrame. iframe?: `string`¶
License to be shown as plain text in `<pre>` element. text?: `string`¶
Title of the License Info. title: `string`¶

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.

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

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