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

Moved documentation for refs in the Editor into its own section

Browse Source
This commit is contained in:
Sunny Hirai 2022-04-10 15:35:48 -07:00
parent daa68dab89
commit bb4f1934c9
1 changed files with 33 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -35,6 +35,7 @@ interface Editor {
- [Manipulation methods](editor.md#manipulation-methods)
- [Check methods](editor.md#check-methods)
- [Normalization methods](editor.md#normalization-methods)
- [Ref methods](editor.md#ref-methods)
- [Instance methods](editor.md#instance-methods)
- [Schema-specific methods to override](editor.md#schema-specific-instance-methods-to-override)
- [Element Type Methods](editor.md/#element-type-methods)
@ -161,32 +162,12 @@ Get the path of a location.
Options: `{depth?: number, edge?: 'start' | 'end'}`
#### `Editor.pathRef(editor: Editor, path: Path, options?) => PathRef`
Create a mutable ref for a `Path` object, which will stay in sync as new operations are applied to the editor.
Options: `{affinity?: 'backward' | 'forward' | null}`
#### `Editor.pathRefs(editor: Editor) => Set<PathRef>`
Get the set of currently tracked path refs of the editor.
#### `Editor.point(editor: Editor, at: Location, options?) => Point`
Get the start or end point of a location.
Options: `{edge?: 'start' | 'end'}`
#### `Editor.pointRef(editor: Editor, point: Point, options?) => PointRef`
Create a mutable ref for a `Point` object, which will stay in sync as new operations are applied to the editor.
Options: `{affinity?: 'backward' | 'forward' | null}`
#### `Editor.pointRefs(editor: Editor) => Set<PointRef>`
Get the set of currently tracked point refs of the editor.
#### `Editor.positions(editor: Editor, options?) => Generator<Point, void, undefined>`
Iterate through all of the positions in the document where a `Point` can be placed. The first `Point` returns is always the starting point followed by the next `Point` as determined by the `unit` option.
@ -218,16 +199,6 @@ Options: `{at?: Location, match?: NodeMatch, mode?: 'all' | 'highest' | 'lowest'
Get a range of a location.
#### `Editor.rangeRef(editor: Editor, range: Range, options?) => RangeRef`
Create a mutable ref for a `Range` object, which will stay in sync as new operations are applied to the editor.
Options: `{affinity?: 'backward' | 'forward' | 'outward' | 'inward' | null}`
#### `Editor.rangeRefs(editor: Editor) => Set<RangeRef>`
Get the set of currently tracked range refs of the editor.
#### `Editor.start(editor: Editor, at: Location) => Point`
Get the start point of a location.
@ -376,6 +347,38 @@ Options: `{force?: boolean}`
Call a function, deferring normalization until after it completes.
See [Normalization - Implications for Other Code](./11-normalizing.md#implications-for-other-code);
### Ref Methods
#### `Editor.pathRef(editor: Editor, path: Path, options?) => PathRef`
Create a mutable ref for a `Path` object, which will stay in sync as new operations are applied to the editor.
Options: `{affinity?: 'backward' | 'forward' | null}`
#### `Editor.pathRefs(editor: Editor) => Set<PathRef>`
Get the set of currently tracked path refs of the editor.
#### `Editor.pointRef(editor: Editor, point: Point, options?) => PointRef`
Create a mutable ref for a `Point` object, which will stay in sync as new operations are applied to the editor.
Options: `{affinity?: 'backward' | 'forward' | null}`
#### `Editor.pointRefs(editor: Editor) => Set<PointRef>`
Get the set of currently tracked point refs of the editor.
#### `Editor.rangeRef(editor: Editor, range: Range, options?) => RangeRef`
Create a mutable ref for a `Range` object, which will stay in sync as new operations are applied to the editor.
Options: `{affinity?: 'backward' | 'forward' | 'outward' | 'inward' | null}`
#### `Editor.rangeRefs(editor: Editor) => Set<RangeRef>`
Get the set of currently tracked range refs of the editor.
## Instance Methods
### Schema-specific instance methods to override