---
title: "space-breadcrumbs macro"
canonical: "https://support.appfire.com/space/COMALACM/656677781/space-breadcrumbs%20macro"
format: markdown
---
> Macro (aura-html)

## <span style="color: #091e42">Overview</span>

<span style="color: #091e42">The </span>`space-breadcrumbs`<span style="color: #091e42"> </span><span style="color: #333333">macro adds breadcrumbs for a specified page. It analyzes the space hierarchy information to include all of the parent spaces up to the root space in the breadcrumbs.</span>

<span style="color: #333333">A second optional </span><span style="color: #333333">**type**</span><span style="color: #333333"> parameter manages the link information displayed in the breadcrumb.</span>

The macro is used when [setting up space hierarchies](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/656676531). It is usually added to the root space in your hierarchy on the home page.

## Parameters

| Parameter | Required | Default | Notes | Version |
| --- | --- | --- | --- | --- |
| `page` | :check_mark: |  | The page to display the breadcrumb for including the space hierarchy for the page. |  |
| `type` |  | `home` | The information to be included in the breadcrumb – there are three values:<br>- `home `– the breadcrumb links from the space home page to the selected page.
- `dashboard` - the breadcrumb links from the dashboard to the selected page.
- `dashboard+home` - the breadcrumb links from the space home page and the dashboard to the selected page |  |

## Usage

In the macro browser, choose the **Space Breadcrumbs** macro:

![image](media://671c184b-f2b1-41bf-a740-0b1d42375e2c)

The macro editor displays the space breadcrumb for the default page - the current page `@self`.

![image](media://5cf819ab-f409-4c5a-96bc-21d78d31a760)

The macro editor options include:

- The page to display the breadcrumb for including the space hierarchy
- A dropdown option menu to include the hierarchy to the page from the space dashboard, the space home page, or both of these

Any options are displayed in the macro placeholder.

![image](media://dd121e73-e294-4a09-8bfa-a7f5128d46a8)

The breadcrumb is displayed on the page as follows:

![image](media://d007c9f2-efd1-4171-a356-6026eb5a0761)

In this example the the space breadcrumb macro is showing the hierarchy for the **Space Hierarchy** page.

## Reference markup

```
{space-breadcrumbs:page=@self|type=home}
```

## Related macros

> Macro (contentbylabel)

## Related pages

- [Adding metadata to a space](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/655988362)
- [Setting up hierarchical spaces](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/656676531)
- [Using metadata to define space hierarchies](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/656578613)