CLAUDE.md

1# Block Editor Library
2 
3TipTap-based rich text editor for dotCMS. Built on ProseMirror + Angular.
4 
5## Structure
6 
7```
8src/lib/
9├── nodes/          # Custom block types
10├── extensions/     # TipTap extensions
11├── components/     # Editor shell (DotBlockEditorComponent)
12├── shared/         # Directives, services, utilities reused across nodes/extensions
13├── elements/       # Low-level UI (menus, tables, buttons)
14└── assets/         # SVG icons
15```
16 
17## Adding a New Node
18 
191. Create `nodes/{name}/{name}.node.ts` — use DOM-based `addNodeView()` for simple blocks, or `AngularNodeViewRenderer` + a component (extending `AngularNodeViewComponent`) when Angular DI or complex UI is needed. See `contentlet-block` as the reference for Angular-based nodes.
202. Export from `nodes/index.ts`.
213. Register in `DotBlockEditorComponent._customNodes` map (`components/dot-block-editor/dot-block-editor.component.ts`).
224. If the block should appear in the slash-command palette, add it to `shared/utils/suggestion.utils.ts`.
23 
24## Node `content` Expressions
25 
26Never hardcode a static list of node types in a node's `content` expression. TipTap's `StarterKit` removes disabled nodes from the schema at init time — any `content` that references a removed type throws a schema validation error and the editor renders broken.
27 
28When a node's allowed children depend on editor configuration, build the content expression dynamically from the active allowed list. See `createGridColumn(allowedBlocks)` in `grid-column.node.ts` as the pattern to follow.
29 
30## GridColumn Rules
31 
32- Always instantiate via `createGridColumn(this.allowedBlocks)` inside `DotBlockEditorComponent`, never use the bare `GridColumn` export directly.
33- To allow a new node type inside grid columns, add it to `GRID_COLUMN_CONTENT_MAP` in `grid-column.node.ts`.
34- `aiContent` and `loader` are intentionally absent from `GRID_COLUMN_CONTENT_MAP` — they are editor-level utilities, not column content.
35- Nested grids are intentionally disabled. Do not add `gridBlock` to `GRID_COLUMN_CONTENT_MAP` — the resize plugin does not support nesting.
36