1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-11 17:53:59 +02:00

update docs

This commit is contained in:
Ian Storm Taylor
2016-07-11 15:53:26 -07:00
parent 413617c65a
commit 6e5221d1c2
2 changed files with 16 additions and 14 deletions

View File

@@ -1,19 +1,21 @@
### `<Editor>` ### `<Editor>`
The top-level React component that renders the Slate editor itself.
- [Module](#module)
- [Properties](#properties)
- [Methods](#methods)
### Module
```js ```js
import { Editor } from 'Slate' import { Editor } from 'Slate'
``` ```
The top-level React component that renders the Slate editor itself.
- [Properties](#properties)
- [`onChange`](#onchange-function)
- [`plugins`](#plugins-array)
- [`state`](#state-state)
- [`...`](#)
- [Methods](#methods)
- [`getState()`](#getstate-state)
- [`onChange(state)`](#onchange-state-void)
### Properties ### Properties

View File

@@ -28,10 +28,10 @@ Often times, you don't need to specifically know which point is the "anchor" and
- [`startKey`](#startkey-string) - [`startKey`](#startkey-string)
- [`startOffset`](#startoffset-number) - [`startOffset`](#startoffset-number)
- [Checking Methods](#checking-methods) - [Checking Methods](#checking-methods)
- [`has{Edge}AtEndOf`](has-edge-atendof-node) - [`has{Edge}AtEndOf`](hasedgeatendof-node)
- [`has{Edge}AtStartOf`](has-edge-atstartof-node) - [`has{Edge}AtStartOf`](hasedgeatstartof-node)
- [`has{Edge}Between`](has-edge-between-node-start-end) - [`has{Edge}Between`](hasedgebetween-node-start-end)
- [`has{Edge}In`](has-edge-in-node-start-end) - [`has{Edge}In`](hasedgein-node-start-end)
- [`isAtEndOf`](isatendof-node) - [`isAtEndOf`](isatendof-node)
- [`isAtStartOf`](isatstartof-node) - [`isAtStartOf`](isatstartof-node)
- [Transforming Methods](#transforming-methods) - [Transforming Methods](#transforming-methods)
@@ -46,7 +46,7 @@ Often times, you don't need to specifically know which point is the "anchor" and
- [`moveToEndOf`](movetoendof-node) - [`moveToEndOf`](movetoendof-node)
- [`moveToRangeOf`](movetorangeof-node) - [`moveToRangeOf`](movetorangeof-node)
- [`moveToStartOf`](movetostartof-node) - [`moveToStartOf`](movetostartof-node)
- [`moveTo{Edge}`](moveto-edge) - [`moveTo{Edge}`](movetoedge)
### Properties ### Properties