文本节点

PreviousNext

Plate 文档中文本节点的 API 参考。

文本节点（Text）包含 Plate 文档的实际文本内容及任何格式化属性。它们始终是文档树中的叶子节点，因为不能包含任何子节点。

type TText = {
  text: string
  [key: string]: unknown
}

TextApi

decorations

Parameters

  • node TText

    要获取叶子的文本节点。

  • decorations DecoratedRange[]

    要应用的装饰范围数组。

Returns{ leaf: TText, position?: LeafPosition }[]

    返回叶子及其位置的数组。如果只有一个叶子，则位置为 undefined。

equals

Parameters

Collapse all

  • text TText

    要比较的第一个文本节点。

  • another TText

    要比较的第二个文本节点。

  • options optional TextEqualsOptions

    额外的比较选项。

OptionsTextEqualsOptions

Collapse all

  • loose optional boolean

    如果为 true，则不比较文本内容。这用于检查兄弟文本节点是否可以仅基于其格式化属性进行合并。

Returnsboolean

    如果根据比较规则文本节点相等，则返回 true。

isText

Parameters

Collapse all

  • value any

    要检查的值。

Returnsboolean

    如果值是有效的文本节点，则返回 true。

isTextList

Parameters

Collapse all

  • value any

    要检查的值。

Returnsboolean

    如果值是文本节点数组，则返回 true。

isTextProps

Parameters

Collapse all

  • props any

    要检查的属性。

Returnsboolean

    如果属性匹配部分文本节点结构，则返回 true。

matches

Parameters

Collapse all

  • text TText

    要检查的文本节点。

  • props Partial<TText>

    要匹配的属性。

Returnsboolean

    如果文本节点匹配属性，则返回 true。

类型

TText

Text 是 TText 的类型别名。

Attributes

Collapse all

  • text string

    节点的文本内容。

  • [key: string] unknown

    可以添加到文本节点的额外格式化属性。

TextEntry

文本条目表示一个文本节点及其路径。

Attributes

Collapse all

  • 0 TText

    文本节点。

  • 1 Path

    文本节点的路径。

DecoratedRange

包含装饰信息的范围对象。用于对文档中的特定文本范围应用格式化或样式。

TextOf<N>

一个实用类型，从根节点类型中提取所有可能的文本节点类型。

Parameters

Collapse all

  • N TNode

    要提取文本类型的根节点类型。

TextIn<V>

一个实用类型，从 Value 类型中提取所有文本节点类型。

Parameters

Collapse all

  • V Value

    要提取文本类型的 Value 类型。

MarksOf<N>

一个实用类型，从根节点类型中提取所有可能的标记类型。标记是可以应用于文本节点的格式化属性。

Parameters

Collapse all

  • N TNode

    要提取标记类型的根节点类型。

MarksIn<V>

一个实用类型，从 Value 类型中提取所有标记类型。类似于 MarksOf，但专门用于编辑器 Value 类型。

Parameters

Collapse all

  • V Value

    要提取标记类型的 Value 类型。

MarkKeysOf<N>

一个实用类型，从节点类型中提取所有可能的标记属性键。

Parameters

Collapse all

  • N TNode

    要提取标记键的节点类型。

RangeText