The Adaptavist Group LogoDocumentation

Lozenge

The Lozenge macro creates a lozenge button with an optional link that's ideal for highlighting important information or directing users to additional resources. It is designed for small amounts of content (although the width can be changed to accommodate more content if required). This is to ensure that the content contained within the lozenge is concise and, in turn, leads to an improved user experience.

Learn more here about how to use each of our macros to increase functionality, engagement, and collaboration within your Confluence.

Add a Lozenge to your page

  1. Navigate to the page you want to edit.
  2. Click Edit.
  3. Click the position where you want to add a lozenge. This can be repositioned later if required.
  4. Click Insert More Content → Other Macros.
  5. Select the Lozenge macro from the Macro Browser.
  6. Customize the macro using the following parameters:
    Parameter Description Type Default Required
    IconThe URL for an image (no larger than 48x48 pixels) or simply type in text to use as a label.stringnone
    TitleEnter the title of the lozenge, also used as the tooltip for links.stringnone
    Destination The page, URL, or file to which the user will be directed 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 , e.g. file:///c:/read_me.txt . You may also specify an email destination, e.g. mailto:someone@ somewhere.com which will launch the default email client when the button is clicked. stringnone
    ColorSelect the color of the left portion of the lozenge.single selectsilver
    Arrow Select the arrow to use on the left portion of the lozenge:
    • none: (default if no link is specified)
    • blue: (default if a link is specified) - a blue arrow is displayed
    • green: a green arrow is displayed
    single selectnone, or blue
    Width Define the width of the entire lozenge in pixels or %. Specify auto to automatically stretch the lozenge to fit its contents. stringnone
    Table based lozengeCompatibility setting for use if the lozenge does not display correctly in older browsers.checkboxunselected
  7. Click Insert. The macro placeholder displays.
  8. Enter the text to display in the macro body, e.g. a description, summary text, or add an Excerpt Include macro.
  9. Save the page to view the rendered lozenge.
  10. Test any defined links.
    Note: Page or URL parameter: If the defined URL or Confluence page does not exist, a new child page is created when the lozenge is first clicked using the value supplied in the "Page or URL" parameter. On subsequent clicks, Confluence will navigate to the created page. To ensure the link goes to an external webpage put 'https://' in front of the URL

Colors

There are nine colors to choose from for the left section of the lozenge, and two colors for the arrow.

Color No Arrow Blue Arrow Green Arrow
bronze
silver
gold
blue
cyan
green
purple
pink
red

Basic lozenge

Create a simple lozenge as follows:

Published Result

Add an Icon

Any images you add are not held within the macro. You need to provide a URL for the image. One way to do this is to add the image to the page as an attachment. You can then use the URL for this image in the Icon field.

Tip: The most effective icons are 32x32 or 48x48 pixels and have transparent backgrounds.

Put the URL for your image in the icon field.

Published Result

Add a label

If you want text to show in the left-hand section you can just input that text into the Icon field.

Published Result

Lozenge Width

By default, all lozenges are 347px wide. However, they can be stretched to fit their contents.

For a lozenge that changes size to match the size of the content and the webpage type auto into the Width field.

You can also set a percentage width, for example, 70%:

Or, a pixel width, for example 200px:

Search documentation

Start typing to search the docs.