The displayIcon Macro

Last modified by Vincent Massol on 2026/02/05 17:22

Reference

Description

The displayIcon Macro is a Rendering Macro. It can also be found under the name of Icon Macro.

The icon macro displays an icon of the current icon set or a chosen icon set. It can be used to add icons to UI elements and, e.g., also for documentation purposes to show which icon a user needs to click.

Usage

The basic usage is to just specify an icon name to display an icon from the current icon theme, all other parameters are optional. Refer to the documentation of the icon theme application for a list of icons and icon sets.

Parameters

NameOptionalAllowed valuesDefault valueDescription
namenoa valid icon name from the icon set used The name of the icon. See the icon theme application for available icons.
iconSetyesa valid icon set namethe icon set defined on the pageThe name of the icon set. See the icon theme application for available icon sets.
fallbackyestrue/falsetrueIf the icon shall be loaded from the default icon set when the icon or icon set is not available.

Examples

Adding a standard "home" icon

Wiki syntax:

{{displayIcon name="home"/}}

Output:

display-icon-example.png
 

Related

Get Connected