mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-09-02 11:42:53 +02:00
Code Issues Releases Wiki Activity

Adds documentation for PathRef (#4740)

Browse Source
This commit is contained in:
Doug Reeder
2021-12-22 07:04:14 -05:00
committed by GitHub
parent 205d4b7e66
commit c90ec8e837
5 changed files with 31 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/api/locations/point-ref.md
View File

@@ -1,6 +1,7 @@
# PointRef API
`PointRef` objects keep a specific point in a document synced over time as new operations are applied to the editor. You can access their property `current` at any time for the up-to-date `Point` value.
When you no longer need to track this location, call `unref()` to free the resources.
```typescript
interface PointRef {
@@ -28,4 +29,4 @@ It also returns the current value.
#### `PointRef.transform(ref: PointRef, op: Operation)`
Transform the point refs current value by an `op`.
Rarely needed, as the PointRef is updated when the editor is updated.
The editor calls this as needed, so normally you won't need to.