Icon ViewHelper <core:icon>
¶
Note
This ViewHelper is not available by default.
Import its namespace
{namespace core=TYPO3\CMS\Core\ViewHelpers\}
in the Fluid file or
xmlns:core="http://typo3.org/ns/TYPO3/CMS/Core/ViewHelpers/"
in the opening HTML tag.
Displays icon identified by icon identifier.
Examples¶
Default:
<core:icon identifier="actions-menu" />
Output:
<span class="t3js-icon icon icon-size-small icon-state-default icon-actions-menu" data-identifier="actions-menu">
<span class="icon-markup">
<img src="/typo3/sysext/core/Resources/Public/Icons/T3Icons/actions/actions-menu.svg" width="16" height="16">
</span>
</span>
Inline:
<core:icon identifier="actions-menu" alternativeMarkupIdentifier="inline" />
Output:
<span class="t3js-icon icon icon-size-small icon-state-default icon-actions-menu" data-identifier="actions-menu">
<span class="icon-markup">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><g class="icon-color"><path d="M9 12v2H7v-2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM9 7v2H7V7h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM9 2v2H7V2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM4 7v2H2V7h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM4 2v2H2V2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM4 12v2H2v-2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM14 7v2h-2V7h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM14 2v2h-2V2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM14 12v2h-2v-2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5z"/></g></svg>
</span>
</span>
Source code¶
Go to the source code of this ViewHelper: IconViewHelper.php (GitHub).
Arguments¶
The following arguments are available for <core:icon>
:
-
identifier
¶ -
- Type
- string
- Required
true
Identifier of the icon as registered in the Icon Registry.
-
size
¶ -
- Type
- string
- Default
'small'
Desired size of the icon. All values of the Icons.sizes enum are allowed, these are: "small", "default", "large" and "overlay".
-
overlay
¶ -
- Type
- string
Identifier of an overlay icon as registered in the Icon Registry.
-
state
¶ -
- Type
- string
- Default
'default'
Sets the state of the icon. All values of the Icons.states enum are allowed, these are: "default" and "disabled".
-
alternativeMarkupIdentifier
¶ -
- Type
- string
Alternative icon identifier. Takes precedence over the identifier if supported by the IconProvider.