@haklex/rich-ext-nested-doc

Nested document extension for embedding sub-documents as card blocks.

Installation

pnpm add @haklex/rich-ext-nested-doc

Peer Dependencies

| Package | Version | | --- | --- | | @lexical/react | ^0.41.0 | | lexical | ^0.41.0 | | lucide-react | ^0.574.0 | | react | >= 19 | | react-dom | >= 19 |

Usage

Register nodes in your editor config

import { nestedDocEditNodes } from '@haklex/rich-ext-nested-doc'

const editorConfig = {
  nodes: [...nestedDocEditNodes],
}

For static/read-only rendering:

import { nestedDocNodes } from '@haklex/rich-ext-nested-doc/static'

const staticConfig = {
  nodes: [...nestedDocNodes],
}

Use the nested doc plugin

import { NestedDocPlugin } from '@haklex/rich-ext-nested-doc'

function EditorPlugins() {
  return <NestedDocPlugin />
}

Insert a nested document programmatically

import { INSERT_NESTED_DOC_COMMAND } from '@haklex/rich-ext-nested-doc'

editor.dispatchCommand(INSERT_NESTED_DOC_COMMAND, { docId: '...' })

Provide the dialog editor context

import { NestedDocDialogEditorProvider, useNestedDocDialogEditor } from '@haklex/rich-ext-nested-doc'

function App() {
  return (
    <NestedDocDialogEditorProvider>
      <Editor />
    </NestedDocDialogEditorProvider>
  )
}

Use renderers and decorators

import { NestedDocEditDecorator } from '@haklex/rich-ext-nested-doc'
import { NestedDocRenderer, NestedDocStaticDecorator } from '@haklex/rich-ext-nested-doc/static'

Markdown transformer

import { NESTED_DOC_BLOCK_TRANSFORMER } from '@haklex/rich-ext-nested-doc'

const transformers = [NESTED_DOC_BLOCK_TRANSFORMER]

Import styles

import '@haklex/rich-ext-nested-doc/style.css'

Exports

Nodes

• NestedDocNode -- static (read-only) node
• NestedDocEditNode -- edit node with interactive UI
• $createNestedDocNode() / $isNestedDocNode() -- Lexical helpers
• nestedDocNodes -- array of static nodes for config registration
• nestedDocEditNodes -- array of edit nodes for config registration

Renderers / Decorators

• NestedDocRenderer -- static renderer
• NestedDocEditDecorator -- edit-mode decorator
• NestedDocStaticDecorator -- static-mode decorator

Plugin

• NestedDocPlugin -- editor plugin for nested doc insertion
• INSERT_NESTED_DOC_COMMAND -- Lexical command for programmatic insertion

Context

• NestedDocDialogEditorProvider -- context provider for nested doc dialog editor
• useNestedDocDialogEditor -- hook to access nested doc dialog editor context

Transformers

• NESTED_DOC_BLOCK_TRANSFORMER -- Markdown block transformer

Types

• Serialized node types and payload interfaces are exported for type-safe usage.

Sub-path Exports

| Path | Description | | --- | --- | | @haklex/rich-ext-nested-doc | Full exports (edit + static) | | @haklex/rich-ext-nested-doc/static | Static-only (no heavy UI deps) | | @haklex/rich-ext-nested-doc/style.css | Stylesheet |

Part of Haklex

This package is part of the Haklex rich editor ecosystem.

License

MIT