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

add content to the collaboration cursor extension

Browse Source
This commit is contained in:
Hans Pagel
2020-11-05 21:57:25 +01:00
parent 810f3d6b6d
commit f946954e91
8 changed files with 24 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,7 +1,14 @@
# Collaboration Cursor
This extension adds information about all connected users (like their name and a specified color), their current cursor position and their text selection (if there’s one).
:::premium Premium Extension
Using this in production requires a **tiptap pro** license. [Read more](/sponsor)
Open this page in multiple browser windows to test it.
:::premium 💖 Pro Extension
We kindly ask you to sponsor us, before using this extension in production. [Read more](/sponsor)
:::
::: warning Use with Collaboration
This extension requires the [`Collaboration`](/api/extensions/collaboration) extension.
:::
## Installation
@@ -31,4 +38,4 @@ yarn add @tiptap/extension-collaboration-cursor
:::warning Public
The content of this editor is shared with other users.
:::
<demo name="Extensions/CollaborationCursor" highlight="" />
<demo name="Extensions/CollaborationCursor" highlight="11,48-52" />

6
docs/src/docPages/api/extensions/collaboration.md
View File

@@ -1,8 +1,8 @@
# Collaboration
The Collaboration extension enables you to collaborate with others on one 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.
:::premium Premium Extension
Using this in production requires a **tiptap pro** license. [Read more](/sponsor)
:::premium Pro Extension
We kindly ask you to sponsor us, before using this extension in production. [Read more](/sponsor)
:::
## Installation
@@ -33,4 +33,4 @@ yarn add @tiptap/extension-collaboration yjs y-webrtc
:::warning Public
The content of this editor is shared with other users.
:::
<demo name="Extensions/Collaboration" highlight="" />
<demo name="Extensions/Collaboration" highlight="10-12,30-32,43-46,53" />

4
docs/src/docPages/api/extensions/dropcursor.md
View File

@@ -1,5 +1,5 @@
# Dropcursor
This extension loads the [ProseMirror Gapcursor plugin](https://github.com/ProseMirror/prosemirror-gapcursor) by Marijn Haverbeke, which adds a gap for the cursor in places that don’t allow regular selection. For example, after a table at the end of a document.
This extension loads the [ProseMirror Dropcursor plugin](https://github.com/ProseMirror/prosemirror-dropcursor) by Marijn Haverbeke, which shows a cursor at the drop position when something is dragged over the editor.
Note that tiptap is renderless, but the dropcursor needs CSS for its appearance. The default CSS is added to the usage example below.
@@ -16,4 +16,4 @@ yarn add @tiptap/extension-dropcursor
[packages/extension-dropcursor/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-dropcursor/)
## Usage
<demo name="Extensions/Dropcursor" highlight="" />
<demo name="Extensions/Dropcursor" highlight="12,33" />

3
docs/src/docPages/api/extensions/focus.md
View File

@@ -1,4 +1,7 @@
# Focus
The Focus extension adds a CSS class to focused nodes. By default it adds `.has-class`, but you can change that.
Note that it’s only a class, the styling is totally up to you. The usage example below has some CSS for that class.
## Installation
```bash