Use the in-page navigation to provide quick access to the content within a page.
What it is
The In-page navigation block renders the NSW Design System In-page navigationopen_in_new component — the “On this page” list that lets people jump straight to a section further down a long page.
It builds the list automatically from the headings that follow it, so you never add or maintain the links by hand.
Add an In-page navigation block from the block menu — usually near the top of the page, just after the introduction.
It lists every Heading 2 below it, in order — so put it above the sections it introduces. To create sections, add Heading 2 blocks; the navigation updates to match.
Add In-page navigation; it lists the headings below it automatically
Configure it
The block has two options in the sidebar:
Title — the heading shown above the list. Defaults to “On this page”.
Heading levels — which heading levels become links. By default only Heading 2 sections are listed; include Heading 3 or Heading 4 to add finer subsections.
Tips
Use clear, descriptive Heading 2 text — it becomes both the link label and the #fragment in the page address.
Place the block above the sections it lists — it only lists the headings that come after it, so a navigation at the foot of a page lists nothing.
The list updates automatically as you add, rename, or remove headings — there is nothing to keep in sync.
