Textarea

Multi-line text input. A pure surface primitive with no controlled-state machinery: the native `<textarea>` already owns selection, IME, undo/redo, `onChange` etc., so we add structure (size + tone) without wrapping a single native behaviour. Server…

form & inputserver320pxuiv1.1.0

Preview

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

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.

Every semantic colour pair this component's own source uses, measured against the shipped hexes in all 4 theme × scheme combinations. The tightest is input on card at 3.11:1 (interlace · dark), against a floor of 3:1.

Measured WCAG contrast ratios per token pair and theme
PairinterlacelightinterlacedarkharborlightharbordarkFloor
input on cardcontrol border inside a card3.62:13.11:13.62:13.85:13.0:1SC 1.4.11
input on backgroundcontrol border (SC 1.4.11)3.62:13.35:13.43:14.25:13.0:1SC 1.4.11
destructive on backgrounddestructive tint on the page surface8.31:110.43:17.60:110.03:13.0:1SC 1.4.11
muted-foreground on backgroundsecondary copy9.41:111.32:17.82:19.52:14.5:1SC 1.4.3
destructive on carddestructive tint inside a card8.31:19.66:18.02:19.09:13.0:1SC 1.4.11
muted-foreground on cardsecondary copy in a card9.41:110.48:18.25:18.64:14.5:1SC 1.4.3
ring on backgroundfocus ring (SC 2.4.13)8.80:111.79:18.39:110.03:13.0:1SC 1.4.11
ring on cardfocus ring inside a card8.80:110.92:18.86:19.10:13.0:1SC 1.4.11

Text pairs are held to 4.5:1 (WCAG 2.2 SC 1.4.3); borders, rings and chart axes to 3:1 (SC 1.4.11 non-text). Bold is the worst cell in the row — the one a brand fork has to keep an eye on.

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
server component

Renders during SSR / RSC with no hydration cost. It can be imported from a server component without pulling the page into the client.

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
100% × 4

Inside the v8 gate: lines 100, statements 100, functions 100, branches 100. A threshold under 100 only records how much you stopped caring, so there isn't one.

History

This component is at v1.1.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

3 named exports — pull the parts you need.

Public API
import { MIN_VIEWPORT, Textarea, textareaVariants } from '@/components/ui/textarea';

Anatomy

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

<textarea data-slot="textarea" data-min-viewport="320">
    <!-- user content -->
  </textarea>

Variants

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

  • size
    • sm
    • mddefault
    • lg
  • tone
    • defaultdefault
    • invalid
  • resize
    • ydefault
    • none

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.

TextareaProps

Also accepts every <textarea> attribute. Plus the variant props listed above.

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)
Inherited from the preflight focus contract shipped in @interlace/theme.
Reduced motion
No animation to gate.
ARIA in the source
  • aria-invalid

Examples

5 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 native el + VariantProps`React.ComponentProps<'textarea'> & VariantProps<...>`
R6data-slot on the part`data-slot="textarea"` + data-size / data-tone
R7className merged + ...rest`cn(textareaVariants(...), className)` + `{...props}`
R8No `isXxx`; enums for >2 states`size` / `tone` / `resize` are enums
R9Native onChange stays native`onChange` / `onFocus` etc. pass through `{...props}`
R14Declares min viewport`data-min-viewport={String(MIN_VIEWPORT)}` + exported const
R18Tailwind onlyzero inline `style`; cva classes only
R19Tokens onlypadding from `--spacing-*`, size from `--text-*`, radius `--radius-md`, colors via semantic tokens
R20AA contrastmeasured composites — see the table below
R25Server componentno hooks → no `'use client'`
R26A11y from native el`<textarea>` owns focus, keyboard, ARIA, label association

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
  • class-variance-authority
Registry dependencies

Source

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

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

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

/**
 * @interlace/ui — Textarea
 *
 * Multi-line text input. A pure surface primitive with no controlled-state
 * machinery: the native `<textarea>` already owns selection, IME, undo/redo,
 * `onChange` etc., so we add structure (size + tone) without wrapping a
 * single native behaviour. Server component — no hooks, no Base UI client
 * surface required. Inherits the DS font from `preflight.css` (rule #3).
 *
 * ## Anatomy
 *
 *   <textarea data-slot="textarea" data-min-viewport="320">
 *     <!-- user content -->

…117 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.