Accordion

A disclosure stack: a column of headers whose panels open and close. Wraps @base-ui/react/accordion — Base UI owns the open state (single or multiple), the keyboard model and every piece of the accordion ARIA.

navigationclient320pxuiv1.2.0

Preview

Accordion — live renderprimitives-accordion--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/accordion.json
With the @interlace alias
npx shadcn@latest add @interlace/accordion

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.

5 steps, 3 key presses — replayed on every PR by the play function of KeyboardFlow. Axe cannot press a key, so this — not the a11y scan — is what proves the component is operable without a mouse.

  1. 1Starts collapsed and announces it
  2. 2Enter expands the panelEnter
  3. 3The open panel is wired to its trigger
  4. 4Space collapses it againSpace
  5. 5Tab reaches the next triggerTab

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
ring on backgroundfocus ring (SC 2.4.13)8.80:111.79:18.39:110.03:13.0:1SC 1.4.11
ring on cardfocus ring 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.

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
'use client'

Hydrates. It brings JavaScript to any route that imports it — put the boundary here, not at the page.

Minimum viewport
MIN_VIEWPORT = 320

Declared, not assumed. Below 320 CSS px the preflight contract draws a dev-mode outline — how to switch it on.

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.2.0, first shipped in @interlace/ui 1.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.

@interlace/ui 1.1.01 entry

  • Changedpatch

    Six defects found by upgrading a real consumer, plus five found by reading the components closely enough to document them. **Meteors' glow never painted.** It read var(--color-meteor-glow) while its cssVars declare --meteor-glow; --color-* is the Tailwind @theme namespace and only cssVars.theme populates it, so the whole box-shadow was invalid at computed-value time. **This was broken only for registry consumers** — our own docs site hand-declares the --color- form. **ArticleCard cropped 28% off every cover.** h-44 is 176px; at a ~302px tile that is a 1.72:1 box against a 2.381:1 image. Now aspect-[1000/420] — the ratio the card already declared on its <img>. It also gains a renderImage slot, because every Next.js consumer was re-patching the same line to use next/image and the design system cannot depend on it. **BorderBeam and StarsBackground had no aria-hidden at all** — six purely decorative nodes a screen reader walked. **CloudParticles defaulted bodyColor to currentColor**, painting volumetric clouds in the inherited text colour. **NumberTicker gains notation**, because six-figure metrics overflow a tile at 320px. Also: SheetCompose and DialogCompose each mounted a second backdrop, so a composed dialog dimmed the page twice as much as the hand-composed tree the docs show; Accordion dropped className on the animated Panel; Tooltip accepted delay and discarded it; PopoverAnchor was a second trigger. **useReducedMotion was one frame late.** The canonical useState(false) plus effect returns false on the first render, so every gated component painted one frame of exactly the motion the user turned off. useSyncExternalStore reads during render and closes that on client renders; on hydration the server cannot know the preference, which is what the stylesheet reset is for. Badge drops 'use client' — verified with a real server-component build.

@interlace/ui 1.0.01 entry

Import

5 named exports — pull the parts you need.

Public API
import { Accordion, AccordionContent, AccordionItem, AccordionTrigger, MIN_VIEWPORT } from '@/components/ui/accordion';

Anatomy

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

Accordion                        (Base UI Accordion.Root — data-min-viewport=320)
    └─ AccordionItem               (border-b, dropped on the last item)
         ├─ AccordionTrigger       (Accordion.Header > Accordion.Trigger + ChevronDownIcon)
         └─ AccordionContent       (Accordion.Panel > div)
Every node above carries a `data-slot`, including the two that used not to:
the `Accordion.Header` around the trigger button (`accordion-header`) and the
padding `div` inside the panel (`accordion-content-inner`).

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.

AccordionItem

Also accepts every prop of Base UI's <Accordion.Item> — behaviour we compose rather than reimplement.

AccordionTrigger

Also accepts every prop of Base UI's <Accordion.Trigger> — behaviour we compose rather than reimplement.

AccordionContent

Also accepts every prop of Base UI's <Accordion.Panel> — behaviour we compose rather than reimplement.

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
Owned by @base-ui/react/accordion — focus trapping, dismissal and typeahead come from the headless primitive, not from us.
Focus ring (WCAG 2.2 SC 2.4.13)
Inherited from the preflight focus contract shipped in @interlace/theme.
Reduced motion
No animation to gate.
ARIA in the source
None — semantics come from the element or the Base UI primitive rather than hand-written ARIA.

Examples

2 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.

RuleConceptWhere
R4Extends Base UI part propsevery wrapper is `React.ComponentProps<typeof BaseAccordion.*>`
R6data-slot per partaccordion / -item / -header / -trigger / -content / -content-inner
R7cn + ...rest`cn('border-b last:border-b-0', className)` + `{...props}`
R12Reuse over wrapBase UI owns open state, keyboard and ARIA
R14Declares min viewport`data-min-viewport={String(MIN_VIEWPORT)}` on the root
R19Tokens only`text-muted-foreground`, `ring-ring/50`, `border-ring`
R25Client componentRequired — Base UI Accordion ships client hooks
R26A11y from upstream`Accordion.Header` + `Trigger` emit the button/region pair

Minimum viewport

This primitive declares MIN_VIEWPORT = 320 CSS px (DESIGN_PRINCIPLES #14). When mounted in a container narrower than this, the preflight contract draws a dev-mode outline so the regression is visible during local development.

Opt-in to the dev-mode warning
<body data-interlace-dev>...</body>

Add the data-interlace-dev attribute to the body in development builds only — preflight then outlines any primitive whose container is below its declared data-min-viewport.

Dependencies

Base UI primitive
@base-ui/react/accordion
Lucide icons
  • ChevronDownIcon
NPM dependencies
  • @base-ui/react
  • lucide-react
Registry dependencies

Source

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

146 lines · TypeScript
'use client';

import * as React from 'react';

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

/**
 * @interlace/ui — Accordion
 *
 * A disclosure stack: a column of headers whose panels open and close. Wraps
 * @base-ui/react/accordion — Base UI owns the open state (single or multiple),
 * the keyboard model and every piece of the accordion ARIA.
 *
 * We own the item divider, the trigger row, and the chevron that rotates on
 * `data-panel-open`.
 *
 * ## Anatomy

…126 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.