App Type documentation¶

App (`AppLink` \| `AppRouterLink`)¶ Type alias

extends AppBase¶

Represents an app to be shown in the launchpad.

Properties
Whether the app is the currently running app. active?: `boolean`¶
Whether the app should be marked as external. external?: `boolean` from `external`¶
Whether the app is marked as favorite. favorite?: `boolean` from `favorite`¶
URL destination of the app. href: `string`¶
CSS class to apply, which should render the icon. Typically, "element-*". iconClass?: `string` from `iconClass`¶
Icon of the app. iconUrl?: `string` from `iconUrl`¶
Name of the app name: `TranslatableString` from `name`¶
Name of the related system. systemName?: `TranslatableString` from `systemName`¶
Value for the anchor target attribute. target?: `string`¶
The type of the app. can be either 'link' or 'router-link' type?: `"link"`¶

extends AppBase¶

Properties
Active match options for routerLinkActive https://angular.dev/api/router/IsActiveMatchOptions . activeMatchOptions?: (`IsActiveMatchOptions` \| { exact: `boolean` })¶
Whether the app should be marked as external. external?: `boolean` from `external`¶
Navigation extras that are passed to the https://angular.dev/api/router/NavigationExtras . extras?: `NavigationExtras`¶
Whether the app is marked as favorite. favorite?: `boolean` from `favorite`¶
CSS class to apply, which should render the icon. Typically, "element-*". iconClass?: `string` from `iconClass`¶
Icon of the app. iconUrl?: `string` from `iconUrl`¶
Name of the app name: `TranslatableString` from `name`¶
Link for the angular router. Accepts the same values as https://angular.dev/api/router/RouterLink . routerLink: (`string` \| `any`[])¶
Name of the related system. systemName?: `TranslatableString` from `systemName`¶
type: `"router-link"`¶

Properties
Whether the app should be marked as external. external?: `boolean`¶
Whether the app is marked as favorite. favorite?: `boolean`¶
CSS class to apply, which should render the icon. Typically, "element-*". iconClass?: `string`¶
Icon of the app. iconUrl?: `string`¶
Name of the app name: `TranslatableString`¶
Name of the related system. systemName?: `TranslatableString`¶

external? `boolean`¶ Property Whether the app should be marked as external.

favorite? `boolean`¶ Property Whether the app is marked as favorite.

iconClass? `string`¶ Property CSS class to apply, which should render the icon. Typically, "element-*".

iconUrl? `string`¶ Property Icon of the app.

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.

name `TranslatableString`¶ Property Name of the app

systemName? `TranslatableString`¶ Property Name of the related system.

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

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