This documentation has moved. For the most recent documentation, check out https://docs.adaptavist.com. Please update your bookmarks and links.

Skip to end of metadata
Go to start of metadata

Description

A pair of macros allowing the user to add an Atlassian styled progress bar to the page, providing the user with a level of context for the page within a process.

Usage

Click Insert > Other Macros.

 

Select the Progress Bar Container macro from the provided list.

 

Complete the desired fields.

ParameterDescriptionType

Default

Required?
Current Step Number

Defines which step is currently highlighted within the process.

int

none

(tick)

IDSpecifies a CSS ID to be added.
stringnone(error)
CSS ClassSpecifies a CSS Class to be added.
stringnone(error)
TitleText to display in a tool tip.stringnone(error)

 

The macro will then appear on the page.

Place the Progress Bar - Hyperlink Step macro inside the Progress Bar Container macro.

Click Insert > Other Macros, and select the Progress Bar - Hyperlink Step macro.

 

Complete the desired fields.

ParameterDescriptionType

Default

Required?
Title

The name of this step

string

none

(tick)

URLThe URL that this step links to.stringnone(tick)
IDSpecifies a CSS ID to be added.stringnone(error)
CSS ClassSpecifies a CSS Class to be added.stringnone(error)

 

The macro will then appear on the page.

Add a Progress Bar - Hyperlink Step macro to the Progress Bar Container macro for each step required. Note there should be at least as many Progress Bar - Hyperlink Step macros as the Current Step Number parameter in the Progress Bar Container macro.

The "Current Step Number" value in the Progress Bar Container macro should be an integer value of the current step, and not the name of the current step.

When saved, an AUI-styled Progress Bar will appear on the page:

 

Top of page

  • No labels