# Inline Edit (Notchset): prompt.md (v1.0.0)

- id: `inline-edit` · version 1.0.0 · component · pro (Pro)
- category: Inputs
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/inline-edit`
- npm dependencies: none
- registry dependencies: utils, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/inline-edit
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

Text that edits in place: a dashed underline and a pen on hover, the same font when editing under an ink line that draws in, and an optimistic save that reverts with Retry if it fails.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: none beyond React.
- Files: `components/ui/notchset/inline-edit.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`.
- Builds: one set of files for both, but its dependencies come in Base UI and Radix builds. Install the one that matches the project (see Install): a free item's bare URL installs the Base UI build of it and its dependencies.
- Exports to keep: `InlineEdit`, `InlineEditGroup`, `InlineEditStatus`, and every exported type.
- CSS: the install adds the notchset foundation (tokens, keyframes, motion levels) 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.
- Tokens: retheme with the `--notchset-*` custom properties (`--notchset-check`, `--notchset-control-edge`, `--notchset-draw-from`, `--notchset-ease-bloom`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`). Never add Tailwind colour classes inside the component.

```tsx
import { InlineEdit, InlineEditGroup, InlineEditStatus } from "@/components/ui/notchset/inline-edit";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `InlineEdit` | `inline-edit` | One field. |
| `InlineEditGroup` | `inline-edit-group` | Shared state. |
| `InlineEditStatus` | `inline-edit-status` | The status line. |

Style a part with `[data-slot="<slot>"]` selectors or its `className`; keep the attributes when editing.

## Sound
- Keep every `data-slot` and `data-sound` attribute: the sound layer reads them.
- Installing this item adds no audio. Nothing plays until the app mounts `SoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/notchset-sound.json`, import from `@/components/ui/notchset/sound-provider`); `useSound()` gives `muted` and `setMuted` for a mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/notchset/inline-edit.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
- inline edit, edit in place, click to edit, editable text, rename, Notchset
- Names and descriptions people change occasionally, right where they read them

### Not when
- Forms with many fields: use Input and a Save button

## Mistakes
- Resolve onCommit only once the change is stored, so the optimistic text means something

## Usage

```tsx
"use client";

import { InlineEdit, InlineEditGroup, InlineEditStatus } from "@/components/ui/notchset/inline-edit";

export function AgentDetails({ name, description, save }: { name: string; description: string; save: (patch: { name?: string; description?: string }) => Promise<void> }) {
  return (
    <InlineEditGroup>
      <InlineEdit label="NAME" value={name} onCommit={(v) => save({ name: v })} />
      <InlineEdit label="DESCRIPTION" value={description} onCommit={(v) => save({ description: v })} multiline />
      <InlineEditStatus />
    </InlineEditGroup>
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `label / value` | `string` |  | The field. |
| `onCommit` | `(value) => Promise` |  | Save it; reject (or resolve false) to revert. |
| `multiline / maxLength` | `boolean / number` |  | A textarea (⌘↵ saves) and its limit (40, 160 multiline). |
| `InlineEditGroup / InlineEditStatus` | `components` |  | Share one status line (saving, saved, error with Retry) and frame state. |

Full docs: https://beautiful-ui.dev/components/inline-edit

## Customising
- Colours: the component reads your shadcn tokens (`--background`, `--foreground`, `--border` …), refined by the `--notchset-*` tokens. The signal colour is `--notchset-signal` (it falls back to `--destructive`). Set tokens on `:root`, or on any container to retheme one area.
- Dark mode follows the `.dark` class on an ancestor (the shadcn and next-themes convention).
- Update later by re-running the install with `--overwrite` (review the diff if you edited it). Changelog: https://beautiful-ui.dev/r/changelog.json

## Keyboard

| Keys | Action |
|---|---|
| Enter / Space | Edit |
| Enter (⌘↵ multiline) | Save |
| Esc | Cancel |

## Performance

- Native input and textarea; nothing runs while reading.

## Responsive

- Fills its container; reading text wraps, the counter sits under the line's end.

## Motion inventory

| Interaction | What moves |
|---|---|
| Hover | The dashes ink and a pen settles in from −4px (260ms) |
| Edit | A solid ink line draws in from the left (320ms) |
| Save | Muted while saving, ink when saved; a failure reverts and the frame turns signal |

## Accessibility contract (preserve when editing)
- Reading, it is a button named with its label and value; Enter or Space edits
- Editing keeps the same font, so nothing moves under the reader
- The status line is polite live text; Retry is a real button

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/inline-edit
```

Pro item: needs the `@beautiful-ui-pro` registry in `components.json` and `BEAUTIFUL_UI_TOKEN` in `.env.local` (https://beautiful-ui.dev/account). Setup: https://beautiful-ui.dev/docs/pro. Your components.json `style` picks the build: radix-*, new-york and default get Radix, base-* gets Base UI.

## Credits
- Built on shadcn/ui (https://ui.shadcn.com)

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