# @atelier-disko/payload-lexical-react-renderer 中文文档

规范地址：https://npmcn.com/package/%40atelier-disko/payload-lexical-react-renderer/

版本：1\.2\.0
npm 元数据更新时间：2025-01-30T13:42:23.034Z
中文译文更新时间：2026-11-07T01:52:43.252Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40atelier-disko/payload-lexical-react-renderer
原文对照：https://npmcn.com/package/%40atelier-disko/payload-lexical-react-renderer/?lang=original
项目主页：https://github.com/atelierdisko/payload-lexical-react-renderer#readme
源码仓库：https://github.com/atelierdisko/payload-lexical-react-renderer

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

- 包体积（解压后）：19.8 kB，17 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0 \|\| ^19\.0\.0-rc，react-dom ^18\.0\.0 \|\| ^19\.0\.0 \|\| ^19\.0\.0-rc
- 首次发布：2023-10-18T11:51:20.680Z
- 最新版本发布：2025-01-30T13:42:22.810Z
- 近 30 天下载量：6121（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 0 个）

## 中文简介

将 Lexical 编辑器状态渲染成 jsx 的反应组件

## 安装

```sh
npm install @atelier-disko/payload-lexical-react-renderer
```

也可以使用：`pnpm add @atelier-disko/payload-lexical-react-renderer`、`yarn add @atelier-disko/payload-lexical-react-renderer`、`bun add @atelier-disko/payload-lexical-react-renderer`

## README

# @atelierdisko/ pailload- lexic- react- referser (英语)

一个将词典编辑器状态渲染为jsx的反应组件.

## 安装

通过运行安装最新版本 :

```
npm install @atelier-disko/payload-lexical-react-renderer
```

## 使用量

```ts
import {
  PayloadLexicalReactRenderer,
  PayloadLexicalReactRendererProps,
  PayloadLexicalReactRendererContent
} from "@atelier-disko/payload-lexical-react-renderer";

function MyBlog() {
  const content: PayloadLexicalReactRendererContent = await fetchLexicalEditorState();

  return (
    <div>
      <PayloadLexicalReactRenderer content={content} />
    </div>
  );
}
```

将您的 Lexical 丰富的文本数据传递到组件开始 。 它使用默认的渲染器,只应用最基本的造型.

### 元素渲染器

为了自定义结果,请使用 `elementRenderers` 覆盖默认渲染器的道具 :

```js
import {
  PayloadLexicalReactRenderer,
  defaultElementRenderers,
} from "@atelier-disko/payload-lexical-react-renderer";

<PayloadLexicalReactRenderer
  content={content}
  elementRenderers={{
    ...defaultElementRenderers,
    heading: (props) => {
      const Component = props.tag;

      return (
        <Component style={{ color: "#0d26fc" }}>{props.children}</Component>
      );
    },
    paragraph: (props) => (
      <p className={/* Your style */}>{props.children}</p>
    );
  }}
/>;
```

**说明**: 确保为编辑器中使用的每个元素类型指定一个渲染器.

### 制作马克

要自定义文本标记的渲染, 如粗体、 斜体等, 请添加您自己的 `renderMark` 函数 :

```js
import { PayloadLexicalReactRenderer } from "@atelier-disko/payload-lexical-react-renderer";

<PayloadLexicalReactRenderer
  content={content}
  renderMark={(mark) => {
    if (mark.bold) {
      return <strong>{mark.text}</strong>;
    }

    if (mark.italic) {
      return <em>{mark.text}</em>;
    }

    // implement all other mark types

    return <>{mark.text}</>;
  }}
/>;
```

### 块渲染器

有效载荷允许您在 Lexical 丰富的文本编辑器中重新使用自定义块 。 如果你的CMS没有使用 BlocksFeature 在编辑器,你不需要通过 在这里任何东西。 如果有,请确保通过一个渲染器 用于您整合到您的编辑器中的每一块.

```js
import {
  BlockNode,
  PayloadLexicalReactRenderer,
} from "@atelier-disko/payload-lexical-react-renderer";

type Intro = {
  text: string;
  position: "left" | "right";
};

 <PayloadLexicalReactRenderer<{
    intro: Intro;
  }>
  content={content}
  blockRenderers={{
    intro: (props) => (
      <div
        style={{
          display: "flex",
          alignSelf:
            props.fields.data.position === "left"
              ? "flex-start"
              : "flex-end",
        }}
      >
        {props.fields.data.text}
      </div>
    ),
  }}
/>
```

## 常见问题

### @atelier-disko/payload-lexical-react-renderer 是什么？

将 Lexical 编辑器状态渲染成 jsx 的反应组件

### 如何安装 @atelier-disko/payload-lexical-react-renderer？

在项目目录运行 npm install @atelier-disko/payload-lexical-react-renderer，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0 \|\| ^19\.0\.0 \|\| ^19\.0\.0-rc）、react-dom（^18\.0\.0 \|\| ^19\.0\.0 \|\| ^19\.0\.0-rc）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atelier-disko/payload-lexical-react-renderer 支持 TypeScript 吗？

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

### @atelier-disko/payload-lexical-react-renderer 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @atelier-disko/payload-lexical-react-renderer 可以商用吗？

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

### @atelier-disko/payload-lexical-react-renderer 的下载量有多少？

根据 npm 官方下载统计，@atelier-disko/payload-lexical-react-renderer 在 2026/10/07 – 2026/11/05 这 30 天内被下载 6,121 次，日均约 204 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @atelier-disko/payload-lexical-react-renderer 还在维护吗？

最新版本 1\.2\.0 发布于 2025/01/30（1\.8 年前）；至今共发布 20 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/10/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。