mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-28 17:39:57 +02:00
Code Issues Releases Wiki Activity

Clarify instructions for plugin preventing default behavior (#740)

Browse Source
This commit is contained in:
Anuj
2017-04-21 21:17:04 -07:00
committed by Ian Storm Taylor
parent eb03bd8ec4
commit 51f1a2f9d9
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/plugins/plugin.md
View File

@@ -63,7 +63,7 @@ Each event handler can choose to return a new `state` object, in which case the
This handler is called right before a string of text is inserted into the `contenteditable` element. This handler is called right before a string of text is inserted into the `contenteditable` element.
Make sure to `event.preventDefault()` if you do not want the default insertion behavior to occur! If no other plugin handles this event, it will be handled by the [Core plugin](./core.md). Make sure to `event.preventDefault()` (and return `state`) if you do not want the default insertion behavior to occur! If no other plugin handles this event, it will be handled by the [Core plugin](./core.md).
### `onBlur` ### `onBlur`
`Function onBlur(event: Event, data: Object, state: State, editor: Editor) => State || Void` `Function onBlur(event: Event, data: Object, state: State, editor: Editor) => State || Void`
@@ -161,7 +161,7 @@ The `isModAlt` boolean is `true` if the `control` key was pressed on Windows or
The `isLine` and `isWord` booleans represent whether the "line modifier" or "word modifier" hotkeys are pressed when deleteing or moving the cursor. For example, on a Mac `option + right` moves the cursor to the right one word at a time. The `isLine` and `isWord` booleans represent whether the "line modifier" or "word modifier" hotkeys are pressed when deleteing or moving the cursor. For example, on a Mac `option + right` moves the cursor to the right one word at a time.
Make sure to `event.preventDefault()` if you do not want the default insertion behavior to occur! If no other plugin handles this event, it will be handled by the [Core plugin](./core.md). Make sure to `event.preventDefault()` (and return `state`) if you do not want the default insertion behavior to occur! If no other plugin handles this event, it will be handled by the [Core plugin](./core.md).
### `onPaste` ### `onPaste`
`Function onPaste(event: Event, data: Object, state: State, editor: Editor) => State || Void` `Function onPaste(event: Event, data: Object, state: State, editor: Editor) => State || Void`