mirror of
https://github.com/ueberdosis/tiptap.git
synced 2025-01-10 05:58:13 +08:00
53 lines
2.6 KiB
Markdown
53 lines
2.6 KiB
Markdown
# Collaboration
|
||
[](https://www.npmjs.com/package/@tiptap/extension-collaboration)
|
||
[](https://npmcharts.com/compare/@tiptap/extension-collaboration?minimal=true)
|
||
|
||
The Collaboration extension enables you to collaborate with others in a single document. The implementation is based on [Y.js by Kevin Jahns](https://github.com/yjs/yjs), which is the coolest thing to [integrate collaborative editing](/guide/collaborative-editing) in your project.
|
||
|
||
The history works totally different in a collaborative editing setup. If you undo a change, you don’t want to undo changes of other users. To handle that behaviour this extension provides an own `undo` and `redo` command. Don’t load the default [`History`](/api/extensions/history) extension together with the Collaboration extension to avoid conflicts.
|
||
|
||
:::pro Pro Extension
|
||
We kindly ask you to [sponsor our work](/sponsor) when using this extension in production.
|
||
:::
|
||
|
||
## Installation
|
||
```bash
|
||
# with npm
|
||
npm install @tiptap/extension-collaboration yjs y-websocket
|
||
|
||
# with Yarn
|
||
yarn add @tiptap/extension-collaboration yjs y-websocket
|
||
```
|
||
|
||
## Settings
|
||
| Option | Type | Default | Description |
|
||
| -------- | -------- | ----------- | --------------------------------------------------------------------------------------- |
|
||
| document | `Object` | `null` | An initialized Y.js document. |
|
||
| field | `String` | `'default'` | Name of a Y.js fragment, can be changed to sync multiple fields with one Y.js document. |
|
||
| fragment | `Object` | `null` | A raw Y.js fragment, can be used instead of `document` and `field`. |
|
||
|
||
## Commands
|
||
| Command | Parameters | Description |
|
||
| ------- | ---------- | --------------------- |
|
||
| undo | — | Undo the last change. |
|
||
| redo | — | Redo the last change. |
|
||
|
||
## Keyboard shortcuts
|
||
### Undo
|
||
* Windows/Linux: `Control` `Z`
|
||
* macOS: `Cmd` `Z`
|
||
|
||
### Redo
|
||
* Windows/Linux: `Shift` `Control` `Z` or `Control` `Y`
|
||
* macOS: `Shift` `Cmd` `Z` or `Cmd` `Y`
|
||
|
||
## Source code
|
||
[packages/extension-collaboration/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-collaboration/)
|
||
|
||
## Usage
|
||
:::warning Public
|
||
The content of this editor is shared with other users.
|
||
:::
|
||
<tiptap-demo name="Extensions/Collaboration" hideSource></tiptap-demo>
|
||
<tiptap-demo name="Extensions/Collaboration"></tiptap-demo>
|