Spaces List Macro

Add the Spaces List macro to a page to display a list of spaces on a page.

This is legacy macro. It was previously used in the dashboard, and has been known to cause issues large sites. Although limited, this macro is great if you want to:

  • highlight spaces that have been created in the last 7 days
  • provide a list of spaces, that can be filtered by space category.

On this page:

Screenshot: Page with a Spaces List macro showing cross-team spaces. 


This macro works best with space categories. See Use Labels to Categorize Spaces to find out how to categorize spaces in your site.

Add this macro to your page

To add the Spaces List macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros.
  2. Choose Spaces List from the Confluence content category.
  3. Enter any parameters.
  4. Choose Insert

You can then publish your page to see the macro in action. 

Screenshot: Configuring the spaces list macro to show spaces by category. 

Change the macro parameters

Macro parameters are used to change the behaviour of a macro.

To change the macro parameters:

  1. In the editor, click the macro placeholder and choose Edit.
  2. Update the parameters as required then choose Insert.

Here's a list of the parameters available in this macro. 

Parameter

Required?

Default

Description

Scope of spaces

no

all

The view from which spaces are listed. Available options are:

  • (blank) - All spaces in your site, with tabs.
  • all – All spaces in your Confluence site.
  • category – Spaces grouped according to space categories.
  • favorite – Spaces which you have added to My Spaces.
  • new – spaces created within the last 7 days.

This parameter is unnamed in wiki markup and storage format.

Width of List
(width

no

100%

The width of the spaces list, specified as a percentage (%) of the window width.

Include archived spaces
(includeArchivedSpaces)

noFalseInclude spaces that have been archived in the list. These are excluded by default.

Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

Troubleshooting

This macro is known to cause issues in sites with large number of spaces. See  CONFSERVER-59804 - Getting issue details... STATUS .  

This macro is provided by the Dashboard Macros system app. Disable the Spaces module if you want to prevent people using this macro. 

Other ways to add this macro

Add this macro as you type

Type followed by the start of the macro name, to see a list of macros. 

Add this macro using wiki markup

This is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: spaces

Macro body: None.

{spaces:favourite|width=80%}
Last modified on Oct 11, 2021

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.