# Field (Notchset): prompt.md (v2.0.0)

- id: `field` · version 2.0.0 · component · free
- category: Inputs
- build: one set of files for every shadcn style
- install: `npx shadcn@latest add https://notchset.dev/r/field.json`
- npm dependencies: @base-ui/react@^1
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json
- docs: https://notchset.dev/components/field
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

A label above a control, then a hint or the error, read together. An error marks the control invalid. It also gives every text control the same recessed well and the ink hairline on focus..

## Build it
- Stack: React 18.3 or 19, TypeScript, Tailwind CSS v4 utility classes on the foundation's roles, a components.json (imports use its aliases).
- Packages: `@base-ui/react@^1`.
- Files: `components/ui/notchset/field.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`.
- Builds: one set of files, the same for every shadcn style.
- Exports to keep: `Field`, `FieldControl`, `fieldSurface`, and every exported type.
- CSS: the install adds the notchset foundation (its roles, keyframes and motion switch, reading your shadcn tokens for colour) to your global stylesheet once. Nothing to import by hand.
- Re-running `add` (or `--overwrite`) re-applies those rules: put overrides in your own CSS, never in the installed rules.
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- This item reads `--ns-bad`, `--ns-bad-ink`, `--ns-font-body`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-line`, `--ns-radius`, `--ns-text-body`, `--ns-text-meta`, `--ns-text-small`, `--ns-time-color`, `--ns-well`.
- Retune it (on any ancestor) with the foundation's roles and hooks: `--ns-bad`, `--ns-bad-ink`, `--ns-band`, `--ns-band-edge`, `--ns-band-grade`, `--ns-band-optimal`, `--ns-beat`, `--ns-bezel`, `--ns-canvas`, `--ns-cat-1`, `--ns-cat-2`, `--ns-cat-3`, `--ns-cat-4`, `--ns-cat-5`, `--ns-cat-6`, `--ns-check`, `--ns-chip`, `--ns-control`, `--ns-control-pad`, `--ns-control-sm`, `--ns-deep`, `--ns-deep-ink`, `--ns-deep-ink-2`, `--ns-deep-line`, `--ns-dialog`, `--ns-dialog-lg`, `--ns-dialog-sm`, `--ns-ease`, `--ns-ease-in`, `--ns-ease-panel`, `--ns-ease-pop`, `--ns-field`, `--ns-flood-arc`, `--ns-flood-aurora`, `--ns-flood-behind-1`, `--ns-flood-behind-2`, `--ns-flood-bloom`, `--ns-flood-deep`, `--ns-flood-dial-bloom`, `--ns-flood-glass`, `--ns-flood-grain`, `--ns-flood-image`, `--ns-flood-ink`, `--ns-flood-ink-low`, `--ns-flood-light`, `--ns-flood-mid`, `--ns-flood-pale`, `--ns-flood-pane`, `--ns-flood-pane-edge`, `--ns-flood-pill-ink`, `--ns-flood-ribbon`, `--ns-flood-ribbon-core`, `--ns-flood-shadow`, `--ns-flood-sheen`, `--ns-flood-wash`, `--ns-font-body`, `--ns-font-display`, `--ns-font-mono`, `--ns-font-script`, `--ns-glass`, `--ns-glass-blur`, `--ns-glass-shadow`, `--ns-glow`, `--ns-grain`, `--ns-gutter`, `--ns-header`, `--ns-heat`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-ink-4`, `--ns-leading`, `--ns-lift`, `--ns-light-1`, `--ns-light-2`, `--ns-light-3`, `--ns-light-spread`, `--ns-light-strength`, `--ns-line`, `--ns-line-soft`, `--ns-lit-edge`, `--ns-menu-dy`, `--ns-menu-row`, `--ns-mesh`, `--ns-mesh-frost`, `--ns-ok`, `--ns-ok-ink`, `--ns-orb-body`, `--ns-orb-cool`, `--ns-orb-core`, `--ns-orb-dawn`, `--ns-orb-deep`, `--ns-orb-edge`, `--ns-orb-grain`, `--ns-orb-ground`, `--ns-orb-halo`, `--ns-orb-inner`, `--ns-orb-key`, `--ns-orb-lift`, `--ns-orb-limb`, `--ns-orb-limb-from`, `--ns-orb-rim`, `--ns-orb-skin-hi`, `--ns-orb-skin-lo`, `--ns-orb-skin-mid`, `--ns-orb-warm`, `--ns-panel`, `--ns-panel-w`, `--ns-prism-edge`, `--ns-prism-glint`, `--ns-prism-sheen`, `--ns-prism-tint`, `--ns-pulse`, `--ns-radius`, `--ns-radius-card`, `--ns-radius-full`, `--ns-radius-lg`, `--ns-radius-sm`, `--ns-radius-xl`, `--ns-raised`, `--ns-range`, `--ns-row`, `--ns-row-compact`, `--ns-segment`, `--ns-selected`, `--ns-series`, `--ns-series-core`, `--ns-series-lilac`, `--ns-series-tint`, `--ns-shadow-dialog`, `--ns-shadow-float`, `--ns-shadow-panel`, `--ns-sheet`, `--ns-sheet-bottom`, `--ns-side`, `--ns-signal`, `--ns-sleep-awake`, `--ns-sleep-deep`, `--ns-sleep-light`, `--ns-sleep-rem`, `--ns-space-1`, `--ns-space-2`, `--ns-space-3`, `--ns-space-4`, `--ns-space-5`, `--ns-space-6`, `--ns-space-8`, `--ns-space-section`, `--ns-stack-on`, `--ns-standing-critical`, `--ns-standing-in`, `--ns-standing-out`, `--ns-state-doing`, `--ns-state-done`, `--ns-state-review`, `--ns-state-todo`, `--ns-switch-h`, `--ns-switch-w`, `--ns-text-body`, `--ns-text-control`, `--ns-text-display`, `--ns-text-figure`, `--ns-text-headline`, `--ns-text-hero`, `--ns-text-lede`, `--ns-text-meta`, `--ns-text-page`, `--ns-text-record`, `--ns-text-small`, `--ns-text-strong`, `--ns-text-sub`, `--ns-text-title`, `--ns-tile-shadow`, `--ns-time-born`, `--ns-time-color`, `--ns-time-dialog`, `--ns-time-menu`, `--ns-time-page`, `--ns-time-panel`, `--ns-time-toast`, `--ns-tint`, `--ns-tint-ink`, `--ns-toast-bottom`, `--ns-toast-left`, `--ns-touch`, `--ns-tracking-display`, `--ns-tracking-headline`, `--ns-warn`, `--ns-warn-ink`, `--ns-wash-clay`, `--ns-wash-dusk`, `--ns-wash-graphite`, `--ns-wash-ink`, `--ns-wash-sage`, `--ns-wash-sand`, `--ns-weight-light`, `--ns-weight-medium`, `--ns-weight-regular`, `--ns-weight-strong`, `--ns-well`.
- Never add Tailwind colour classes inside the component.

```tsx
import { Field, FieldControl, fieldSurface } from "@/components/ui/notchset/field";
```

## Parts
- A single export that takes props.

## Match the original
- Read `components/ui/notchset/field.tsx` as the reference implementation before changing or recreating anything, and match it: sizes, colours per theme, motion timings, copy and behaviour.
- If you deviate (a prop you can't honour, a style you changed, a dependency you swapped), say so in your reply, part by part.
- Keep the accessibility contract, the keyboard map and the motion levels listed below.

## Use it when

### Not when

## Mistakes
- Recreating the component instead of installing it

## Usage

```tsx
"use client";
import * as React from "react";
import { Field, FieldControl, fieldSurface } from "@/components/ui/notchset/field";

/* Field gives any control its label and its hint or error; TextField and TextArea are built on it. */
export default function FieldDemo() {
  const [seats, setSeats] = React.useState("12");
  const n = Number(seats);
  const error = !seats.trim() || !Number.isInteger(n) || n < 1 ? "A whole number of seats, like 12" : n > 10 ? "Growth holds 10 seats. Pick Scale for more." : undefined;
  return (
    <div className="w-[280px]">
      <Field label="Seats" hint="Everyone who signs in needs one" error={error}>
        <FieldControl inputMode="numeric" value={seats} onChange={(e) => setSeats(e.target.value)} className={`${fieldSurface} h-[var(--ns-field)]`} />
      </Field>
    </div>
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `label` | `React.ReactNode` |  |  |
| `hint` | `React.ReactNode` |  |  |
| `error` | `React.ReactNode` |  | Shown under the control and read with it; also marks the control invalid. |
| `disabled` | `boolean` |  |  |
| `name` | `string` |  |  |

Full docs: https://notchset.dev/components/field

## Customising
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- Dark mode follows the `.dark` class or `data-theme="dark"` on an ancestor (the shadcn and next-themes conventions).
- Update later: Commit or stash local changes first (or copy the files), so the update can be undone. Read https://notchset.dev/r/changelog.json for the new versions: a major version, an entry marked breaking or a merge says what to change. Then re-run the install with `--overwrite`, on a branch. It replaces the component's files, the shared helper files they import, and the item's CSS rules in the global stylesheet, so review the whole diff (components, shared files, CSS), re-apply your own edits, and run the app's typecheck, tests and build.

## Accessibility contract (preserve when editing)

## Install

```bash
npx shadcn@latest add https://notchset.dev/r/field.json
```

Or add the `@notchset` registry to components.json and run `npx shadcn@latest add @notchset/field`. Every components.json style gets the same files.

## Continue the workflow

- [Inline edit](https://notchset.dev/components/inline-edit)
- [Recipient field](https://notchset.dev/components/recipient-field)
- [Search field](https://notchset.dev/components/search-field)

## Source

### components/ui/notchset/field.tsx

```tsx
// Notchset field 2.0.0 · https://notchset.dev/changelog
"use client";
import * as React from "react";
import { Field as Base } from "@base-ui/react/field";
import { cn } from "@/lib/utils";

/*
 * Field: a label above a control, then a hint or the error. The label is tied to the control, the hint and
 * error are read with it, and an error marks the control invalid. Every input in the system sits in one.
 *
 * fieldSurface is the well every text control is drawn in (text field, text area, select, combobox, search):
 * a recessed well with a hairline, and on focus an ink hairline with a soft ink halo. Orange is never a focus
 * colour; it means "where you are". On touch screens text is 16px so phones do not zoom into the field.
 */
export const fieldSurface =
  "w-full min-w-0 rounded-[var(--ns-radius)] bg-[var(--ns-well)] px-2.5 font-[family-name:var(--ns-font-body)] text-[length:var(--ns-text-body)] text-[var(--ns-ink)] shadow-[inset_0_0_0_1px_var(--ns-line)] outline-hidden [transition:box-shadow_var(--ns-time-color)] pointer-coarse:text-[16px] [&[type=number]]:[appearance:textfield] [&::-webkit-inner-spin-button]:appearance-none [&::-webkit-outer-spin-button]:appearance-none " +
  "placeholder:text-[var(--ns-ink-3)] " +
  "focus:shadow-[inset_0_0_0_1px_var(--ns-ink-2),0_0_0_3px_color-mix(in_oklab,var(--ns-ink)_10%,transparent)] focus-within:shadow-[inset_0_0_0_1px_var(--ns-ink-2),0_0_0_3px_color-mix(in_oklab,var(--ns-ink)_10%,transparent)] " +
  "aria-invalid:shadow-[inset_0_0_0_1px_var(--ns-bad)] data-invalid:shadow-[inset_0_0_0_1px_var(--ns-bad)] " +
  "disabled:cursor-default disabled:opacity-45 data-disabled:opacity-45";

type FieldProps = {
  label?: React.ReactNode;
  hint?: React.ReactNode;
  /** Shown under the control and read with it; also marks the control invalid. */
  error?: React.ReactNode;
  disabled?: boolean | undefined;
  name?: string | undefined;
  className?: string | undefined;
  children: React.ReactNode;
};

function Field({ label, hint, error, disabled, name, className, children }: FieldProps) {
  return (
    <Base.Root
      data-slot="field"
      invalid={Boolean(error)}
      disabled={disabled}
      name={name}
      className={cn("flex min-w-0 flex-col gap-1.5 text-[length:var(--ns-text-small)] text-[var(--ns-ink-2)]", className)}
    >
      {label && <Base.Label className="w-fit">{label}</Base.Label>}
      {children}
      {error ? (
        <Base.Error match className="text-[length:var(--ns-text-meta)] text-[var(--ns-bad-ink)]">
          {error}
        </Base.Error>
      ) : hint ? (
        <Base.Description className="text-[length:var(--ns-text-meta)] text-[var(--ns-ink-3)]">{hint}</Base.Description>
      ) : null}
    </Base.Root>
  );
}

/** The control slot of a Field: whatever element is rendered gets the label, hint and error wiring. */
const FieldControl = Base.Control;

export { Field, FieldControl, type FieldProps };
```

The foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://notchset.dev/r/notchset-foundation.json.