From b2a94d7efba242780151745dd4bbfb3aac3b6e27 Mon Sep 17 00:00:00 2001 From: Ian Storm Taylor Date: Mon, 11 Jul 2016 13:19:39 -0700 Subject: [PATCH] update docs --- docs/reference/components/editor.md | 32 +++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/reference/components/editor.md diff --git a/docs/reference/components/editor.md b/docs/reference/components/editor.md new file mode 100644 index 000000000..515adf5f5 --- /dev/null +++ b/docs/reference/components/editor.md @@ -0,0 +1,32 @@ + +### `` + +The top-level React component that renders the Slate editor itself. + +```js + +``` + +The editor takes a `State` instance that contains it's content and selection. + +Most of the editor's other properties are actually an implicit plugin defintion. Internally they are grouped together and turned into a plugin that is given first priority in the plugin stack. + +#### Properties + +#### `onChange(state, editor)` + +A handler that's called every time the editor's state changes. It is called with the newly changed `state` and the `editor` instance itself. + + +#### Methods + +#### `getState()` + +Return the editor's current internal state.