Skip to content
TrademarkTrademark
Docs
Modules

HeadingNav

Updated: May 13, 2025
View on GitHub

The HeadingNav component provides an automatic table of contents navigation that highlights the current section as you scroll through the page.

Features

  • Automatically detects and displays page headings
  • Highlights the current section while scrolling
  • Smooth scrolling to sections when clicking links
  • Responsive and accessible navigation

Usage

Simply add the HeadingNav component to your page and use HeadingLink or Heading components for your section headings.

Customization

The HeadingNav component inherits styles from its parent container and can be customized using standard CSS properties.

API reference

Type
Default
header
Show the "On this page" heading above the links.
booleantrue
…and every FlexProps propinherited—
Edit this page on GitHub