@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.45.0 |
lexical | ^0.45.0 |
lucide-react | ^1.0.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';
Override the renderer
NestedDocStaticDecorator resolves through RendererWrapper, so downstream apps can replace the entire static UI by registering a component under the NESTED_DOC_NODE_KEY slot:
import {
NESTED_DOC_NODE_KEY,
type NestedDocRendererProps,
} from '@haklex/rich-ext-nested-doc/static';
const MyNestedDocRenderer = ({ contentState }: NestedDocRendererProps) => {
// custom preview / card / drawer UI
return <div>{/* ... */}</div>;
};
const rendererConfig = {
[NESTED_DOC_NODE_KEY]: MyNestedDocRenderer,
};
When no override is supplied the default decorator UI (preview frame + dialog open) is used as-is.
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) nodeNestedDocEditNode-- edit node with interactive UI$createNestedDocNode()/$isNestedDocNode()-- Lexical helpersnestedDocNodes-- array of static nodes for config registrationnestedDocEditNodes-- array of edit nodes for config registration
Renderers / Decorators
NestedDocRenderer-- static rendererNestedDocEditDecorator-- edit-mode decoratorNestedDocStaticDecorator-- static-mode decorator (resolves overrides viaRendererWrapper)NESTED_DOC_NODE_KEY--'NestedDoc'constant forRendererConfigslot lookupNestedDocRendererProps-- props shape for custom renderers registered against the slot
Plugin
NestedDocPlugin-- editor plugin for nested doc insertionINSERT_NESTED_DOC_COMMAND-- Lexical command for programmatic insertion
Context
NestedDocDialogEditorProvider-- context provider for nested doc dialog editoruseNestedDocDialogEditor-- 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