# Info
The Info
component is the basic component for info components and provides basic functions.
The Info
component itself cannot be used, but a derived info can be used.
# Properties
HTMLElement
BaseComponent
# Parameter
# Parameters in the Layout
Name | Type | Description |
---|---|---|
icon (optional) | string | The icon key which should be displayed. If no icon key is provided, the icon is hidden. |
infoTitle (optional) | string | The label key which will be displayed at the top of the banner. If no label key is provided, the title is hidden. |
infoTitleOptions | setKeyOptions | Translation options for the title text. |
description (optional) | string | The label key which will be displayed below the title. The container of the description allows HTML markup. So, for example, if the translation is <b>My text</b> , the text My text will be displayed as bold text. If no label key is provided, the description is hidden. |
descriptionOptions | setKeyOptions | Translation options for the description text. |
buttons | array of Button configuration | This parameter defines the number and the behavior of buttons in the info banner. The structure of a button configuration is shown below |
# Translation Options
The following are all optional:
Name | Type | Description |
---|---|---|
moduleName | string | Module name for translation. |
immediately | boolean | Defines whether the translation must be fetched from the backend without delay. |
variables | map<string, string> | Variables that can be replaced in translation. |
translate | boolean | Defines whether the text should be translated. |
allowHTML | boolean | Defines if the TranslationLabel supports HTML. |
fallbackLabelKey | boolean | Defines whether the label key is returned in case of a missing translation. |
# Button Configuration
Name | Type | Description |
---|---|---|
type (required) | url close | Type close is used to close this banner. Type url is used to open a specified url in a new browser tab. |
label >(required) | string | The label key for the button text. |
tooltip (optional) | string | The label key for the button tooltip. |
primary (optional) | boolean | Indicates if the button is highlighted in the primary color. |
parameter (optional) | map | Contains additional, type specific parametertarget_url (for type url ) |
target_url (type url only) | string | The target url which will be opened in a new tab |