Collapsible

A single open/close disclosure surface. Wraps Base UI's `Collapsible.Root`, `Collapsible.Trigger`, `Collapsible.Panel` so consumers get the controlled / uncontrolled state machine, ARIA wiring (`aria-controls`, `aria-expanded`, `id`), keyboard semantics…

navigationclient320pxuiv1.0.0

Preview

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

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.

4 steps, 2 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 expandsEnter
  3. 3The open panel is wired to its trigger
  4. 4Space collapsesSpace

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

Import

4 named exports — pull the parts you need.

Public API
import { Collapsible, CollapsiblePanel, CollapsibleTrigger, MIN_VIEWPORT } from '@/components/ui/collapsible';

Anatomy

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

Collapsible (Base.Root, data-min-viewport)
    ├─ CollapsibleTrigger (Base.Trigger — button surface)
    └─ CollapsiblePanel   (Base.Panel — height-animated container)

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.

Collapsible

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

CollapsibleTrigger

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

CollapsiblePanel

Also accepts every prop of Base UI's <Collapsible.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/collapsible — focus trapping, dismissal and typeahead come from the headless primitive, not from us.
Focus ring (WCAG 2.2 SC 2.4.13)
Not focusable — no focus indicator required.
Reduced motion
Animation is gated on prefers-reduced-motion.
ARIA in the source
None — semantics come from the element or the Base UI primitive rather than hand-written ARIA.

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.

RuleConceptWhere
R4Extends Base UI part propsEach part: `React.ComponentProps<typeof BaseCollapsible.X>`
R6data-slot on every partdata-slot="collapsible" / "collapsible-trigger" / "collapsible-panel"
R7className merged + ...rest`cn(BASE, className)` + `{...props}` on every part
R10Composition seamBase UI parts are renderable / slot-friendly out of the box
R13Ecosystem firstBase UI Collapsible — no bespoke disclosure state machine
R14Declares min viewport`data-min-viewport={String(MIN_VIEWPORT)}` + exported const
R18Tailwind onlyZero inline `style`; classes only
R19Tokens only`text-ui font-medium` from foundation tokens (no raw px / colors)
R20AA contrastTrigger inherits foreground; focus ring from preflight
R25Client componentBase UI Collapsible is a client surface → `'use client'` required
R26A11y from Base UIaria-expanded / aria-controls / Enter+Space owned by Base UI

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

Lucide icons
none
NPM dependencies
  • @base-ui/react
Registry dependencies

Source

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

132 lines · TypeScript
'use client';

import * as React from 'react';

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

/**
 * @interlace/ui — Collapsible
 *
 * A single open/close disclosure surface. Wraps Base UI's `Collapsible.Root`,
 * `Collapsible.Trigger`, `Collapsible.Panel` so consumers get the controlled /
 * uncontrolled state machine, ARIA wiring (`aria-controls`, `aria-expanded`,
 * `id`), keyboard semantics (Enter / Space on the trigger), and Base UI's
 * built-in panel sizing — for free. Reduced-motion is honoured globally via
 * `preflight.css` (every animation collapses to 0.01ms when
 * `prefers-reduced-motion: reduce`), so this file owns no motion timing.
 *

…112 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.