Table of Contents
Scroll-spy outline: an ember marker slides to the section you are reading, and links scroll smoothly.
- Category: Navigation
- Licence: Charcoal UI Pro
- Built with: React 19, Tailwind CSS 4, Motion
- Dependencies: motion, clsx, tailwind-merge
Examples
Table of Contents
API reference
| Prop | Type | Default | Description |
|---|---|---|---|
items | { id: string; label: string; level?: 1 | 2 | 3 }[] | — | |
container | RefObject<HTMLElement> | — | Defaults to the page. |
About Table of Contents
Table of Contents is a scroll-spy outline: a marker slides to the section you are reading and links scroll smoothly to their heading. It keeps long pages navigable.
Table of Contents is a navigation component for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.
When to use Table of Contents
- Documentation pages.
- Long blog posts and guides.
- Legal and policy pages.
- Changelogs and release notes.
How it works
An IntersectionObserver tracks which heading is in view and the marker follows on a spring. Links are real anchors, so they work without script and update the URL hash.
Links and buttons keep their roles, arrow keys move where a group is expected, the current item is marked with aria-current, and focus is always visible. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.
Customizing Table of Contents
Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.
Style it with className like any other element. It only uses your theme's tokens, so it follows light and dark mode without extra work.
- items.
- container (RefObject<HTMLElement>): Defaults to the page.
Goes well with Table of Contents
These navigation pieces share its tokens and motion language, so they sit together on one page without clashing.
- Dock: A macOS-style React dock whose icons swell with pointer distance and show labels
- Expandable Tabs: Compact React icon tabs where the active tab expands to reveal its label
- Floating Nav: A floating React pill nav that hides on scroll down and returns on scroll up
- Context Menu: A React right-click context menu that opens at the pointer and stays on screen
- Bottom Nav: An animated React mobile tab bar with a sliding pill, hopping icons and badges
Install Table of Contents
npx shadcn@latest add @charcoal/table-of-contentsTable of Contents is part of Charcoal UI Pro. One seat unlocks all 300 Pro components, 107 landing-page sections and 100 full templates, for every personal and client project, with updates included. Add the @charcoal registry once with your access token, then the command above copies table-of-contents.tsx into components/ui and installs clsx, tailwind-merge.
You own the file you install: no runtime package, no lock-in, nothing to keep in sync. Change it however your product needs.
See Charcoal UI Pro pricing · Pro setup
Frequently asked questions
- How do I install Table of Contents?
- Table of Contents is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/table-of-contents. It copies table-of-contents.tsx into components/ui and installs motion, clsx, tailwind-merge.
- Is Table of Contents free for commercial use?
- Table of Contents needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.
- Does Table of Contents work with Next.js?
- Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
- Can an AI coding agent install Table of Contents?
- Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Table of Contents's props and get_install_command returns the exact command.