Table of Contents · React component

Components

An "On this page" list that highlights the section being read.

Import

import { TableOfContents } from '@rinzai/zen';

"On this page": links to the page's headings, highlighting the section being read. Items point at element ids; nested items (depth 2) are indented.

Prop	Type	Default
`items`Required	`TableOfContentsItem[]`	`—`
`className`	`string`	`—`
`title` Shown above the list, and names it. Empty: no heading shown (e.g. under a trigger that says it).	`string`	`—`