The UI Button macro helps users navigate to other pages.
Example
There were errors rendering macro:
- An unknown error occurred.
Add the UI Button macro to a page
There are two ways to add a macro to a page:
Type { plus the macro’s name. Select the macro from the dropdown list.
In the Confluence editor’s top menu, click + > Other macros and search for the macro.
UI Button macro settings
To change the macro’s settings, click the macro > Edit.
Setting | Description | Available since Toolkit version |
|---|---|---|
Title | The button’s text. | 1.0 |
Tooltip | The text that appears when users hover their mouse over the button. | 2.1 |
URL | The page the user is taken to when they click the button. Make sure to use relative links if you link to a page within the same Confluence instance. | 1.0 |
Icon | Choose from a wide range of icons (optional). | 1.0 |
Color | Choose from a range of pre-set colours. Since Toolkit version 2.0, you can customise these colours (read more below). | 1.0 |
Size | Small, medium or large. | 1.0 |
Display | Display the button as wide as its title (inline) or at full page width (block). | 1.0 |
Open in a new window | Check this box to open the link in a new browser window. | 1.0 |
Customise button colours
Since version 2.0 of Refined Toolkit, it’s possible customise the UI Buttons' colour options. When you customise a colour, the new colour scheme applies to all buttons with that label on your site.
Go to General Configuration.
In the left-hand menu, look for RefinedToolkit and click Configuration.
Go to the UI Button tab.
Click Edit to set the buttons’s background colour and the text colour.
Click Revert to default to reset all button colours.