mirror/tiptap
1
0
Fork 0
mirror of https://github.com/ueberdosis/tiptap.git synced 2024-12-15 02:59:01 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #411 from ryanbliss/nodeview-prop-documentation

Browse Source 
Added NodeView Prop Types documentation
This commit is contained in:
Philipp Kühn 2019-07-27 19:20:37 +02:00 committed by GitHub
commit ba3df21c98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -446,6 +446,19 @@ export default class IframeNode extends Node {
}
```
#### NodeView Prop Types
| **Prop** | **Type** | **Description** |
| --- | :---: | --- |
| `node` | `Object` | The Prosemirror node object. Common use case is to get `node.attrs` using a getter on a computed property. |
| `updateAttrs` | `Function` | A function to update `node.attrs` defined in `schema`. Common use case is as setter on a computed property. |
| `view` | `Object` | The Prosemirror editor view instance. |
| `options` | `Array` | An array of your extension options. |
| `getPos` | `Function` | A function that returns the anchored position of the node. |
| `selection` | `Boolean` | A boolean that is set when the node is or is not selected. Common use case is using `watch` to see when the view is selected/unselected to do something, such focus an `<input>` or refocus the editor. |
## Editor Methods
## Development Setup
Currently, only Yarn is supported for development because of a feature called workspaces we are using here.