Page History

Description

This macro

Excerpt
generates an unordered list of webui items for a given location

, this list may be used in a builder menu to replicate confluence webui locations

Usage

Code Block
{webui-list}

Parameters

Property	Default	Notes	Ver
default	all locations	The webui location, or location and section key to be displayed
icons	true	Whether icons should be displayed (if available)
name	true	Whether the name should be displayed
description	true	Whether the description should be displayed
separator	`-`	The separator to be placed between the name & description
bundled	true	Whether to include links bundled with confluence or not
current	false	Determines whether a `class="current"` will be added to the HTML output of the active link or not: `false` – current class not added (default) `true` – the active link will have the current class added where possible	3.3.5

Note that the 'current' param only works when the macro is being used in a theme panel (ie. it won't have any effect if rendered on a wiki page). The macro does it's best to determine the active link and add the class but there are still some scenarios it can't handle. To work round these issues you can use Flags in conjunction with CSS.

Examples

Basic Use

Use this macro to display a complete list of all the webui links installed in confluence
Code Block
{webui-list}

displaying a location

In many cases you will want to use the webui-list macro in a menu to replicate a single confluence location, you can do this by specifying a location as the default parameter
Code Block
{webui-list:system.content.action}

You can find more information about the available webui locations here, or alteratively place the webui-list macro on a page with no location specified and examine the classnames in the generated html.

CSS Customisation

To follow.

Hints and Tips

None at present.

Frequently Asked Questions