Skip to end of metadata
Go to start of metadata

Description

The Button macro allows you to create AUI-styled buttons which provide hyperlinks to other pages or websites. 

Although hyperlinks can be created through the standard Confluence interface, the Atlassian styled button hyperlinks provide stronger visual integration with the application as a whole, and can be used to create pages which feel like part of Confluence itself.

Usage

Click Insert > Other Macros.


Select the Button macro from the provided list.


Complete the following details.

ParameterDescriptionType

Default

Required?
Title

The text which will appear on the button.

string

none

(tick)

URL

 The page, URL or file (see note below) which the user will be directed to when they click the button.

The field will auto-complete for pages within the Confluence site, but can also take a full URL or file link (file:///c:/read_me.txt).

Some browsers may block URL paths that point to files on a local files system or local networked folders for security reasons. This can be overridden in your browsers security settings, but should only be done as part of a comprehensive security strategy.

In most cases, it is best to host such files on dedicated web servers that use other protocols such as FTP. More info can be found in Atlassian's documentation.

string

none

(tick)

Button Type

 Select the type of button to be displayed:

  • Standard
  • Primary
  • Subtle

The effect on these buttons will differ depending on whether they are on their own, or a part of a Button Group.

single select

standard

(tick)

Icon

Select an icon option:

  • None: no icon is displayed on the button.
  • Preset: select from a list of Content Formatting icons.  See the Icon Reference below.
  • Custom: select custom to use any AUI icon. See the AUI Icon examples for more information and to verify the correct icon name to enter in the Custom AUI Icon input field.
single selectnone(tick)
Custom AUI IconAdd the name of desired AUI custom icon as defined in docs.atlassian.com.
Note: icons available are AUI version dependent.
stringnone(error)
IDSpecifies a CSS ID to be added to the button.stringnone(error)
ClassSpecifies a CSS Class to be added to the button.stringnone(error)



The macro will then appear on the page.

Once saved, an Atlassian styled Button will appear on the page.

Style Reference

Icon Reference

Icons may look slightly different depending on your version of Confluence.


  • No labels