# Rich Text Editor (Notchset): prompt.md (v1.0.0)

- id: `rich-text-editor` · 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/rich-text-editor`
- npm dependencies: @tiptap/react@^3, @tiptap/starter-kit@^3
- registry dependencies: utils, @beautiful-ui/segmented-control, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/rich-text-editor
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

A Tiptap editor beside its own source: a toolbar whose active formats ink, a bubble menu over selections, a slash menu for blocks, a word limit that turns signal, and Markdown or HTML whose changed line flashes.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: `@tiptap/react@^3`, `@tiptap/starter-kit@^3`.
- Files: `components/ui/notchset/rich-text-editor.tsx`; shared code: `lib/beautiful-ui/notchset/calendar.tsx`, `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `segmented-control`, `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: `RichTextEditor`, `serialize`, 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 { RichTextEditor } from "@/components/ui/notchset/rich-text-editor";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `RichTextEditor` | `rich-text-editor` | The editor, toolbar, menus and source. |

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/rich-text-editor.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
- rich text editor, wysiwyg, markdown editor, tiptap, release notes, document editor, notes, Notchset
- Writing short structured documents (notes, release notes, briefs) that are stored as Markdown or HTML

### Not when
- A single line or plain text: use Input or Textarea

## Mistakes
- Store Markdown or HTML from onChange, not the source pane's text

## Usage

```tsx
"use client";

import { RichTextEditor } from "@/components/ui/notchset/rich-text-editor";

export function RunNotes({ notes, save }: { notes: string; save: (markdown: string) => void }) {
  return <RichTextEditor defaultValue={notes} wordLimit={120} onChange={({ markdown }) => save(markdown)} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `defaultValue` | `string (HTML)` |  | Starting content; RESET restores it. |
| `onChange` | `({ html, markdown, json }) => void` |  | Every change. |
| `wordLimit` | `number` |  | Over it, the count turns signal. |
| `source` | `boolean` |  | The Markdown / HTML pane (default on). |

Full docs: https://beautiful-ui.dev/components/rich-text-editor

## 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 |
|---|---|
| ⌘B / ⌘I / ⌘E | Bold / italic / inline code |
| ⌘Z / ⇧⌘Z | Undo / redo |
| / | Slash menu on an empty line |
| ↑ ↓ Enter Esc | Move, insert, close the slash menu |

## Performance

- Toolbar state reads through useEditorState, so typing doesn't re-render the whole card.

## Responsive

- The two panes stack under 720px.

## Motion inventory

| Interaction | What moves |
|---|---|
| Bubble menu | Fades in and settles up 4px (260ms) |
| Slash menu | Unrolls from the top (clip-path, 300ms); the highlight glides (140ms) |
| Source | The changed line flashes and fades (900ms) |

## Accessibility contract (preserve when editing)
- Tiptap's contenteditable textbox with a label; toolbar buttons expose aria-pressed
- Buttons keep the editor's selection (no focus steal); the slash menu is a listbox

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/rich-text-editor
```

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)
- Tiptap (https://tiptap.dev)

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.