.. include:: /Includes.rst.txt
.. _typo3-core-icon:
====
icon
====
Displays icon identified by icon identifier.
Examples
========
Default::
Output::
Inline::
Output::
Arguments
=========
.. _icon_identifier:
identifier
----------
:aspect:`DataType`
string
:aspect:`Required`
true
:aspect:`Description`
Identifier of the icon as registered in the Icon Registry.
.. _icon_size:
size
----
:aspect:`DataType`
string
:aspect:`Default`
'small'
:aspect:`Required`
false
:aspect:`Description`
Desired size of the icon. All values of the Icons.sizes enum are allowed, these are: "small", "default", "large" and "overlay".
.. _icon_overlay:
overlay
-------
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
Identifier of an overlay icon as registered in the Icon Registry.
.. _icon_state:
state
-----
:aspect:`DataType`
string
:aspect:`Default`
'default'
:aspect:`Required`
false
:aspect:`Description`
Sets the state of the icon. All values of the Icons.states enum are allowed, these are: "default" and "disabled".
.. _icon_alternativemarkupidentifier:
alternativeMarkupIdentifier
---------------------------
:aspect:`DataType`
string
:aspect:`Required`
false
:aspect:`Description`
Alternative icon identifier. Takes precedence over the identifier if supported by the IconProvider.