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

docs: Add generics to Editor API and add missing method

Browse Source
This commit is contained in:
Sunny Hirai
2021-05-25 23:52:03 -07:00
parent b3784e451d
commit 03746d9eed
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -49,7 +49,7 @@ Creates a new, empty `Editor` object.
### Retrieval methods ### Retrieval methods
#### `Editor.above<T extends Ancestor>(editor: Editor, options?): NodeEntry | undefined` #### `Editor.above<T extends Ancestor>(editor: Editor, options?): NodeEntry<T> | undefined`
Get the ancestor above a location in the document. Get the ancestor above a location in the document.
@@ -93,12 +93,16 @@ Get the leaf text node at a location.
Options: `{depth?: number, edge?: 'start' | 'end'}` Options: `{depth?: number, edge?: 'start' | 'end'}`
#### `Editor.levels<T extends Node>(editor: Editor, options?): Generator<NodeEntry, void, undefined>` #### `Editor.levels<T extends Node>(editor: Editor, options?): Generator<NodeEntry<T>, void, undefined>`
Iterate through all of the levels at a location. Iterate through all of the levels at a location.
Options: `{at?: Location, match?: NodeMatch, reverse?: boolean, voids?: boolean}` Options: `{at?: Location, match?: NodeMatch, reverse?: boolean, voids?: boolean}`
#### `Editor.marks(editor: Editor): Omit<Text, 'text'> | null`
Get the marks that would be added to text at the current selection.
#### `Editor.next<T extends Descendant>(editor: Editor, options?): NodeEntry<T> | undefined` #### `Editor.next<T extends Descendant>(editor: Editor, options?): NodeEntry<T> | undefined`
Get the matching node in the branch of the document after a location. Get the matching node in the branch of the document after a location.
@@ -107,6 +111,8 @@ Options: `{at?: Location, match?: NodeMatch, mode?: 'all' | 'highest' | 'lowest'
#### `Editor.node(editor: Editor, at: Location, options?): NodeEntry` #### `Editor.node(editor: Editor, at: Location, options?): NodeEntry`
#### `Editor.nodes<T extends Node>(editor: Editor, options?): Generator<NodeEntry<T>, void, undefined>`
Get the node at a location. Get the node at a location.
Options: `depth?: number, edge?: 'start' | 'end'` Options: `depth?: number, edge?: 'start' | 'end'`
@@ -171,7 +177,7 @@ Note: By default void nodes are treated as a single point and iteration will not
Options: `{at?: Location, unit?: 'offset' | 'character' | 'word' | 'line' | 'block', reverse?: boolean, voids?: boolean}` Options: `{at?: Location, unit?: 'offset' | 'character' | 'word' | 'line' | 'block', reverse?: boolean, voids?: boolean}`
#### `Editor.previous(editor: Editor, options?): NodeEntry<T> | undefined` #### `Editor.previous<T extends Node>(editor: Editor, options?): NodeEntry<T> | undefined`
Get the matching node in the branch of the document before a location. Get the matching node in the branch of the document before a location.