File size: 2,974 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# Range API
`Range` objects are a set of points that refer to a specific span of a Slate document. They can define a span inside a single node or they can span across multiple nodes. The editor's `selection` is stored as a range.
```typescript
interface Range {
anchor: Point
focus: Point
}
```
- [Static methods](range.md#static-methods)
- [Retrieval methods](range.md#retrieval-methods)
- [Check methods](range.md#check-methods)
- [Transform methods](range.md#transform-methods)
## Static methods
### Retrieval methods
#### `Range.edges(range: Range, options?) => [Point, Point]`
Get the start and end points of a `range`, in the order in which they appear in the document.
Options: `{reverse?: boolean}`
#### `Range.end(range: Range) => Point`
Get the end point of a `range` according to the order in which it appears in the document.
#### `Range.intersection(range: Range, another: Range) => Range | null`
Get the intersection of one `range` with `another`. If the two ranges do not overlap, return `null`.
#### `Range.points(range: Range) => Generator<PointEntry>`
Iterate through the two point entries in a `Range`. First it will yield a `PointEntry` representing the `anchor`, then it will yield a `PointEntry` representing the `focus`.
#### `Range.start(range: Range) => Point`
Get the start point of a `range` according to the order in which it appears in the document.
### Check methods
Check some attribute of a Range. Always returns a boolean.
#### `Range.equals(range: Range, another: Range) => boolean`
Check if a `range` is exactly equal to `another`.
#### `Range.includes(range: Range, target: Path | Point | Range) => boolean`
Check if a `range` includes a path, a point, or part of another range.
For clarity the definition of `includes` can mean partially includes. Another way to describe this is if one Range intersects the other Range.
#### `Range.surrounds(range: Range, target: Range) => boolean`
Check if a `range` includes another range.
#### `Range.isBackward(range: Range) => boolean`
Check if a `range` is backward, meaning that its anchor point appears _after_ its focus point in the document.
#### `Range.isCollapsed(range: Range) => boolean`
Check if a `range` is collapsed, meaning that both its anchor and focus points refer to the exact same position in the document.
#### `Range.isExpanded(range: Range) => boolean`
Check if a `range` is expanded. This is the opposite of `Range.isCollapsed` and is provided for legibility.
#### `Range.isForward(range: Range) => boolean`
Check if a `range` is forward. This is the opposite of `Range.isBackward` and is provided for legibility.
#### `Range.isRange(value: any) => value is Range`
Check if a `value` implements the `Range` interface.
### Transform methods
#### `Range.transform(range: Range, op: Operation, options) => Range | null`
Transform a `range` by an `op`.
Options: `{affinity: 'forward' | 'backward' | 'outward' | 'inward' | null}`
|