Plate Editor

Plate 编辑器的 API 参考。

一个自定义的编辑器接口,扩展了基础的 TEditor 接口,并包含 Plate 库特有的属性和方法。

Core Properties

Parameters

Collapse all

    编辑器的唯一标识符。

    可以用来唯一标识编辑器的键。

    当前正在处理的键盘事件,如果没有事件正在处理,则为 null。

    是否是后备编辑器。

    • Default: false

    编辑器中的上一个选择范围。

    当前正在使用的插件列表。

    一个插件键值对的记录。

API Methods

Parameters

Collapse all

    获取插件的类型化 API。

    获取插件的类型化变换。

    通过键或基础插件获取编辑器插件实例。

    获取插件的节点类型。

Option Methods

Parameters

Collapse all

    获取插件的特定选项值。

    获取插件的所有选项。

    设置插件的特定选项值。

    设置插件的多个选项。

    获取插件的 zustand-x 选项存储。

React Hooks

Parameters

Collapse all

    在 React 组件中订阅特定选项值。

    在 React 组件中订阅插件选项或派生自选项的值。

Plate Store Methods

Parameters

Collapse all

    更新全局 Plate 状态。

Core Plugin APIs

DebugPlugin

Parameters

Collapse all

    在 'log' 级别打印一条消息。

    在 'info' 级别打印一条消息。

    在 'warn' 级别打印一条消息。

    在 'error' 级别打印一条消息。

SlateNextPlugin

Parameters

Collapse all

    切换一个块元素。

    切换选中文本上的标记。

HtmlPlugin

Parameters

Collapse all

    将 HTML 内容反序列化为 Slate 节点。

ReactPlugin

Parameters

Collapse all

    重置编辑器状态,同时保持焦点(如果编辑器已聚焦)。

PlateApiPlugin

Parameters

Collapse all

    重新装饰编辑器。此方法应被覆盖以确保正常功能。

Parameters

Collapse all

    替换编辑器值。更多信息请参阅 Controlled Value