Skip to content

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 ​

Parameter ​

Parameters in the Layout ​

NameTypeDescription
icon
(optional)
stringThe icon key which should be displayed. If no icon key is provided, the icon is hidden.
infoTitle
(optional)
stringThe label key which will be displayed at the top of the banner. If no label key is provided, the title is hidden.
infoTitleOptionssetKeyOptionsTranslation options for the title text.
description
(optional)
stringThe 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.
descriptionOptionssetKeyOptionsTranslation options for the description text.
buttonsarray of Button configurationThis 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:

NameTypeDescription
moduleNamestringModule name for translation.
immediatelybooleanDefines whether the translation must be fetched from the backend without delay.
variablesmap<string, string>Variables that can be replaced in translation.
translatebooleanDefines whether the text should be translated.
allowHTMLbooleanDefines if the TranslationLabel supports HTML.
fallbackLabelKeybooleanDefines whether the label key is returned in case of a missing translation.

Button Configuration ​

NameTypeDescription
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)
stringThe label key for the button text.
tooltip
(optional)
stringThe label key for the button tooltip.
primary
(optional)
booleanIndicates if the button is highlighted in the primary color.
parameter
(optional)
mapContains additional, type specific parameter
target_url (for type url)
target_url
(type url only)
stringThe target url which will be opened in a new tab
Request missing documentation