Skip to end of metadata
Go to start of metadata

Description

This macro 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

{webui-list}

Parameters

Property

Required

Default

Notes

Ver

default

(error)

all locations

The webui location, or location and section key to be displayed

 

icons

(error)

true

Whether icons should be displayed (if available)

 

name

(error)

true

Whether the name should be displayed

 

description

(error)

true

Whether the description should be displayed

 

separator

(error)

-

The separator to be placed between the name & description

 

bundled

(error)

true

Whether to include links bundled with confluence or not

 

current

(error)

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

{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

{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

None at present.

  • No labels

2 Comments

  1. Unknown User (gfraser)

    Which version of Builder was this macro added in?

    1. Its been around since builder 3.0.1 in various forms, however the state documented above is present from builder 3.3.1-M2 (not yet released)

      The major changes in 3.3.1 are the ability to specify the location using the 'default' parameter (before you would need to use the location= parameter - which is retained for backwards compatibility)

      Also added in 3.3.1 are the name, description and separator parameters.