Toc

Preview

Rendered from the story the storybook (a11y) CI gate runs axe against — the preview can't show something that hasn't been verified.

Install

Two equivalent paths — the URL works in any shadcn-CLI setup; the alias works once you've registered @interlace in your components.json.

npx shadcn@latest add https://ds.interlace.tools/r/toc.json

npx shadcn@latest add @interlace/toc

Import

4 named exports — pull the parts you need.

import { MIN_VIEWPORT, Toc, TocItem, TocPopover } from '@/components/ui/toc';

Anatomy

Extracted from the primitive's JSDoc header. The source is the only documentation that can't drift.

Toc                                  (nav — data-min-viewport=480)
    └─ <ol data-slot="toc-list">       (top-level heading list)
         └─ <li data-slot="toc-item" data-level="2|3|4" data-active>
              └─ <a data-slot="toc-link" href="#…">
  TocPopover                           (Popover wrapper — data-min-viewport=480)
    ├─ <Popover.Trigger> "On this page"
    └─ <Popover.Content> ⟶ <Toc />

API reference

Parsed from the type declarations in the source — the same file the install writes into your tree, so this table can't drift from the component you get.

Accessibility

Every story for this component is rendered headlessly and checked with axe-core (wcag2aa, wcag22aa, best-practice, ACT) on every PR. That gate has no continue-on-error, so what ships has zero known violations.

What follows is what static analysis can see. Axe cannot press a key and never sees an overlay open, so the operable-without-a-mouse claim lives in Behavior instead, where the keyboard path is replayed step by step.

Focus + keyboard behaviour

Native element semantics — no interaction layer to get wrong.

Focus ring (WCAG 2.2 SC 2.4.13)

Inherited from the preflight focus contract shipped in @interlace/theme.

Reduced motion

Animation is gated on prefers-reduced-motion.

ARIA in the source

• aria-current
• aria-label

Examples

4 more states from the same story file.

R-rule compliance

Every primitive in @interlace/ui models to the portable 26-rule floor enforced by the componentApi ESLint preset. The cells below pin exactly where each rule applies in this file.

Dependencies

Base UI primitive

Native / no Base UI dependency

Lucide icons

none

NPM dependencies

none

Registry dependencies

• @interlace/theme
• @interlace/cn
• @interlace/popover
• @interlace/use-reduced-motion

Source

The full implementation — components/ui/toc.tsx once installed.

'use client';

import * as React from 'react';

// @interlace/toc v1.0.0 — Interlace design system.
// Docs, props and live preview: https://ds.interlace.tools/c/toc
// What changed since: https://ds.interlace.tools/c/toc#history
// Generated banner — keep it, the upgrade diff reads this version.

/**
 * @interlace/ui — Toc + TocPopover
 *
 * The in-page Table of Contents. Long-form pages (docs, MDX articles, rule
 * reference) need a persistent navigation rail that mirrors the heading
 * outline so a reader can both orient themselves and jump. On wide
 * viewports this lives in a right-hand rail (`Toc`); on narrow viewports
 * it folds into a popover trigger (`TocPopover`) so the content column
 * keeps the full reading width.
 *
 * Two contracts make this primitive non-trivial:

…268 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.