# @haklex/rich-ext-excalidraw 中文文档

规范地址：https://npmcn.com/package/%40haklex/rich-ext-excalidraw/

版本：0\.64\.3
npm 元数据更新时间：2026-11-10T14:36:55.227Z
中文译文更新时间：2026-11-17T06:33:25.988Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40haklex/rich-ext-excalidraw
原文对照：https://npmcn.com/package/%40haklex/rich-ext-excalidraw/?lang=original
项目主页：https://github.com/Innei/haklex#readme
源码仓库：https://github.com/Innei/haklex

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：165 kB，67 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react \>=19，lexical ^0\.53\.0，react-dom \>=19，lucide-react ^1\.0\.0，@lexical/react ^0\.53\.0，@haklex/rich-editor ^0\.64\.3，@excalidraw/excalidraw \>=0\.18\.0，@haklex/rich-editor-ui ^0\.64\.3，@haklex/rich-style-token ^0\.64\.3
- 首次发布：2026-03-02T15:44:50.170Z
- 最新版本发布：2026-11-10T14:36:54.784Z
- 近 30 天下载量：11154（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：182（近 12 个月 182 个）

## 中文简介

Excalidraw 白板扩展

## 安装

```sh
npm install @haklex/rich-ext-excalidraw
```

也可以使用：`pnpm add @haklex/rich-ext-excalidraw`、`yarn add @haklex/rich-ext-excalidraw`、`bun add @haklex/rich-ext-excalidraw`

## README

# @haklex/rich-ext-ext-exexcalidraw (英语)

Excalidraw 白板集成为 Haklex 丰富的编辑器.

## 安装

```bash
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` |

## 使用量

### 在编辑器配置中注册节点

```ts
import { ExcalidrawEditNode } from '@haklex/rich-ext-excalidraw';

const editorConfig = {
  nodes: [ExcalidrawEditNode],
};
```

用于静态/只读渲染 :

```ts
import { ExcalidrawNode } from '@haklex/rich-ext-excalidraw/static';

const staticConfig = {
  nodes: [ExcalidrawNode],
};
```

### 使用 Excalidraw 插件

```tsx
import { ExcalidrawPlugin } from '@haklex/rich-ext-excalidraw';

function EditorPlugins() {
  return <ExcalidrawPlugin />;
}
```

### 在程序上插入 Excalidraw 块

```ts
import { INSERT_EXCALIDRAW_COMMAND } from '@haklex/rich-ext-excalidraw';

editor.dispatchCommand(INSERT_EXCALIDRAW_COMMAND, undefined);
```

### 配置 Excalidraw 行为

```tsx
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>
  );
}
```

### 使用渲染器

```tsx
import { ExcalidrawEditRenderer } from '@haklex/rich-ext-excalidraw';
import {
  ExcalidrawDisplayRenderer,
  ExcalidrawSSRRenderer,
} from '@haklex/rich-ext-excalidraw/static';
```

### 快照公用事业

```ts
import { parseSnapshot, serializeSnapshot } from '@haklex/rich-ext-excalidraw';
```

### 导入样式

```ts
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` | 样式表 |

## 哈克历克的一部分

此软件包是 [哈克历](https://npmcn.com/package/README.md) 丰富的编辑生态系统.

## 许可证

麻省理工学院

## 常见问题

### @haklex/rich-ext-excalidraw 是什么？

Excalidraw 白板扩展

### 如何安装 @haklex/rich-ext-excalidraw？

在项目目录运行 npm install @haklex/rich-ext-excalidraw，或使用 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）、@haklex/rich-editor（^0\.64\.3）、@haklex/rich-editor-ui（^0\.64\.3）、@haklex/rich-style-token（^0\.64\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @haklex/rich-ext-excalidraw 支持 TypeScript 吗？

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

### @haklex/rich-ext-excalidraw 支持 ESM 还是 CommonJS？

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

### @haklex/rich-ext-excalidraw 可以商用吗？

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

### @haklex/rich-ext-excalidraw 的下载量有多少？

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

### @haklex/rich-ext-excalidraw 还在维护吗？

最新版本 0\.64\.3 发布于 2026/11/10（6 天前）；至今共发布 182 个版本，其中过去 12 个月发布了 182 个；首次发布于 2026/03/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

