Skip to content

TOC

On-this-page navigation — scroll-spy with animated active indicator and depth-aware indentation.

Installation

npx nimbus-docs add toc

Preview

<TOC
headings={[
  { depth: 2, text: "Getting started", slug: "getting-started" },
  { depth: 2, text: "Configuration", slug: "configuration" },
  { depth: 3, text: "Sidebar", slug: "sidebar" },
  { depth: 3, text: "Search", slug: "search" },
  { depth: 2, text: "Deployment", slug: "deployment" },
]}
/>

API reference

Every prop the component accepts, sourced from a single declaration.

Prop Type
headings required
TOCItem[]
Components

Type to search…

↑↓ navigate ↵ select Esc close