mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-09-08 22:20:41 +02:00
Code Issues Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Ian Storm Taylor
2016-07-11 15:57:26 -07:00
parent e218de18eb
commit 87341490ed
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/models/selection.md
View File

@@ -1,5 +1,5 @@
### `Selection` ## `Selection`
```js ```js
import { Selection } from 'Slate' import { Selection } from 'Slate'
@@ -49,7 +49,7 @@ Often times, you don't need to specifically know which point is the "anchor" and
- [`moveTo{Edge}()`](movetoedge) - [`moveTo{Edge}()`](movetoedge)
### Properties ## Properties
```js ```js
new Selection({ new Selection({
@@ -87,7 +87,7 @@ Whether the selection is backward. A selection is considered "backward" when its
Whether the selection currently has focus. Whether the selection currently has focus.
### Computed Properties ## Computed Properties
These properties aren't supplied when creating a selection, but are instead computed based on the real properties. These properties aren't supplied when creating a selection, but are instead computed based on the real properties.
@@ -115,7 +115,7 @@ The opposite of `isBackward`, for convenience.
A few convenience properties for accessing the first and last point of the selection. When the selection is forward, `start` refers to the `anchor` point and `end` refers to the `focus` point. And when it's backward they are reversed. A few convenience properties for accessing the first and last point of the selection. When the selection is forward, `start` refers to the `anchor` point and `end` refers to the `focus` point. And when it's backward they are reversed.
### Checking Methods ## Checking Methods
#### `has{Edge}AtStartOf(node: Node) => Boolean` #### `has{Edge}AtStartOf(node: Node) => Boolean`
@@ -142,7 +142,7 @@ Determine whether the selection is at the start of a `node`.
Determine whether the selection is at the end of a `node`. Determine whether the selection is at the end of a `node`.
### Transforming Methods ## Transforming Methods
Since `Selection`s are immutable, all of the transforming methods return a new instance of the selection. Since `Selection`s are immutable, all of the transforming methods return a new instance of the selection.