Sign In Form

Canonical sign-in pattern: title + email + password + submit. Composition of the auth primitive set (Form / Field / Input / Button + Typography for the title). The block owns *structure*; consumers wire `action` / `onSubmit` and pass the brand specifics…

form & inputserver320pxuiv1.2.0

Preview

Sign In Form — live renderblocks-signinform--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/sign-in-form.json
With the @interlace alias
npx shadcn@latest add @interlace/sign-in-form

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

Import

2 named exports — pull the parts you need.

Public API
import { MIN_VIEWPORT, SignInForm } from '@/components/ui/patterns/sign-in-form';

Anatomy

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

SignInForm                       (block — data-min-viewport=320)
    ├─ Typography variant=h3       (title)
    ├─ Typography variant=body     (subtitle — optional)
    ├─ Form                        (the <form> element from primitives/form.tsx)
    │   ├─ Field name="email"
    │   │   ├─ FieldLabel
    │   │   └─ FieldControl render={<Input type="email" />}
    │   ├─ Field name="password"
    │   │   ├─ FieldLabel
    │   │   └─ FieldControl render={<Input type="password" />}
    │   └─ Button type="submit"
    └─ <slot for sign-up link>

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.

SignInFormProps

Also accepts every <form> attribute.

PropTypeDescription
titleReact.ReactNodeHeadline above the form. Defaults to "Sign in".
subtitleReact.ReactNodeOptional supporting copy under the title.
submitLabelReact.ReactNodeLabel on the submit button. Defaults to "Sign in".
actionsReact.ReactNodeSlot beneath the submit button — typically a "Forgot password?" link.
footerReact.ReactNodeSlot below the form — typically a "Don't have an account? Sign up." prompt.

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.

RuleConceptWhere
R4Extends React.ComponentProps`React.ComponentProps<'form'> & SignInFormProps`
R6data-slot on root`data-slot="sign-in-form"`
R7className merged + ...rest`cn(...) + {...props}` on the Form root
R10Composition seam`actions` + `footer` props slot consumer-supplied UI
R13Ecosystem firstBuilt on the primitives layer; no bespoke form state
R14Declares min viewport`data-min-viewport={String(MIN_VIEWPORT)}` + exported const
R18Tailwind onlyZero inline style; classes only
R19Tokens onlySpacing/typography from existing primitives
R25Server componentNo hooks → no `'use client'`
R26A11y from primitivesBase UI Field owns label association + aria-describedby

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
Native / no Base UI dependency
Lucide icons
none
NPM dependencies
none

Source

The full implementation — components/ui/patterns/sign-in-form.tsx once installed.

140 lines · TypeScript
import * as React from 'react';

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

/**
 * @interlace/ui — SignInForm
 *
 * Canonical sign-in pattern: title + email + password + submit. Composition
 * of the auth primitive set (Form / Field / Input / Button + Typography for
 * the title). The block owns *structure*; consumers wire `action` /
 * `onSubmit` and pass the brand specifics (provider name, password-reset
 * link, sign-up link) via props.
 *
 * ## Anatomy
 *
 *   SignInForm                       (block — data-min-viewport=320)
 *     ├─ Typography variant=h3       (title)

…120 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.