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

update editor reference

Browse Source
This commit is contained in:
Ian Storm Taylor
2016-07-11 18:54:15 -07:00
parent 68e1bd8c02
commit b613481f73
1 changed files with 10 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/reference/components/editor.md
View File

@@ -2,7 +2,7 @@
# `<Editor>` # `<Editor>`
```js ```js
import { Editor } from 'Slate' import { Editor } from 'slate'
``` ```
The top-level React component that renders the Slate editor itself. The top-level React component that renders the Slate editor itself.
@@ -11,7 +11,13 @@ The top-level React component that renders the Slate editor itself.
- [`onChange`](#onchange-function) - [`onChange`](#onchange-function)
- [`plugins`](#plugins-array) - [`plugins`](#plugins-array)
- [`state`](#state-state) - [`state`](#state-state)
- [`more...`](#more) - [Plugin-like Properties](#plugin-like-properties)
- [`onBeforeInput`](#onbeforeinput-function)
- [`onKeyDown`](#onkeydown-function)
- [`onPaste`](#onpaste-function)
- [`renderDecorations`](#renderdecorations-function)
- [`renderMark`](#rendermark-function)
- [`renderNode`](#rendernode-function)
- [Methods](#methods) - [Methods](#methods)
- [`getState()`](#getstate-state) - [`getState()`](#getstate-state)
- [`onChange(state)`](#onchange-state-void) - [`onChange(state)`](#onchange-state-void)
@@ -39,23 +45,10 @@ An array of [`Plugins`](../plugins) that define the editor's behavior.
A [`State`](../models/state) object representing the current state of the editor. A [`State`](../models/state) object representing the current state of the editor.
#### `more...`
In addition to those two properties, the editor allows passing any of the properties that a [`Plugin`](../plugins) can define: ## Plugin-like Properties
```js In addition to its own properties, the editor allows passing any of the properties that a [`Plugin`](../plugins) defines as well.
<Editor
onBeforeInput={Function}
onChange={Function}
onKeyDown={Function}
onPaste={Function}
plugins={Array}
renderDecorations={Function}
renderMark={Function}
renderNode={Function}
state={State}
/>
```
These properties are actually just a convenience—an implicit plugin defintion. Internally, they are grouped together and turned into a plugin that is given first priority in the plugin stack. These properties are actually just a convenience—an implicit plugin defintion. Internally, they are grouped together and turned into a plugin that is given first priority in the plugin stack.