Plate Utils
udecode/plate-utils的API参考。
@udecode/plate-utils
包含 Plate 的实用函数。
组件
PlateElement
用于渲染元素的通用组件。
Attributes
- 默认值:
'div'
PlateElementProps。
应用于组件的 CSS 类。
传递给组件的额外属性。
编辑器实例。也可以使用 useEditorRef
hook 获取。
元素节点。也可以使用 useElement
hook 获取。
元素在编辑器树中的路径。也可以使用 usePath
hook 获取。
要传播到顶层元素的元素属性。
渲染节点子元素所必需的。
从 Slate 元素获取 HTML 属性。这是 PlatePlugin.props
的替代方案。
要渲染的组件类型。
如果为 true,将其属性合并到其直接子元素上。
PlateLeaf
用于渲染叶子节点的通用组件。
Attributes
- 默认值:
'span'
PlateLeafProps。
应用于组件的 CSS 类。
编辑器上下文。
传递给组件的额外属性。
渲染节点子元素所必需的。
叶子节点。
文本节点。
要传播到顶层元素的叶子属性。
从 Slate 叶子获取 HTML 属性。这是 PlatePlugin.props
的替代方案。
要渲染的组件类型。
如果为 true,将其属性合并到其直接子元素上。
Hooks
useEditorString
一个返回编辑器全部文本内容作为字符串的 hook。
Returns
编辑器中所有文本节点的连接文本内容。
useMarkToolbarButtonState
生成标记工具栏按钮的状态。
Parameters
要检查活动标记的节点类型。
应用标记时要清除的节点类型。
Returns
一个布尔值,指示当前选择中 nodeType 标记是否处于活动状态。
节点的类型。
要清除的节点类型。
useMarkToolbarButton
使用由 useMarkToolbarButtonState
创建的状态生成标记工具栏按钮的属性。
Parameters
由 useMarkToolbarButtonState
生成的标记工具栏按钮状态。
Returns
工具栏按钮的属性,包括 pressed
状态和 onClick
函数。
usePlaceholderState
生成编辑器中占位符的状态。
Parameters
- 默认值:
true
如果为 true,则在编辑器失去焦点时隐藏占位符。
查询节点的选项。如果定义了该选项,则只有在节点匹配查询时才显示占位符。
要显示占位符的元素。
Returns
一个布尔值,指示是否应该显示占位符。
useRemoveNodeButton
生成一个按钮的属性,点击该按钮时从编辑器中删除节点。
Parameters
点击按钮时要删除的节点元素。
Returns
删除节点按钮的属性,包括 onClick
函数。
Queries
isType
检查节点是否匹配提供的类型。
Parameters
节点所在的编辑器。
要检查的节点。
用于匹配节点的类型。可以是字符串或字符串数组。
Returns
一个布尔值,指示节点的类型是否匹配提供的类型。
Transforms
resetEditorChildren
用默认块替换编辑器的子节点。
Parameters
要替换其子节点的编辑器。
替换节点子节点的选项。不包括 at
和 nodes
选项。
selectEditor
在目标位置或边缘(开始、结束)选择编辑器。
Parameters
- 如果未定义
edge
,则考虑此选项。 - 如果定义了此选项,则覆盖
at
选项。 - 默认值:
false
要选择的编辑器。
要选择的具体位置。
选择编辑器的开始或结束。
如果为 true,则在选择 markdown Copy code 之前聚焦 React 编辑器。
Returns
没有显式返回,但会选择并可能聚焦编辑器。
moveSelectionByOffset
根据键盘方向键按偏移量移动选择。
Parameters
编辑器实例。
按偏移量移动选择的选项。这是一个可选参数。
selectSiblingNodePoint
从指定节点的前一个或后一个兄弟节点选择一个点。
Parameters
编辑器实例。
选择兄弟节点点的选项。
Utils
defaultsDeepToNodes
使用查询递归地将源对象合并到子节点中。
Parameters
函数的选项,不包括 'apply' 选项。
Returns
没有显式返回,但会根据提供的选项修改子节点。