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

add collaborative editing guide

Browse Source
This commit is contained in:
Hans Pagel
2020-11-27 17:23:04 +01:00
parent bfc6a45292
commit 996c29bcf7
6 changed files with 285 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/docPages/api/extensions/collaboration-cursor.md
View File

@@ -21,10 +21,12 @@ yarn add @tiptap/extension-collaboration-cursor
```
## Settings
| Option | Type | Default | Description |
| -------- | ---- | ------- | ----------- |
| provider | | | |
| type | | | |
| Option | Type | Default | Description |
| -------- | ---------- | ----------- | ----------------------------------------------------------------------------------- |
| provider | `Object` | `null` | The Y.js provider, for example a WebSocket connection. |
| name | `String` | `'Someone'` | The name of the current user. |
| color | `String` | `'#cccccc'` | The current user’s cursor color. |
| render | `Function` | … | A render function for the cursor, look at the extension source code for an example. |
## Commands
| Command | Parameters | Description |