docs/api/slate/element.cn.mdx
TElement 对象是 Plate 文档中的一种 Node 类型,可以包含其他 TElement 节点或 Text 节点。
interface TElement {
children: Descendant[]
type: string
[key: string]: unknown
}
根据编辑器的配置,元素可以有不同的行为表现:
元素可以是"块级"或"行内",由插件 node.isInline 定义:
元素可以是"空元素"或"非空元素",由插件 node.isVoid 定义:
某些空元素可以通过插件 node.markableVoid 支持标记。例如,提及元素可能需要支持加粗或斜体格式。
ElementAPIisElementType检查一个值是否实现了 TElement 接口并且 elementKey 匹配指定值。默认检查 'type' 键。
isAncestor检查一个值是否实现了 Ancestor 接口。
isElement检查一个值是否实现了 TElement 接口。
isElementList检查一个值是否是 TElement 对象的数组。
isElementProps检查一组属性是否是 TElement 的部分。
matches检查一个元素是否匹配一组属性。
<API name="matches"> <APIParameters> <APIItem name="element" type="TElement"> 要检查的元素。 </APIItem> <APIItem name="props" type="Partial<TElement>"> 要匹配的属性。 </APIItem> </APIParameters> <APIReturns type="boolean"> 如果元素匹配所有提供的属性,则返回 `true`。 </APIReturns> </API>TElementTElement 对象是 Plate 文档中的一种节点类型,可以包含其他元素节点或文本节点。根据编辑器配置,它们可以是"块级"或"行内"。
Element 是 TElement 的类型别名。
ElementEntryElement entry 表示一个 Element 节点及其路径。
<API name="ElementEntry"> <APIAttributes> <APIItem name="0" type="Element"> Element 节点。 </APIItem> <APIItem name="1" type="Path"> 元素的路径。 </APIItem> </APIAttributes> </API>ElementOrTextOftype ElementOrTextOf<E extends Editor> = ElementOf<E> | TextOf<E>;
ElementOrTextOf 类型表示来自特定编辑器类型的元素或文本节点。
ElementOrTextIntype ElementOrTextIn<V extends Value> = ElementIn<V> | TextIn<V>;
ElementOrTextIn 类型表示来自特定值类型的元素或文本节点。
ElementOfElementOf 是一个工具类型,用于从给定的根节点类型获取所有元素节点类型。
ElementIntype ElementIn<V extends Value> = ElementOf<V[number]>;
ElementIn 是一个工具类型,用于从 Plate Value 类型获取元素类型。