@haklex/rich-ext-nested-doc

中文文档
0.66.0发布于 2026/11/15MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 1.3万

Nested document extension for haklex rich editor

原始使用文档
文档目录21 节
  1. Installation
  2. Peer Dependencies
  3. Usage
  4. Register nodes in your editor config
  5. Use the nested doc plugin
  6. Insert a nested document programmatically
  7. Provide the dialog editor context
  8. Use renderers and decorators
  9. Override the renderer
  10. Markdown transformer
  11. Import styles
  12. Exports
  13. Nodes
  14. Renderers / Decorators
  15. Plugin
  16. Context
  17. Transformers
  18. Types
  19. Sub-path Exports
  20. Part of Haklex
  21. License

@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

PackageVersion
@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) 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 (resolves overrides via RendererWrapper)
  • NESTED_DOC_NODE_KEY -- 'NestedDoc' constant for RendererConfig slot lookup
  • NestedDocRendererProps -- props shape for custom renderers registered against the slot

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

PathDescription
@haklex/rich-ext-nested-docFull exports (edit + static)
@haklex/rich-ext-nested-doc/staticStatic-only (no heavy UI deps)
@haklex/rich-ext-nested-doc/style.cssStylesheet

Part of Haklex

This package is part of the Haklex rich editor ecosystem.

License

MIT

版本与发布记录

@haklex/rich-ext-nested-doc 共发布 178 个版本,首次发布于 2026/03/07;过去 12 个月发布了 178 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.66.0latest2026/11/151 天前
0.65.72026/11/143 天前
0.65.62026/11/124 天前
0.65.52026/11/124 天前
0.65.42026/11/124 天前
0.65.32026/11/124 天前

关于 @haklex/rich-ext-nested-doc 的常见问题

@haklex/rich-ext-nested-doc 是什么?

Nested document extension for haklex rich editor

如何安装 @haklex/rich-ext-nested-doc?

在项目目录运行 npm install @haklex/rich-ext-nested-doc,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=19)、lexical(^0.53.0)、react-dom(>=19)、lucide-react(^1.0.0)、@lexical/react(^0.53.0)、@lexical/markdown(^0.53.0)、@haklex/rich-editor(^0.66.0)、@haklex/rich-editor-ui(^0.66.0)、@haklex/rich-style-token(^0.66.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@haklex/rich-ext-nested-doc 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@haklex/rich-ext-nested-doc 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@haklex/rich-ext-nested-doc 可以商用吗?

@haklex/rich-ext-nested-doc 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@haklex/rich-ext-nested-doc 的下载量有多少?

根据 npm 官方下载统计,@haklex/rich-ext-nested-doc 在 2026/10/17 – 2026/11/15 这 30 天内被下载 13,393 次,日均约 446 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@haklex/rich-ext-nested-doc 还在维护吗?

最新版本 0.66.0 发布于 2026/11/15(1 天前);至今共发布 178 个版本,其中过去 12 个月发布了 178 个;首次发布于 2026/03/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。