mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-21 22:45:18 +02:00
Code Issues Releases Wiki Activity

docs: Describe Text.matches in detail and describe 'loose' option in Text.equals

Browse Source
This commit is contained in:
Sunny Hirai
2021-06-06 17:27:01 -07:00
parent 33083833fb
commit 3156bd0b94
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api/nodes/text.md
View File

@@ -18,7 +18,13 @@ interface Text {
#### `Text.matches(text: Text, props: Partial<Text>) => boolean`
Check if a `text` matches a set of `props`.
Check if `text` matches a set of `props`.
The way the check works is that it makes sure that (a) all the `props` exist in the `text`, and (b) if it exists, that it exactly matches the properties in the `text`.
If a `props.text` property is passed in, it will be ignored.
If there are properties in `text` that are not in `props`, those will be ignored when it comes to testing for a match.
#### `Text.decorations(node: Text, decorations: Range[]) => Text[]`
@@ -32,6 +38,8 @@ Check if two text nodes are equal.
Options: `{loose?: boolean}`
- `loose?`: When `true`, it checks if the properties of the `Text` object are equal except for the `text` property (i.e. the `String` value of the `Text`). When `false` (default), checks all properties including `text`.
#### `Text.isText(value: any) => value is Text`
Check if a `value` implements the `Text` interface.