@haklex/rich-ex-nested-doc 页面存档备份,存于互联网档案馆
嵌入子文档作为卡块的已嵌入文档扩展名 .
安装
pnpm add @haklex/rich-ext-nested-doc
同伴依赖关系
| 软件包 | 版本 |
|---|---|
@lexical/react | ^0.45.0 |
lexical | ^0.45.0 |
lucide-react | ^1.0.0 |
react | >= 19 |
react-dom | >= 19 |
使用量
在编辑器配置中注册节点
import { nestedDocEditNodes } from '@haklex/rich-ext-nested-doc';
const editorConfig = {
nodes: [...nestedDocEditNodes],
};
用于静态/只读渲染 :
import { nestedDocNodes } from '@haklex/rich-ext-nested-doc/static';
const staticConfig = {
nodes: [...nestedDocNodes],
};
使用嵌入的 Doc 插件
import { NestedDocPlugin } from '@haklex/rich-ext-nested-doc';
function EditorPlugins() {
return <NestedDocPlugin />;
}
在程序上插入嵌入式文档
import { INSERT_NESTED_DOC_COMMAND } from '@haklex/rich-ext-nested-doc';
editor.dispatchCommand(INSERT_NESTED_DOC_COMMAND, { docId: '...' });
提供对话框编辑器上下文
import {
NestedDocDialogEditorProvider,
useNestedDocDialogEditor,
} from '@haklex/rich-ext-nested-doc';
function App() {
return (
<NestedDocDialogEditorProvider>
<Editor />
</NestedDocDialogEditorProvider>
);
}
使用渲染器和装饰器
import { NestedDocEditDecorator } from '@haklex/rich-ext-nested-doc';
import { NestedDocRenderer, NestedDocStaticDecorator } from '@haklex/rich-ext-nested-doc/static';
覆盖渲染器
NestedDocStaticDecorator 解决 RendererWrapper,因此下游应用程序可以通过在下游注册一个组件来取代整个静态UI NESTED_DOC_NODE_KEY 位置 :
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,
};
当未提供覆盖时, 默认的装饰器 UI( 审查框架 + 对话框 打开) 被作为- 位置使用 .
标记倒置变压器
import { NESTED_DOC_BLOCK_TRANSFORMER } from '@haklex/rich-ext-nested-doc';
const transformers = [NESTED_DOC_BLOCK_TRANSFORMER];
导入样式
import '@haklex/rich-ext-nested-doc/style.css';
出口
节点
NestedDocNode-- 静态( 只读) 节点NestedDocEditNode-- 使用交互式 UI 编辑节点$createNestedDocNode()编号 :$isNestedDocNode()- 语言辅助人员nestedDocNodes-- 用于配置注册的静态节点阵列nestedDocEditNodes-- 用于配置注册的编辑节点数组
制作人/装饰人
NestedDocRenderer-- 静态渲染器NestedDocEditDecorator-- 编辑-模式装饰器NestedDocStaticDecorator- 静态-模式装饰器(通过RendererWrapper(中文(简体) )NESTED_DOC_NODE_KEY- 说吧'NestedDoc'常数RendererConfig搜索档NestedDocRendererProps在槽上注册的自定义渲染器的道具形状
插件
NestedDocPlugin-- 嵌入巢道克插件编辑器INSERT_NESTED_DOC_COMMAND-- 程序插入的语法命令
A. 背景情况
NestedDocDialogEditorProvider-- 巢居 doc 对话框编辑器的上下文提供者useNestedDocDialogEditor-- 访问 nocked doc 对话框编辑器上下文的钩头
变形器
NESTED_DOC_BLOCK_TRANSFORMER- Markdown块变压器
类型
- 系列化节点类型和有效载荷接口均被输出用于类型安全使用.
子路径导出
| 路径 | 说明 |
|---|---|
@haklex/rich-ext-nested-doc | 全部出口(编辑+静态) |
@haklex/rich-ext-nested-doc/static | 仅静态( 无重UI 道口) |
@haklex/rich-ext-nested-doc/style.css | 样式表 |
哈克历克的一部分
此软件包是 哈克历 丰富的编辑生态系统.
许可证
麻省理工学院