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

Add descriptions of affinity to PathRef, PointRef and RangeRef documentation

Browse Source
This commit is contained in:
Sunny Hirai 2022-04-10 15:31:43 -07:00
parent e7aa292323
commit daa68dab89
3 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,7 +1,6 @@
# PathRef API
`PathRef` objects keep a specific path 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 `Path` value.
When you no longer need to track this location, call `unref()` to free the resources.
`PathRef` objects keep a specific path in a document synced over time as new operations are applied to the editor. It is created using the `Editor.pathRef` method. You can access their property `current` at any time for the up-to-date `Path` value. When you no longer need to track this location, call `unref()` to free the resources. The `affinity` refers to the direction the `PathRef` will go when a user inserts content at the current position of the `Path`.
```typescript
interface PathRef {

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

@ -1,7 +1,6 @@
# 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.
`PointRef` objects keep a specific point in a document synced over time as new operations are applied to the editor. It is created using the `Editor.pointRef` method. 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. The `affinity` refers to the direction the `PointRef` will go when a user inserts content at the current position of the `Point`.
```typescript
interface PointRef {

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

@ -1,7 +1,6 @@
# RangeRef API
`RangeRef` objects keep a specific range 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 `Range` value.
When you no longer need to track this location, call `unref()` to free the resources.
`RangeRef` objects keep a specific range in a document synced over time as new operations are applied to the editor. It is created using the `Editor.rangeRef` method. You can access their property `current` at any time for the up-to-date `Range` value. When you no longer need to track this location, call `unref()` to free the resources. The `affinity` refers to the direction the `RangeRef` will go when a user inserts content at the edges of the `Range`. `inward` means that the `Range` tends to stay the same size when content is inserted at its edges, and `outward` meaans that the `Range` tends to grow when content is inserted at its edges.
```typescript
interface RangeRef {