Prose

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/prose.json

npx shadcn@latest add @interlace/prose

Import

3 named exports — pull the parts you need.

import { MIN_VIEWPORT, Prose, proseVariants } from '@/components/ui/prose';

Anatomy

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

<article data-slot="prose" data-min-viewport="320" class="prose-interlace …">
    <h1>…</h1>
    <p>…</p>
    <ul><li>…</li></ul>
    <pre><code>…</code></pre>
    <table><thead/><tbody/></table>
  </article>
The `as` prop accepts `'article' | 'div' | 'main' | 'section'` so the
wrapper can be the document root (`main`), a section in a wider
layout (`section`), or a non-landmark container (`div`).

Variants

Closed prop unions enforced by class-variance-authority. See Storybook's Variants story for the rendered matrix.

• variant
  • defaultdefault
  • long

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

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.

Dependencies

Base UI primitive

Native / no Base UI dependency

Lucide icons

none

NPM dependencies

• class-variance-authority

Registry dependencies

• @interlace/theme
• @interlace/cn

Source

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

'use client';

import * as React from 'react';

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

/**
 * @interlace/ui — Prose
 *
 * The article-body wrapper. Renders an `<article>` whose descendants
 * (`h1`–`h6`, `p`, `a`, `ul`/`ol`/`li`, `blockquote`, `code`/`pre`, `table`,
 * `img`) get DS-token-mapped typography without per-element class
 * gymnastics in the consumer. Think MDX-target wrapper: drop a stream of
 * Markdown / MDX inside and it reads like a published article — measure
 * bounded, GFM tables zebra-striped, headings deep-link-anchorable.
 *
 * The descendant cascade lives on the wrapper itself via Tailwind

…216 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.