mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-23 15:32:59 +02:00
Code Issues Releases Wiki Activity

docs: Experiment with using ts for showing API signature

Browse Source
This commit is contained in:
Sunny Hirai
2021-06-06 17:53:21 -07:00
parent e2ae33043a
commit 614260f771
1 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -52,19 +52,22 @@ Creates a new, empty `Editor` object.
#### `Editor.above<T extends Ancestor>(editor: Editor, options?) => NodeEntry<T> | undefined` #### `Editor.above<T extends Ancestor>(editor: Editor, options?) => NodeEntry<T> | undefined`
Get the matching ancestor above a location in the document.
Options: `{at?: Location, match?: NodeMatch, mode?: 'highest' | 'lowest', voids?: boolean}`
```ts ```ts
type Options = { function Editor.above<T extends Ancestor>(
editor: Editor,
options?: {
at?: Location at?: Location
match?: NodeMatch<T> match?: NodeMatch<T>
mode?: 'highest' | 'lowest' mode?: 'highest' | 'lowest'
voids?: boolean voids?: boolean
} }
) => NodeEntry<T> | undefined
``` ```
Get the matching ancestor above a location in the document.
Options: `{at?: Location, match?: NodeMatch, mode?: 'highest' | 'lowest', voids?: boolean}`
- `mode?`: If `lowest` (default), returns the lowest matching ancestor. If `highest`, returns the highest matching ancestor. - `mode?`: If `lowest` (default), returns the lowest matching ancestor. If `highest`, returns the highest matching ancestor.
- `voids?`: If `false` (default), ignore void objects. If `true`, include `void` objects. - `voids?`: If `false` (default), ignore void objects. If `true`, include `void` objects.
- `at?`: Where to start at which is `editor.selection` by default. - `at?`: Where to start at which is `editor.selection` by default.