docs/api/core.cn.mdx
createPlateEditor生成一个新的 PlateEditor 实例，使用一组插件及其配置进行初始化。
有关编辑器配置的更多详情，请参阅编辑器配置指南。
createPlatePlugin使用给定配置创建一个新的 Plate 插件，支持扩展、嵌套插件操作和运行时配置。
<API name="createPlatePlugin"> <APIParameters> <APIItem name="config" type="PlatePluginConfig | ((editor: PlateEditor) => PlatePluginConfig)"> 插件的配置对象，或返回配置的函数。如果提供函数，将在解析插件时使用编辑器执行该函数。有关 `PlatePluginConfig` 类型的详情，请参阅[PlatePlugin API](/docs/api/core/plate-plugin#plugin-properties)。
createTPlatePlugincreatePlatePlugin 的显式类型版本。
有关 `TPlatePluginConfig` 类型的详情，请参阅[PlatePlugin API](/docs/api/core/plate-plugin#plugin-properties)。
toPlatePlugin扩展 SlatePlugin 以创建 React PlatePlugin。
<API name="toPlatePlugin"> <APIParameters> <APIItem name="basePlugin" type="SlatePlugin"> 要扩展的基础 SlatePlugin。 </APIItem> <APIItem name="extendConfig" type="PlatePluginConfig | ((ctx: PlatePluginContext<C>) => PlatePluginConfig)" optional> 提供扩展配置的函数或对象。如果是函数，它接收插件上下文并应返回部分 PlatePlugin。如果是对象，它应是部分 PlatePlugin 配置。 </APIItem> </APIParameters> <APIReturns type="PlatePlugin"> 一个新的插件实例，结合了基础 SlatePlugin 功能和扩展配置中定义的 React 特定特性。 </APIReturns> </API>toTPlatePlugintoPlatePlugin 的显式类型版本。
useEditorContainerRefuseEditorScrollRefuseScrollRefuseEditorPlugin获取编辑器和插件上下文。
<API name="useEditorPlugin"> <APIParameters> <APIItem name="p" type="WithRequiredKey<P>"> 具有必需键的插件或插件配置。 </APIItem> </APIParameters> <APIReturns type="PlatePluginContext"> <APIItem name="editor" type="PlateEditor"> 当前编辑器实例。 </APIItem> <APIItem name="plugin" type="PlatePlugin"> 插件实例。 </APIItem> <APIItem name="getOption" type="function"> 获取特定选项值的函数。 </APIItem> <APIItem name="getOptions" type="function"> 获取插件所有选项的函数。 </APIItem> <APIItem name="setOption" type="function"> 设置特定选项值的函数。 </APIItem> <APIItem name="setOptions" type="function"> 设置多个选项的函数。 </APIItem> <APIItem name="store" type="PlateStore"> 编辑器的 Plate 存储。 </APIItem> </APIReturns> </API>useEditorRef获取 Plate 编辑器引用而不重新渲染。返回的编辑器对象增强了 store 属性，提供对 Plate 存储的访问。
useEditorSelector订阅编辑器的特定属性。
<API name="useEditorSelector"> <APIParameters> <APIItem name="selector" type="(editor: PlateEditor<V>, prev?: T) => T"> 选择器函数。 </APIItem> <APIItem name="deps" type="DependencyList"> 选择器函数的依赖项列表。 </APIItem> <APIItem name="options" type="UseEditorSelectorOptions<T>" optional> 选择器函数的选项。 </APIItem> </APIParameters> <APIOptions> <APIItem name="id" type="string" optional> plate 编辑器的 ID。仅在嵌套编辑器时有用。默认使用最近的编辑器 id。 </APIItem> <APIItem name="equalityFn" type="(a: T, b: T) => boolean" optional> 确定选择器函数结果是否已更改的相等性函数。默认为 `(a, b) => a === b`。 </APIItem> </APIOptions> <APIReturns type="T"> 选择器函数的返回值。 </APIReturns> </API>useEditorState获取带重新渲染的 Plate 编辑器引用。
<API name="useEditorState"> <APIParameters> <APIItem name="id" type="string" optional> plate 编辑器的 ID。默认使用最近的编辑器 id。 </APIItem> </APIParameters> <APIReturns type="PlateEditor"> 编辑器引用。 </APIReturns> </API>useEditorComposing获取编辑器的 composing 状态。
useEditorReadOnly获取编辑器的 readOnly 状态。
<API name="useEditorReadOnly">
<APIParameters>
<APIItem name="id" type="string" optional>
plate 编辑器的 ID。
</APIItem>
</APIParameters>
<APIReturns type="boolean">
编辑器是否为只读。
</APIReturns>
</API>
useEditorMounted获取编辑器的 isMounted 状态。
useEditorSelection获取编辑器的选区。已记忆化，如果范围相同则不会重新渲染。
<API name="useEditorSelection"> <APIParameters> <APIItem name="id" type="string" optional> plate 编辑器的 ID。 </APIItem> </APIParameters> <APIReturns type="TRange | null"> 编辑器中的当前选区。 </APIReturns> </API>useEditorVersion获取编辑器值的版本。每次编辑器更改时该版本都会递增。
<API name="useEditorVersion"> <APIParameters> <APIItem name="id" type="string" optional> plate 编辑器的 ID。 </APIItem> </APIParameters> <APIReturns type="number"> 编辑器值的当前版本。 </APIReturns> </API>useSelectionVersion获取编辑器选区的版本。每次选区更改(范围不同)时该版本都会递增。
<API name="useSelectionVersion"> <APIParameters> <APIItem name="id" type="string" optional> plate 编辑器的 ID。 </APIItem> </APIParameters> <APIReturns type="number"> 编辑器选区的当前版本。 </APIReturns> </API>useSelectionCollapseduseSelectionExpandeduseSelectionWithinBlockuseSelectionAcrossBlocksuseSelectionFragment返回当前选区的片段，可选择解构结构节点。
<API name="useSelectionFragment"> <APIReturns type="TElement[]"> 当前选区的片段。如果选区未展开或未找到片段，则返回空数组。 </APIReturns> </API>useSelectionFragmentProp返回从当前选区片段派生的属性值。
<API name="useSelectionFragmentProp"> <APIOptions type="GetSelectionFragmentOptions & GetFragmentPropOptions" optional> <APIItem name="key" type="string" optional> 要从每个节点提取的属性键。 </APIItem> <APIItem name="defaultValue" type="string" optional> 如果未找到有效属性则返回的默认值。 </APIItem> <APIItem name="getProp" type="(node: TElement | TText) => any" optional> 从节点提取属性值的自定义函数。 </APIItem> <APIItem name="mode" type="'all' | 'block' | 'text'" optional> 确定如何遍历片段: - 'all': 检查块节点和文本节点 - 'block': 仅检查块节点 - 'text': 仅检查文本节点'block'
</APIItem>
useNodePath返回编辑器中节点的路径。
<API name="useNodePath"> <APIParameters> <APIItem name="node" type="TNode"> 要查找路径的节点。 </APIItem> </APIParameters> <APIReturns> 表示节点在编辑器树结构中位置的记忆化 Path 数组。 </APIReturns> </API>usePath获取最近元素的记忆化路径。
<API name="usePath"> <APIParameters> <APIItem name="pluginKey" type="string" optional> 要获取路径的插件键。 </APIItem> </APIParameters> <APIReturns> 元素的路径，如果在节点组件上下文之外使用则返回 `undefined`。 </APIReturns> </API>usePluginOption用于从插件存储访问插件选项的 Hook。用于 <Plate> 内部。
// 访问简单选项
const value = usePluginOption(plugin, 'value');
// 使用参数访问选择器
const doubleValue = usePluginOption(plugin, 'doubleValue', 2);
// 使用相等函数访问
const value = usePluginOption(plugin, 'value', (a, b) => a === b);
// 访问整个状态
const state = usePluginOption(plugin, 'state');
useEditorPluginOption用于从插件存储访问插件选项的 Hook。用于 <Plate> 外部。
// 访问简单选项
const value = useEditorPluginOption(editor, plugin, 'value');
// 使用参数访问选择器
const doubleValue = useEditorPluginOption(editor, plugin, 'doubleValue', 2);
// 使用相等函数访问
const value = useEditorPluginOption(editor, plugin, 'value', (a, b) => a === b);
// 访问整个状态
const state = useEditorPluginOption(editor, plugin, 'state');
useElement通过插件键获取元素。
<API name="useElement"> <APIParameters> <APIItem name="pluginKey" type="string" optional> 要获取元素的插件键。 - **默认值:** `'element'` </APIItem> </APIParameters> <APIReturns> 类型为 `T extends TElement` 的元素，如果在节点组件上下文之外使用则返回空对象。 </APIReturns> </API>DebugPlugin提供具有可配置日志级别和错误处理功能的调试功能。
查看调试了解更多详情。
SlateExtensionPlugin & SlateReactExtensionPlugin扩展核心 API 并改进默认功能。
DOMPlugin & ReactPlugin将 React 特定功能集成到编辑器中。
HistoryPlugin为编辑器启用撤销和重做功能。
InlineVoidPlugin管理编辑器中的内联和空元素。
ParserPlugin处理编辑器内容的解析。
LengthPlugin强制执行编辑器内容的最大长度限制。
HtmlPlugin启用 HTML 序列化和反序列化。
AstPlugin处理编辑器的抽象语法树(AST)操作。
ParagraphPlugin提供段落格式化功能。
EventEditorPlugin管理编辑器事件，如焦点和失焦。
isType检查节点是否匹配提供的类型。
<API name="isType"> <APIParameters> <APIItem name="editor" type="PlateEditor<V>"> 节点所在的编辑器。 </APIItem> <APIItem name="node" type="any"> 要检查的节点。 </APIItem> <APIItem name="key" type="string | string[]" optional> 要与节点匹配的类型或类型数组。可以是字符串或字符串数组。 </APIItem> </APIParameters> <APIReturns> 表示节点的类型是否匹配提供的类型或类型的布尔值。 </APIReturns> </API><PlateElement>用于渲染元素的通用组件。
<API name="PlateElement"> <APIProps> <APIItem name="className" type="string" optional> 应用于组件的 CSS 类。 </APIItem> <APIItem name="editor" type="E"> 编辑器实例。也可使用 `useEditorRef` hook 获取。 </APIItem> <APIItem name="element" type="TElement"> 元素节点。也可使用 `useElement` hook 获取。 </APIItem> <APIItem name="path" type="Path"> 元素在编辑器树中的路径。也可使用 `usePath` hook 获取。 </APIItem> <APIItem name="attributes" type="HTMLAttributes<HTMLElement>"> 要应用到顶层元素的元素属性。 <APISubList> <APISubListItem parent="attributes" name="data-slate-node" type="'element'"> 始终设置为 `'element'`。 </APISubListItem> <APISubListItem parent="attributes" name="data-slate-inline" type="boolean" optional /> <APISubListItem parent="attributes" name="data-slate-void" type="boolean" optional /> <APISubListItem parent="attributes" name="dir" type="string" optional /> <APISubListItem parent="attributes" name="ref" type="any"> 元素的引用。如果使用自己的引用，请与此引用合并。 </APISubListItem> </APISubList> </APIItem> <APIItem name="children" type="any"> 渲染节点子元素所必需。 </APIItem> <APIItem name="as" type="React.ElementType" optional> 要渲染的组件类型。 - **默认值:** `'div'` </APIItem> </APIProps> </API><PlateLeaf>用于渲染叶节点的通用组件。
<API name="PlateLeaf"> <APIProps> <APIItem name="className" type="string" optional> 应用于组件的 CSS 类。 </APIItem> <APIItem name="editor" type="E"> 编辑器上下文。 </APIItem> <APIItem name="children" type="any"> 渲染节点子元素所必需。 </APIItem> <APIItem name="leaf" type="TText"> 叶节点。 </APIItem> <APIItem name="text" type="TText"> 文本节点。 </APIItem> <APIItem name="attributes" type="HTMLAttributes<HTMLElement>"> 要应用到顶层元素的叶节点属性。 <APISubList> <APISubListItem parent="attributes" name="data-slate-leaf" type="true"> 始终设置为 `true`。 </APISubListItem> </APISubList> </APIItem> <APIItem name="as" type="React.ElementType" optional> 要渲染的组件类型。 - **默认值:** `'span'` </APIItem> </APIProps> </API><PlateText>用于渲染文本的通用组件。
<API name="PlateText"> <APIProps> <APIItem name="className" type="string" optional> 应用于组件的 CSS 类。 </APIItem> <APIItem name="text" type="TText"> 文本节点。 </APIItem> <APIItem name="attributes" type="HTMLAttributes<HTMLElement>"> 要应用到顶层元素的文本属性。 </APIItem> <APIItem name="children" type="any"> 渲染节点子元素所必需。 </APIItem> <APIItem name="as" type="React.ElementType" optional> 要渲染的组件类型。 - **默认值:** `'span'` </APIItem> </APIProps> </API>