From 2802f4fa7c3dab6a20bd11205c54a4f40b84669f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Ku=CC=88hn?= Date: Tue, 13 Nov 2018 22:24:53 +0100 Subject: [PATCH] update readme --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0d6c904c..e5ed38e8 100644 --- a/README.md +++ b/README.md @@ -60,16 +60,17 @@ export default { ``` - +| `onInit` | `Function` | `undefined` | This will return an Object with the current `state` and `view` of Prosemirror on init. | +| `onFocus` | `Function` | `undefined` | This will return an Object with the current `state` and `view` of Prosemirror on focus. | +| `onBlur` | `Function` | `undefined` | This will return an Object with the current `state` and `view` of Prosemirror on blur. | +| `onUpdate` | `Function` | `undefined` | This will return an Object with the current `state` of Prosemirror, a `getJSON()` and `getHTML()` function on every change. | ## Components @@ -267,6 +268,7 @@ The most powerful feature of tiptap is that you can create your own extensions. | `get defaultOptions()` | `Object` | `{}` | Define some default options. The options are available as `this.$options`. | | `get plugins()` | `Array` | `[]` | Define a list of [Prosemirror plugins](https://prosemirror.net/docs/guide/). | | `keys({ schema })` | `Object` | `null` | Define some keybindings. | +| `commands({ schema, attrs })` | `Object` | `null` | Define a command. | | `inputRules({ schema })` | `Array` | `[]` | Define a list of input rules. | ### Node|Mark Class @@ -278,7 +280,7 @@ The most powerful feature of tiptap is that you can create your own extensions. | `get schema()` | `Object` | `null` | Define a [schema](https://prosemirror.net/docs/guide/#schema). | | `get view()` | `Object` | `null` | Define a node view as a vue component. | | `keys({ type, schema })` | `Object` | `null` | Define some keybindings. | -| `command({ type, schema, attrs })` | `Object` | `null` | Define a command. This is used for menus to convert to this node or mark. | +| `commands({ type, schema, attrs })` | `Object` | `null` | Define a command. For example this is used for menus to convert to this node or mark. | | `inputRules({ type, schema })` | `Array` | `[]` | Define a list of input rules. | | `get plugins()` | `Array` | `[]` | Define a list of [Prosemirror plugins](https://prosemirror.net/docs/guide/). |