Section Index

SectionIndex — the numbered eyebrow: a zero-padded mono numeral in the AAA brand orange beside an uppercase tracked label. The page's sections become a legible sequence ("01 THE AGENDA … 04 THE PROOF"), telling readers there is an order and where they…

navigationserveruiv1.0.0

Preview

Section Index — live renderprimitives-sectionindex--default

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.

Via shadcn URL
npx shadcn@latest add https://ds.interlace.tools/r/section-index.json
With the @interlace alias
npx shadcn@latest add @interlace/section-index

Behavior

What this component does — the keyboard path, the measured colour, the text equivalent and the states it can be in. Every figure below is read out of the test or the source that enforces it by scripts/build-behavior-map.mjs, so nothing here can outlive the gate that keeps it true.

Every semantic colour pair this component's own source uses, measured against the shipped hexes in all 4 theme × scheme combinations. The tightest is muted-foreground on background at 7.82:1 (harbor · light), against a floor of 4.5:1.

Measured WCAG contrast ratios per token pair and theme
PairinterlacelightinterlacedarkharborlightharbordarkFloor
muted-foreground on backgroundsecondary copy9.41:111.32:17.82:19.52:14.5:1SC 1.4.3
muted-foreground on cardsecondary copy in a card9.41:110.48:18.25:18.64:14.5:1SC 1.4.3
primary on backgroundprimary tint on the page surface8.80:111.79:18.39:110.03:13.0:1SC 1.4.11
primary on cardprimary tint inside a card8.80:110.92:18.86:19.10:13.0:1SC 1.4.11

Text pairs are held to 4.5:1 (WCAG 2.2 SC 1.4.3); borders, rings and chart axes to 3:1 (SC 1.4.11 non-text). Bold is the worst cell in the row — the one a brand fork has to keep an eye on.

A chart's alt text is not a sentence about the chart — the equivalent of the data is the data. This is what a screen reader gets, read out of the source the install writes into your tree.

Label, not a data equivalentShips sr-only copy

Ships sr-only copy for what the visual carries by position, colour or icon alone — a label, not a full data equivalent.

Where it renders, how narrow it survives, and whether its lines are inside the coverage gate — three answers a consumer needs before the paste, not after the bug.

Render boundary
server component

Renders during SSR / RSC with no hydration cost. It can be imported from a server component without pulling the page into the client.

Minimum viewport
none declared

No width floor: it takes the width it is given. Its container owns the layout question.

Coverage gate
not in the gate

The 100% gate currently covers src/charts/**/*.{ts,tsx} and src/lib/**/*.{ts,tsx} and src/primitives/{button-variants,data-state-model,meter-scale,skeleton-variants}.ts and src/primitives/{alert,aspect-ratio,avatar,badge,box,breadcrumb,button,callout,card,checkbox,code-editor,container,data-state,focus-ring,grade-badge,grid,input,label,meter,pagination,published-date,reading-time,section,section-boundary,separator,skip-link,stack,stat-strip,tag,textarea,typography,visually-hidden}.tsx and src/patterns/lint-playground.tsx. This file is outside it — the glob widens in phase 7.2.

History

This component is at v1.0.0. The version is stamped as a banner into the file the install writes, so the copy in your tree says which one you have — compare it with the number above before deciding whether to re-run the install.

Unreleased1 entry

  • Addedminor

    SectionIndex — the numbered eyebrow A zero-padded mono numeral in the AAA brand orange (text-primary) beside an uppercase tracked label, making the page's sections a legible sequence ("01 THE AGENDA … 04 THE PROOF"). The numeral counts the way a terminal counts (tabular figures, monospace) and is the view's meaning-point accent; screen readers hear "Section 2: The Agenda", never "zero two". No motion of its own — pass <DecodeText> as the label for the decode gesture. Drops straight into SectionHeader's eyebrow slot.

Import

Single named export.

Public API
import { SectionIndex } from '@/components/ui/section-index';

Anatomy

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

<SectionIndex value={2} data-testid="…">The Agenda</SectionIndex>
  p                (data-slot="section-index" — the eyebrow line)
    ├─ span        (data-slot="section-index-numeral", aria-hidden)
    ├─ span        (sr-only "Section N:")
    └─ children    (the label — string or <DecodeText>)
Fits SectionHeader's `eyebrow` slot directly.

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.

SectionIndexProps

Also accepts every <p> attribute.

PropTypeDescription
value*numberStable selector for E2E tests; consumer provides — no default (R5). */ 'data-testid': string; /** 1-based position in the page's sequence; rendered zero-padded. Coerced to a positive integer (rounded, floored at 1): the spoken "Section N" must never announce "Section 0" or "Section 1.5" (review) — the a11y contract is the headline feature.
children*React.ReactNodeThe eyebrow label — a string, or `<DecodeText>` for the gesture.

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)
Not focusable — no focus indicator required.
Reduced motion
No animation to gate.
ARIA in the source
  • aria-hidden

Examples

2 more states from the same story file.

Dependencies

Base UI primitive
Native / no Base UI dependency
Lucide icons
none
NPM dependencies
none
Registry dependencies

Source

The full implementation — components/ui/section-index.tsx once installed.

90 lines · TypeScript
import * as React from 'react';

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

import { cn } from '@/lib/utils';

/**
 * SectionIndex — the numbered eyebrow: a zero-padded mono numeral in
 * the AAA brand orange beside an uppercase tracked label. The page's sections
 * become a legible sequence ("01 THE AGENDA … 04 THE PROOF"), telling
 * readers there is an order and where they stand in it.
 *
 * One reference law (BRAND_PHILOSOPHY §4): numbered section indices,
 * refracted through the terminal-decode voice — the numeral is
 * monospaced with tabular figures, the way a terminal counts, not a
 * display face. The numeral is the view's meaning-point accent in
 * `text-primary` — the 7:1 AAA-cleared brand orange, because at 14px

…70 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.