Registry Item Template

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/registry-item-template.json

npx shadcn@latest add @interlace/registry-item-template

Import

2 named exports — pull the parts you need.

import { MIN_VIEWPORT, RegistryItemTemplate } from '@/components/ui/templates/registry-item-template';

Anatomy

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

<article data-slot="registry-item-template" data-min-viewport="320">
    <Container size="content">
      <SectionBoundary name="registry-item-header">
        Header: name + description + install command
      </SectionBoundary>
      <SectionBoundary name="registry-item-anatomy">
        Anatomy / API surface
      </SectionBoundary>
      <SectionBoundary name="registry-item-variants">
        Variant matrix (CVA-driven)
      </SectionBoundary>
      <SectionBoundary name="registry-item-related">
        Related components
      </SectionBoundary>
    </Container>
  </article>

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)

Not focusable — no focus indicator required.

Reduced motion

No animation to gate.

ARIA in the source

• role="status"
• aria-busy
• 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/container
• @interlace/section-boundary
• @interlace/skeleton
• @interlace/stack
• @interlace/typography

Source

The full implementation — components/ui/templates/registry-item-template.tsx once installed.

import * as React from 'react';

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

/**
 * @interlace/ui — RegistryItemTemplate
 *
 * Full-page surface for a single registry item's documentation
 * (`/c/[name]` on ds.interlace.tools). Composes the header (item name +
 * description + install snippet), the anatomy diagram, the variants
 * matrix, related-components grid, and a CTA back to the registry —
 * each in its own `<SectionBoundary>` so the page streams
 * section-by-section.
 *
 * The DS eats its own dog food here: the registry app's `/c/[name]/page.tsx`
 * uses this template instead of hand-rolling the layout per-item.
 *

…214 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.