# Recipient field (Notchset): prompt.md (v2.0.0)

- id: `recipient-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/recipient-field.json`
- npm dependencies: @base-ui/react@^1, lucide-react@^1
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json, @notchset/avatar, @notchset/field
- docs: https://notchset.dev/components/recipient-field
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

Who an email goes to: a chip per person with their avatar. Type a name or address and Enter adds the first match; Backspace takes off the last chip. A full new address can be added as itself..

## 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`, `lucide-react@^1`.
- Files: `components/ui/notchset/recipient-field.tsx`; shared code: `lib/notchset/popup.ts`, `lib/notchset/portal.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`, `avatar`, `field`.
- Builds: one set of files, the same for every shadcn style.
- Exports to keep: `RecipientField`, `matchRecipients`, 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-ease`, `--ns-ease-panel`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-line`, `--ns-line-soft`, `--ns-menu-row`, `--ns-radius-lg`, `--ns-radius-xl`, `--ns-raised`, `--ns-shadow-float`, `--ns-sheet-bottom`, `--ns-text-body`, `--ns-text-meta`, `--ns-text-small`, `--ns-time-menu`, `--ns-time-panel`, `--ns-weight-medium`, `--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 { RecipientField, type Recipient } from "@/components/ui/notchset/recipient-field";
```

## Parts
- A single export that takes props.

## Match the original
- Read `components/ui/notchset/recipient-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

## Built from
- avatar (`avatar`), installed with it: reuse it, don't rebuild it
- field (`field`), installed with it: reuse it, don't rebuild it
- Popup placement (shared helper, ships with it)
- Portal (shared helper, ships with it)

## Mistakes
- Recreating the component instead of installing it

## Usage

```tsx
"use client";
import * as React from "react";
import { RecipientField, type Recipient } from "@/components/ui/notchset/recipient-field";

const PEOPLE: Recipient[] = [
  { id: "ana", name: "Ana Ruiz", email: "ana@airtable.com" },
  { id: "kevin", name: "Kevin Ito", email: "kevin@airtable.com" },
  { id: "priya", name: "Priya Shah", email: "priya@sentry.io" },
  { id: "marcus", name: "Marcus Bell", email: "marcus@calendly.com" },
  { id: "lena", name: "Lena Ortiz", email: "lena@framer.com" },
];

export default function RecipientFieldDemo() {
  const [to, setTo] = React.useState<Recipient[]>([PEOPLE[0]!, PEOPLE[1]!]);
  return (
    <label className="flex w-full max-w-[560px] flex-col gap-1.5 text-[length:var(--ns-text-small)] text-[var(--ns-ink-2)]">
      <span>
        To <span className="text-[var(--ns-ink-3)]">· {to.length}</span>
      </span>
      <RecipientField aria-label="To" people={PEOPLE} value={to} onValueChange={setTo} />
    </label>
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `people` | `Recipient[]` |  | Required. |
| `value` | `Recipient[]` |  | Required. |
| `onValueChange` | `(value: Recipient[]) => void` |  | Required. |
| `elsewhere` | `Recipient[]` |  | Addresses already in the envelope's other fields (Cc, Bcc): typing one exactly adds nothing, never moves it. |
| `aria-label` | `string` |  |  |
| `placeholder` | `string` | `"Add a name or address"` |  |

Full docs: https://notchset.dev/components/recipient-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/recipient-field.json
```

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

## Continue the workflow

- [Thread list](https://notchset.dev/blocks/thread-list)
- [Email message](https://notchset.dev/blocks/email-message)
- [Email preview](https://notchset.dev/blocks/email-preview)

## Source

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

```tsx
// Notchset recipient-field 2.0.0 · https://notchset.dev/changelog
"use client";
import * as React from "react";
import { Combobox as Base } from "@base-ui/react/combobox";
import { X } from "lucide-react";
import { cn } from "@/lib/utils";
import { Avatar } from "@/components/ui/notchset/avatar";
import { fieldSurface } from "@/components/ui/notchset/field";
import { popupEmpty, popupItem, popupPositioner, popupSurface } from "@/lib/notchset/popup";
import { usePortalContainer } from "@/lib/notchset/portal";

/*
 * Recipient field: who an email goes to. Each person is a chip with their avatar and name; type to find
 * someone (by name or address), Enter adds the first match, Backspace in the empty input takes off the last
 * chip, and a comma adds what you typed. A full address nobody has yet can be added as itself. Chips say their
 * address on hover. Matches are ranked: names that start with what you typed, then a later word of a name, then
 * an address or the line under it (a role, "Emailed before"). A chip marked `fresh` is someone new to the
 * conversation and is drawn with a dashed edge.
 */
type Recipient = { id: string; name: string; email: string; src?: string | undefined; hue?: number | undefined; sub?: string | undefined; fresh?: boolean | undefined };
type RecipientFieldProps = {
  people: Recipient[];
  value: Recipient[];
  onValueChange: (value: Recipient[]) => void;
  /** Addresses already in the envelope's other fields (Cc, Bcc): typing one exactly adds nothing, never moves it. */
  elsewhere?: Recipient[] | undefined;
  "aria-label"?: string | undefined;
  placeholder?: string | undefined;
  className?: string | undefined;
};

const EMAIL = /^[^\s@]+@[^\s@]+\.[^\s@]{2,}$/;

/** The people a query finds, ranked, plus the typed address itself when it's new. */
function matchRecipients(people: Recipient[], value: Recipient[], query: string, elsewhere: Recipient[] = []): Recipient[] {
  const q = query.trim().toLowerCase();
  const chosen = new Set(value.map((p) => p.id));
  const toks = q.split(/\s+/).filter(Boolean);
  const words = (p: Recipient) => `${p.name} ${p.email} ${p.sub ?? ""}`.toLowerCase().split(/[\s.@·,()-]+/);
  /* an exact address always comes first, so Enter or comma never takes a longer one that starts with it */
  const rank = (p: Recipient) => (q && p.email.toLowerCase() === q ? -1 : !q || p.name.toLowerCase().startsWith(q) ? 0 : p.name.toLowerCase().split(/\s+/).some((w) => w.startsWith(toks[0]!)) ? 1 : 2);
  const matches = people
    /* a typed address (or the start of one) finds its person as well as any word of their name does */
    .filter((p) => !chosen.has(p.id) && (p.email.toLowerCase().startsWith(q) || toks.every((t) => words(p).some((w) => w.startsWith(t)))))
    .map((p, i) => [p, rank(p), i] as const)
    .sort((a, b) => a[1] - b[1] || a[2] - b[2])
    .map((x) => x[0])
    .slice(0, toks.length ? 7 : 5);
  const known = people.some((p) => p.email.toLowerCase() === q) || value.some((p) => p.email.toLowerCase() === q);
  if (!EMAIL.test(q)) return matches;
  /* a whole address means that address: itself first (or as new), never a longer one that starts with it; already
     added means nothing to add */
  if ([...value, ...elsewhere].some((p) => p.email.toLowerCase() === q)) return [];
  const exact = matches.filter((p) => p.email.toLowerCase() === q);
  return known ? exact : [{ id: q, name: q, email: q }];
}

function RecipientField({ people, value, onValueChange, elsewhere, placeholder = "Add a name or address", className, ...aria }: RecipientFieldProps) {
  const portalContainer = usePortalContainer();
  const [query, setQuery] = React.useState("");
  const q = query.trim().toLowerCase();
  const items = matchRecipients(people, value, query, elsewhere);

  return (
    <Base.Root
      multiple
      items={items}
      filter={null}
      value={value}
      onValueChange={(next) => {
        onValueChange(next as Recipient[]);
        setQuery("");
      }}
      inputValue={query}
      onInputValueChange={setQuery}
      itemToStringLabel={(p: Recipient) => p.name}
      isItemEqualToValue={(a: Recipient, b: Recipient) => a.id === b.id}
      autoHighlight
    >
      <Base.InputGroup data-slot="recipient-field" className={cn(fieldSurface, "flex min-h-9 cursor-text flex-wrap items-center gap-1.5 px-2 py-[5px]", className)}>
        <Base.Chips className="contents">
          {value.map((p) => (
            <Base.Chip
              key={p.id}
              title={p.fresh ? `${p.email || p.name} · new to this conversation` : p.email}
              aria-label={p.fresh ? `${p.name}, new to this conversation` : p.name}
              className={cn(
                "inline-flex h-6 items-center gap-1.5 rounded-full bg-[var(--ns-well)] px-1 text-[length:var(--ns-text-small)] font-[number:var(--ns-weight-medium)] text-[var(--ns-ink)] shadow-[inset_0_0_0_1px_var(--ns-line-soft)] outline-hidden data-highlighted:shadow-[inset_0_0_0_1px_var(--ns-ink-2)] pointer-coarse:h-8",
                p.fresh && "bg-transparent shadow-none outline-1 -outline-offset-1 outline-[var(--ns-ink-3)] outline-dashed",
              )}
            >
              <Avatar name={p.name} src={p.src} hue={p.hue} size={18} />
              <span className="max-w-[180px] truncate">{p.name}</span>
              <Base.ChipRemove
                aria-label={`Remove ${p.name}`}
                className="grid size-[18px] cursor-pointer place-items-center rounded-full text-[var(--ns-ink-3)] hover:bg-[var(--ns-hover)] hover:text-[var(--ns-ink)] pointer-coarse:size-7"
              >
                <X className="size-3" aria-hidden />
              </Base.ChipRemove>
            </Base.Chip>
          ))}
          <Base.Input
            placeholder={value.length ? "" : placeholder}
            onKeyDown={(e) => {
              if (e.key !== "," || !q) return;
              e.preventDefault();
              const first = items[0];
              if (first) onValueChange([...value, first]);
              /* an address that's already added just clears the box */
              if (first || EMAIL.test(q.trim())) setQuery("");
            }}
            {...aria}
            className="h-6 min-w-24 flex-1 bg-transparent outline-hidden placeholder:text-[var(--ns-ink-3)] pointer-coarse:h-8"
          />
        </Base.Chips>
      </Base.InputGroup>
      <Base.Portal container={portalContainer}>
        <Base.Positioner sideOffset={4} collisionPadding={8} className={popupPositioner}>
          <Base.Popup data-slot="recipient-popup" data-ns-moves="" className={popupSurface}>
            <Base.Empty className={popupEmpty}>{q ? "No one matches. Type a full address to add it." : "Everyone is already added."}</Base.Empty>
            <Base.List>
              {(p: Recipient) => (
                <Base.Item key={p.id} value={p} className={popupItem}>
                  <Avatar name={p.name} src={p.src} hue={p.hue} size={20} />
                  {p.id === p.email && !people.some((x) => x.id === p.id) ? (
                    <span className="min-w-0 flex-1 truncate">
                      Send to <b className="font-[number:var(--ns-weight-medium)]">{p.email}</b>
                    </span>
                  ) : (
                    <span className="flex min-w-0 flex-1 flex-col gap-px py-0.5">
                      <span className="truncate font-[number:var(--ns-weight-medium)]">{p.name}</span>
                      <span className="truncate text-[length:var(--ns-text-meta)] text-[var(--ns-ink-3)]">{[p.email !== p.name ? p.email : "", p.sub].filter(Boolean).join(" · ")}</span>
                    </span>
                  )}
                </Base.Item>
              )}
            </Base.List>
          </Base.Popup>
        </Base.Positioner>
      </Base.Portal>
    </Base.Root>
  );
}

export { RecipientField, matchRecipients, type Recipient, type RecipientFieldProps };
```

### lib/notchset/popup.ts

```tsx
// Notchset recipient-field 2.0.0 · https://notchset.dev/changelog
/*
 * The one popup surface every list that opens from a control uses (select, combobox, recipient picker, and
 * menus in batch 3): the prototype's .menu. It drops just below its control, and on a phone it becomes a
 * bottom sheet with a grab handle and finger-sized rows. Kept as class strings so each primitive's own parts
 * wear the same look.
 */

/** On the Positioner: above everything but dialogs; on a phone, pinned to the bottom edge as a sheet (above a tab bar
    when the app sets --ns-sheet-bottom to its height). */
export const popupPositioner =
  "z-50 outline-hidden max-[600px]:!fixed max-[600px]:!inset-x-2 max-[600px]:!top-auto max-[600px]:!bottom-[calc(var(--ns-sheet-bottom)+env(safe-area-inset-bottom,0px))] max-[600px]:!left-2 max-[600px]:!w-auto max-[600px]:!transform-none";

/** On the Popup. */
export const popupSurface =
  "min-w-[max(var(--anchor-width,0px),180px)] max-h-[min(420px,70vh,var(--available-height,70vh))] overflow-auto overscroll-contain rounded-[var(--ns-radius-lg)] bg-[var(--ns-raised)] p-[5px] text-[length:var(--ns-text-body)] text-[var(--ns-ink)] shadow-[0_0_0_1px_var(--ns-line),var(--ns-shadow-float)] outline-hidden origin-[var(--transform-origin)] " +
  "[animation:ns-menu-in_var(--ns-time-menu)_var(--ns-ease)] data-ending-style:opacity-0 data-ending-style:[transition:opacity_110ms_ease] " +
  "max-[600px]:w-auto max-[600px]:min-w-0 max-[600px]:max-h-[70dvh] max-[600px]:rounded-[var(--ns-radius-xl)] max-[600px]:px-1.5 max-[600px]:pt-3.5 max-[600px]:pb-1.5 max-[600px]:[animation:ns-sheet-up_var(--ns-time-panel)_var(--ns-ease-panel)] " +
  "max-[600px]:before:absolute max-[600px]:before:top-[5px] max-[600px]:before:left-1/2 max-[600px]:before:h-1 max-[600px]:before:w-9 max-[600px]:before:-translate-x-1/2 max-[600px]:before:rounded-full max-[600px]:before:bg-[var(--ns-line)] max-[600px]:before:content-['']";

/** On each item. Highlight (pointer or arrow keys) is the hover wash; the chosen item carries a check. */
export const popupItem =
  "flex w-full min-h-[var(--ns-menu-row)] cursor-default items-center gap-[9px] rounded-[7px] px-[9px] text-left outline-hidden select-none data-highlighted:bg-[var(--ns-hover)] data-disabled:opacity-45 [&_svg:not([data-slot=company-mark])]:size-3.5 [&_svg]:shrink-0";

/** The quiet line a list shows when nothing matches. */
export const popupEmpty = "px-[9px] py-2 text-[length:var(--ns-text-small)] text-[var(--ns-ink-3)] empty:hidden";
```

### lib/notchset/portal.ts

```tsx
// Notchset recipient-field 2.0.0 · https://notchset.dev/changelog
import * as React from "react";

/*
 * Where overlays (dialogs, menus, popovers, tooltips, toasts, sheets) portal to. By default the document body; a
 * host that themes or scopes a region (a preview stage, a shadow root, a tile in another theme) wraps it in
 * PortalContainer with an element inside that scope, so its overlays keep the region's roles and light or dark.
 */
const PortalContainerContext = React.createContext<HTMLElement | null>(null);

const PortalContainer = PortalContainerContext.Provider;

/** The element overlays portal into here, or undefined for the document body. */
function usePortalContainer(): HTMLElement | undefined {
  return React.useContext(PortalContainerContext) ?? undefined;
}

export { PortalContainer, PortalContainerContext, usePortalContainer };
```

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.
