Be.infobox ViewHelper <f:be.infobox>
See example Infobox with HTML content, icon and links
ViewHelper for rendering a styled content infobox markup.
Go to the source code of this ViewHelper: Be\InfoboxViewHelper.php (GitHub).
Table of contents
Severity states of the Be.infobox ViewHelper
The Infobox provides different context-sensitive states that can be used to provide an additional visual feedback to the
user to underline the meaning of the information.
Possible values are in range from -2 to 2. Please choose a
meaningful value from the following list.
A demonstration of all possible states
-2- Notices (Default)
-1- Information
0- Positive feedback
1- Warnings
2- Error
It is considered best practice to use the states from
\TYPO3\ together with the
Constant ViewHelper <f:constant>:
<f:be.infobox
title="Some Info"
message="The message"
state="{f:constant(name: 'TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_NOTICE')}"
/>
<f:be.infobox
title="Some Notice"
message="The message"
state="{f:constant(name: 'TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_INFO')}"
/>
<f:be.infobox
title="Some sucess message"
message="The message"
state="{f:constant(name: 'TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_OK')}"
/>
<f:be.infobox
title="Some Warning"
message="The message"
state="{f:constant(name: 'TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_WARNING')}"
/>
<f:be.infobox
title="Some Error"
message="The message"
state="{f:constant(name: 'TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_ERROR')}"
/>
Examples
Info box of level notice with a static title and a static text:
<f:be.infobox title="Message title">your box content</f:be.infobox>Warning box with disabled icon:
<f:be.infobox
title="Message title"
message="your box content"
state="{f:constant(name: 'TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_WARNING')}"
disableIcon="true"
/>Success box with custom icon:
<f:be.infobox
title="Message title"
message="your box content"
state="{f:constant(name: 'TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_OK')}"
iconName="check"
/>Infobox with HTML content, icon and links
You can find this example in the TYPO3 backend module System > DB Check > Manage Reference Index if typo3/cms-lowlevel is installed.
<f:be.infobox
title="{f:translate(key:'LLL:EXT:lowlevel/Resources/Private/Language/locallang.xlf:checkScript_headline')}"
state="{f:constant(name: 'TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_INFO')}"
>
<p>{f:translate(key:'LLL:EXT:lowlevel/Resources/Private/Language/locallang.xlf:checkScript')}</p>
<p>
{f:translate(key:'LLL:EXT:lowlevel/Resources/Private/Language/locallang.xlf:checkScript_check_description')}<br>
<code>php {binaryPath} referenceindex:update -c</code>
</p>
<p>
{f:translate(key:'LLL:EXT:lowlevel/Resources/Private/Language/locallang.xlf:checkScript_update_description')}<br>
<code>php {binaryPath} referenceindex:update</code>
</p>
<p>
{f:translate(key:'LLL:EXT:lowlevel/Resources/Private/Language/locallang.xlf:checkScript_moreDetails')}
<a href="{ReadmeLink}" target="_blank">{ReadmeLocation}</a>
</p>
</f:be.infobox>
Arguments
disableIcon
-
- Type
- bool
- Default
- false
If set to TRUE, the icon is not rendered.
iconName
-
- Type
- string
Identifier of the icon as registered in the Icon Registry. NULL sets default icon
message
-
- Type
- string
The message of the info box, if NULL tag content is used
state
-
- Type
- int
- Default
- -2
The state of the box, InfoboxViewHelper::STATE_*
title
-
- Type
- string
The title of the info box