Form

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

npx shadcn@latest add @interlace/form

Import

8 named exports — pull the parts you need.

import { Field, FieldControl, FieldDescription, FieldError, FieldLabel, FieldValidity, Form, MIN_VIEWPORT } from '@/components/ui/form';

Anatomy

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

<Form action={serverAction}>
    <Field name="email">
      <FieldLabel>Email</FieldLabel>
      <FieldControl render={<Input type="email" required />} />
      <FieldDescription>We'll never share it.</FieldDescription>
      <FieldError />
    </Field>
    <Button type="submit">Sign in</Button>
  </Form>

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

Owned by @base-ui/react/field — 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

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

3 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

@base-ui/react/field

Lucide icons

none

NPM dependencies

• @base-ui/react

Registry dependencies

• @interlace/theme
• @interlace/cn

Source

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

import * as React from 'react';

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

/**
 * @interlace/ui — Form
 *
 * A composition primitive over `@base-ui/react/field`. The form ecosystem owns
 * a long tail of subtle a11y wiring — label/control association via generated
 * ids, `aria-describedby` for description + error, `aria-invalid` flipping on
 * validity, focus management when validation fails. Base UI's `Field.*` parts
 * already encode that contract; this file is the DS skin (R13: ecosystem
 * first — wrap, never re-implement).
 *
 * Two layers ship here:
 *
 *   1. `Form` — a server-component `<form>` wrapper with a server-safe

…227 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.