Plate Core

udecode/plate-core的 API 参考。

API

createPlateEditor

生成一个新的 PlateEditor 实例，使用一组插件及其配置进行初始化。

Parameters

Collapse all

    创建 Plate 编辑器的选项。

Returns

    应用了指定插件和设置的 PlateEditor 实例。

有关编辑器配置的更多详细信息，请参阅编辑器配置指南。

createPlatePlugin

使用给定的配置创建一个新的 Plate 插件，支持扩展、嵌套插件操作和运行时配置。

Parameters

Collapse all

    插件的配置对象，或返回配置的函数。如果提供函数，它将在插件与编辑器一起解析时执行。

    有关 PlatePluginConfig 类型的详细信息，请参阅 PlatePlugin API。

Returns

    一个新的 PlatePlugin<PluginConfig<K, O, A, T>> 实例。

createTPlatePlugin

createPlatePlugin 的显式类型版本。

Parameters

Collapse all

    插件的配置对象，或返回配置的函数。此版本需要一个显式类型参数 C 扩展 AnyPluginConfig。

    有关 TPlatePluginConfig 类型的详细信息，请参阅 PlatePlugin API。

Returns

    一个新的 PlatePlugin<C> 实例。

toPlatePlugin

扩展 SlatePlugin 以创建 React PlatePlugin。

Parameters

Collapse all

    要扩展的基础 SlatePlugin。

    提供扩展配置的函数或对象。如果是函数，它接收插件上下文并应返回部分 PlatePlugin。如果是对象，它应该是部分 PlatePlugin 配置。

Returns

    一个新的 PlatePlugin，它结合了基础 SlatePlugin 功能和扩展配置中定义的 React 特定功能。

toTPlatePlugin

toPlatePlugin 的显式类型版本。

Parameters

Collapse all

    要扩展的基础 SlatePlugin。

    提供扩展配置的函数或对象。此版本需要基础插件配置（TContext）和扩展配置（C）的显式类型参数。

Returns

    具有精确类型控制的新 PlatePlugin。

useEditorContainerRef

获取编辑器容器的 DOM 引用。

useEditorScrollRef

获取编辑器滚动容器的引用。

useScrollRef

获取编辑器滚动容器的引用。如果存在滚动引用则返回滚动引用，否则返回容器引用。

useEditorPlugin

获取编辑器和插件上下文。

Parameters

Collapse all

    具有必需键的插件或插件配置。

Returns

    包含以下内容的 PlatePluginContext 对象：

useEditorRef

获取 Slate 编辑器引用而不重新渲染。

Parameters

Collapse all

    plate 编辑器的 ID。仅在嵌套编辑器时有用。默认使用最近的编辑器 id。

Returns

    一个 PlateEditor 对象，即 Slate 编辑器。

useEditorSelector

订阅编辑器的特定属性。

Parameters

Collapse all

    选择器函数。

    选择器函数的依赖列表。

Returns

    选择器函数的返回值。

useEditorState

获取带重新渲染的 Slate 编辑器引用。

Parameters

Collapse all

    plate 编辑器的 ID。默认使用最近的编辑器 id。

Returns

    一个 PlateEditor 对象，即 Slate 编辑器。

useEditorReadOnly

获取编辑器的 readOnly 状态。

Parameters

Collapse all

    plate 编辑器的 ID。

Returns

    编辑器的 readOnly 状态。

useEditorMounted

获取编辑器的 isMounted 状态。

Parameters

Collapse all

    plate 编辑器的 ID。

Returns

    编辑器的 isMounted 状态。

useEditorSelection

获取编辑器的选择。已记忆化，因此如果范围相同则不会重新渲染。

Parameters

Collapse all

    plate 编辑器的 ID。

Returns

    编辑器中的当前选择。

useEditorVersion

获取编辑器值的版本。该版本在每次编辑器更改时递增。

Parameters

Collapse all

    plate 编辑器的 ID。

Returns

    编辑器值的当前版本。

useSelectionVersion

获取编辑器选择的版本。该版本在每次选择更改时递增（范围不同）。

Parameters

Collapse all

    plate 编辑器的 ID。

Returns

    编辑器选择的当前版本。

useSelectionCollapsed

返回当前选择是否已折叠（即选择是单个点）。

Returns

    一个布尔值，指示选择是否已折叠。

useSelectionExpanded

返回当前选择是否已展开（即选择有非零范围）。

Returns

    一个布尔值，指示选择是否已展开。

useSelectionWithinBlock

返回当前选择是否在单个块内。

Returns

    一个布尔值，指示选择是否在单个块内。

useSelectionAcrossBlocks

返回当前选择是否跨越多个块。

Returns

    一个布尔值，指示选择是否跨越多个块。

useSelectionFragment

返回当前选择的片段，可选择解包结构节点。

Parameters

Collapse all

    获取选择片段的选项。

Returns

    表示当前选择片段的 TElement 数组。如果选择未展开或未找到片段，则返回空数组。

useSelectionFragmentProp

返回从当前选择片段派生的属性值。

Parameters

Collapse all

Returns

    从片段节点派生的值，如果在指定节点中未找到一致的值，则为 undefined。

useNodePath

返回编辑器中节点的路径。

Parameters

Collapse all

    要查找路径的节点。

Returns

    表示节点在编辑器树结构中位置的记忆化 Path 数组。

usePath

获取最近元素的记忆化路径。

Parameters

Collapse all

    要获取路径的插件的键。

Returns

    元素的路径，如果在节点组件上下文之外使用则为 undefined。

useElement

通过插件键获取元素。

Parameters

Collapse all

    要获取元素的插件的键。

    • 默认值： 'element'

Returns

    类型为 T extends TElement 的元素，如果在节点组件上下文之外使用则为空对象。

核心插件

DebugPlugin

提供具有可配置日志级别和错误处理的调试功能。

有关更多详细信息，请参阅调试。

SlateNextPlugin

扩展核心 API 并改进默认功能。

DOMPlugin & ReactPlugin

将 React 特定功能集成到编辑器中。

HistoryPlugin

为编辑器启用撤销和重做功能。

InlineVoidPlugin

管理编辑器中的内联和空元素。

ParserPlugin

处理编辑器的内容解析。

LengthPlugin

强制执行编辑器内容的最大长度。

HtmlPlugin

启用 HTML 序列化和反序列化。

AstPlugin

处理编辑器的抽象语法树（AST）操作。

ParagraphPlugin

提供段落格式化功能。

EventEditorPlugin

管理编辑器事件，如焦点和模糊。

PlateApiPlugin

提供 Plate 编辑器功能的核心 API。