Site Maps

The site map of your app defines the structure by which users can orient themselves across your site.

A site map is a tree of site map nodes. Each node defines a page that a user can access on your site.

Site map node urls

To access the page of a site map node the user needs to navigate to the url that is assigned to that node.

Urls can be:

  • relative to the parent url (no slash in the front)
  • absolute to the root of the site (starts with a slash)


Each site map node renders a page when it is hit via a matching url.

It will create a container and use it to setup a page. This container will contain global registrations from the global factory and local registrations from the local factory.

You can configure any react component to be rendered as the page of the site map node.

Navigation UI

One reason to have a site map is to efficiently create a navigation UI like a breadcrumb or a side bar from it when a page is opened.

That allows the user to easily find out where he is on the page.

To make this feature useful the text of the navigation UI must be dynamically computable. Usually static texts are not enough to find out where you are on a page.

Therefore, you can add any react component to be used as a kind of caption for the site map node in the navigation UI.