@haklex/rich-ext-ext-exexcalidraw (英语)
Excalidraw 白板集成为 Haklex 丰富的编辑器.
安装
pnpm add @haklex/rich-ext-excalidraw
同伴依赖关系
| 软件包 | 版本 |
|---|---|
@lexical/react | ^0.45.0 |
lexical | ^0.45.0 |
lucide-react | ^1.0.0 |
react | >= 19 |
react-dom | >= 19 |
使用量
在编辑器配置中注册节点
import { ExcalidrawEditNode } from '@haklex/rich-ext-excalidraw';
const editorConfig = {
nodes: [ExcalidrawEditNode],
};
用于静态/只读渲染 :
import { ExcalidrawNode } from '@haklex/rich-ext-excalidraw/static';
const staticConfig = {
nodes: [ExcalidrawNode],
};
使用 Excalidraw 插件
import { ExcalidrawPlugin } from '@haklex/rich-ext-excalidraw';
function EditorPlugins() {
return <ExcalidrawPlugin />;
}
在程序上插入 Excalidraw 块
import { INSERT_EXCALIDRAW_COMMAND } from '@haklex/rich-ext-excalidraw';
editor.dispatchCommand(INSERT_EXCALIDRAW_COMMAND, undefined);
配置 Excalidraw 行为
import { ExcalidrawConfigProvider } from '@haklex/rich-ext-excalidraw';
import type { ExcalidrawConfig } from '@haklex/rich-ext-excalidraw';
const config: ExcalidrawConfig = {
// your Excalidraw configuration
};
function App() {
return (
<ExcalidrawConfigProvider value={config}>
<Editor />
</ExcalidrawConfigProvider>
);
}
使用渲染器
import { ExcalidrawEditRenderer } from '@haklex/rich-ext-excalidraw';
import {
ExcalidrawDisplayRenderer,
ExcalidrawSSRRenderer,
} from '@haklex/rich-ext-excalidraw/static';
快照公用事业
import { parseSnapshot, serializeSnapshot } from '@haklex/rich-ext-excalidraw';
导入样式
import '@haklex/rich-ext-excalidraw/style.css';
出口
节点
ExcalidrawNode-- 静态( 只读) 节点ExcalidrawEditNode-- 用完整的 Excalidraw 编辑器编辑节点$createExcalidrawNode()编号 :$isExcalidrawNode()- 语言辅助人员
渲染器
ExcalidrawDisplayRenderer-- 静态显示渲染器ExcalidrawEditRenderer-- 交互式编辑渲染器ExcalidrawSSRRenderer-- 服务器侧渲染渲染器
插件
ExcalidrawPlugin-- Excalidraw 块插入的编辑器插件INSERT_EXCALIDRAW_COMMAND-- 程序插入的语法命令
A. 背景情况
ExcalidrawConfigProvider-- Excalidraw 配置的上下文提供者useExcalidrawConfig-- hook 访问 Excalidraw 配置上下文
公用事业
parseSnapshot-- 将一个 Excalidraw 快照去序列化serializeSnapshot-- 序列化 Excalidraw 快照
类型
ExcalidrawConfig-- 配置类型ExcalidrawSnapshot-- 快照数据类型
子路径导出
| 路径 | 说明 |
|---|---|
@haklex/rich-ext-excalidraw | 全部出口(编辑+静态) |
@haklex/rich-ext-excalidraw/static | 仅静态( 无 Excalidraw 编辑器 ) |
@haklex/rich-ext-excalidraw/style.css | 样式表 |
哈克历克的一部分
此软件包是 哈克历 丰富的编辑生态系统.
许可证
麻省理工学院