mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-19 13:41:19 +02:00
Code Issues Releases Wiki Activity

docs: Add detail to how the Editor.nodes method works

Browse Source
This commit is contained in:
Sunny Hirai
2021-06-06 12:28:48 -07:00
parent 8ba06cdfd0
commit c05d4c4e55
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/nodes/editor.md
View File

@@ -118,13 +118,15 @@ Options: `depth?: number, edge?: 'start' | 'end'`
#### `Editor.nodes<T extends Node>(editor: Editor, options?) => Generator<NodeEntry<T>, void, undefined>` #### `Editor.nodes<T extends Node>(editor: Editor, options?) => Generator<NodeEntry<T>, void, undefined>`
Iterate through all of the nodes in the Editor. At any given `Location` or `Span` in the editor provided by `at` (default is the current selection), the method returns a Generator of `NodeEntry` objects that represent the nodes that include `at`. At the top of the hierarchy is the `Editor` object itself.
Options: `{at?: Location | Span, match?: NodeMatch, mode?: 'all' | 'highest' | 'lowest', universal?: boolean, reverse?: boolean, voids?: boolean}` Options: `{at?: Location | Span, match?: NodeMatch, mode?: 'all' | 'highest' | 'lowest', universal?: boolean, reverse?: boolean, voids?: boolean}`
`options.match`: Provide a value to the `match?` option to limit the `NodeEntry` objects that are returned.
`options.mode`: `options.mode`:
- `'all'` (default): all matching nodes - `'all'` (default): Return all matching nodes
- `'highest'`: in a hierarchy of nodes, only return the highest level matching nodes - `'highest'`: in a hierarchy of nodes, only return the highest level matching nodes
- `'lowest'`: in a hierarchy of nodes, only return the lowest level matching nodes - `'lowest'`: in a hierarchy of nodes, only return the lowest level matching nodes