Skip to content
duxt

DuxtToc

The table of contents, and the aside under it.

The headings of the current page, tracking as the reader scrolls, plus the configured aside links beneath.

Usage

<DuxtToc :links="page?.body?.toc?.links ?? []" />

API

Props

PropTypeNotes
linksTocLink[]Required — Content's own toc links

Notes

Which heading is current comes from useActiveHeading(), which watches the headings rather than the scroll offset — a short last section is still reported as reached.

The aside.links block below it ships empty: a repository link, an issue tracker or a community belongs to whoever runs the site.

Was this page helpful?