ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Philipp Kühn
2018-08-23 08:33:21 +02:00
committed by GitHub
parent 4058338bf7
commit fa70fc5d98
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -35,6 +35,20 @@ export default {
</script> </script>
``` ```
## Editor Properties
| Property | Type | Default | Description |
| - | :-: | :-: | - |
| editable | Boolean | `true` | When set to `false` the editor is read-only. |
| doc | Object | `null` | The editor state object used by Prosemirror. You can also pass HTML to the `content` slot. When used both, the `content` slot will be ignored. |
| extensions | Array | `[]` | A list of extensions used, by the editor. This can be `Nodes`, `Marks` or `Plugins`. |
| @update | Function | `undefined` | This will return the current `state` of Prosemirror on every change. |
## Extensions
Soon …
Until then you can take a look at the [embed example](https://github.com/heyscrumpy/tiptap/tree/master/examples/Components/Routes/Embeds).
## Contributing ## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details. Please see [CONTRIBUTING](CONTRIBUTING.md) for details.