Rename CollaborationCursor extension to CollaborationCaret (#6173)

bdbch · web-flow · commit 25ec82eca65e · 2025-03-12T15:54:27.000+01:00
* rename collaboration-cursor to collaboration-caret

* added changeset
diff --git a/.changeset/chilled-trees-agree.md b/.changeset/chilled-trees-agree.md
@@ -1,5 +1,5 @@
 ---
-'@tiptap/extension-collaboration-cursor': major
+'@tiptap/extension-collaboration-caret': major
 '@tiptap/extension-code-block-lowlight': major
 '@tiptap/extension-character-count': major
 '@tiptap/extension-horizontal-rule': major
diff --git a/.changeset/cuddly-impalas-heal.md b/.changeset/cuddly-impalas-heal.md
@@ -11,7 +11,7 @@
 '@tiptap/extension-code-block': patch
 '@tiptap/extension-code-block-lowlight': patch
 '@tiptap/extension-collaboration': patch
-'@tiptap/extension-collaboration-cursor': patch
+'@tiptap/extension-collaboration-caret': patch
 '@tiptap/extension-color': patch
 '@tiptap/extension-document': patch
 '@tiptap/extension-dropcursor': patch
diff --git a/.changeset/eighty-gifts-matter.md b/.changeset/eighty-gifts-matter.md
@@ -1,5 +1,5 @@
 ---
-'@tiptap/extension-collaboration-cursor': major
+'@tiptap/extension-collaboration-caret': major
 '@tiptap/extension-collaboration': major
 ---
 
diff --git a/.changeset/many-laws-vanish.md b/.changeset/many-laws-vanish.md
@@ -0,0 +1,5 @@
+---
+'@tiptap/extension-collaboration-caret': major
+---
+
+Renamed `@tiptap/extension-collaboration-cursor` to `@tiptap/extension-collaboration-caret` to clarify what kind of cursor this extension is implementing.
diff --git a/.changeset/pre.json b/.changeset/pre.json
@@ -13,7 +13,7 @@
     "@tiptap/extension-code-block": "2.11.4",
     "@tiptap/extension-code-block-lowlight": "2.11.4",
     "@tiptap/extension-collaboration": "2.11.4",
-    "@tiptap/extension-collaboration-cursor": "2.11.4",
+    "@tiptap/extension-collaboration-caret": "2.11.4",
     "@tiptap/extension-color": "2.11.4",
     "@tiptap/extension-document": "2.11.4",
     "@tiptap/extension-dropcursor": "2.11.4",
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -15,7 +15,7 @@
     "extension/code-block",
     "extension/code-block-lowlight",
     "extension/collaboration",
-    "extension/collaboration-cursor",
+    "extension/collaboration-caret",
     "extension/color",
     "extension/document",
     "extension/dropcursor",
diff --git a/demos/src/Demos/CollaborationSplitPane/React/Editor.jsx b/demos/src/Demos/CollaborationSplitPane/React/Editor.jsx
@@ -1,5 +1,5 @@
 import Collaboration from '@tiptap/extension-collaboration'
-import CollaborationCursor from '@tiptap/extension-collaboration-cursor'
+import CollaborationCaret from '@tiptap/extension-collaboration-caret'
 import Highlight from '@tiptap/extension-highlight'
 import { TaskItem, TaskList } from '@tiptap/extension-list'
 import { CharacterCount } from '@tiptap/extensions'
@@ -106,7 +106,7 @@ const Editor = ({ ydoc, provider, room }) => {
       Collaboration.extend().configure({
         document: ydoc,
       }),
-      CollaborationCursor.extend().configure({
+      CollaborationCaret.extend().configure({
         provider,
       }),
     ],
@@ -187,8 +187,8 @@ const Editor = ({ ydoc, provider, room }) => {
       <div className="collab-status-group" data-state={status === 'connected' ? 'online' : 'offline'}>
         <label>
           {status === 'connected'
-            ? `${editor.storage.collaborationCursor.users.length} user${
-                editor.storage.collaborationCursor.users.length === 1 ? '' : 's'
+            ? `${editor.storage.collaborationCaret.users.length} user${
+                editor.storage.collaborationCaret.users.length === 1 ? '' : 's'
               } online in ${room}`
             : 'offline'}
         </label>
diff --git a/demos/src/Demos/CollaborationSplitPane/React/styles.scss b/demos/src/Demos/CollaborationSplitPane/React/styles.scss
@@ -132,7 +132,7 @@
   }
 
   /* Give a remote user a caret */
-  .collaboration-cursor__caret {
+  .collaboration-carets__caret {
     border-left: 1px solid #0d0d0d;
     border-right: 1px solid #0d0d0d;
     margin-left: -1px;
@@ -143,7 +143,7 @@
   }
 
   /* Render the username above the caret */
-  .collaboration-cursor__label {
+  .collaboration-carets__label {
     border-radius: 3px 3px 3px 0;
     color: #0d0d0d;
     font-size: 12px;
diff --git a/demos/src/Demos/SingleRoomCollab/React/index.jsx b/demos/src/Demos/SingleRoomCollab/React/index.jsx
@@ -2,7 +2,7 @@ import './styles.scss'
 
 import { TiptapCollabProvider } from '@hocuspocus/provider'
 import Collaboration from '@tiptap/extension-collaboration'
-import CollaborationCursor from '@tiptap/extension-collaboration-cursor'
+import CollaborationCaret from '@tiptap/extension-collaboration-caret'
 import { CharacterCount } from '@tiptap/extensions'
 import { EditorContent, useEditor } from '@tiptap/react'
 import StarterKit from '@tiptap/starter-kit'
@@ -75,7 +75,7 @@ export default () => {
       Collaboration.configure({
         document: ydoc,
       }),
-      CollaborationCursor.configure({
+      CollaborationCaret.configure({
         provider: websocketProvider,
       }),
     ],
@@ -115,7 +115,7 @@ export default () => {
         <div className="editor__users">
           <div className={`editor__status editor__status--${status}`}>
             {status === 'connected'
-              ? `${editor.storage.collaborationCursor.users.length} user${editor.storage.collaborationCursor.users.length === 1 ? '' : 's'} online in ${room}`
+              ? `${editor.storage.collaborationCaret.users.length} user${editor.storage.collaborationCaret.users.length === 1 ? '' : 's'} online in ${room}`
               : 'offline'}
           </div>
           <div className="editor__name">
diff --git a/demos/src/Demos/SingleRoomCollab/React/styles.scss b/demos/src/Demos/SingleRoomCollab/React/styles.scss
@@ -160,7 +160,7 @@
 }
 
 /* Give a remote user a caret */
-.collaboration-cursor__caret {
+.collaboration-carets__caret {
   border-left: 1px solid #0d0d0d;
   border-right: 1px solid #0d0d0d;
   margin-left: -1px;
@@ -171,7 +171,7 @@
 }
 
 /* Render the username above the caret */
-.collaboration-cursor__label {
+.collaboration-carets__label {
   border-radius: 3px 3px 3px 0;
   color: #0d0d0d;
   font-size: 0.75rem;
diff --git a/demos/src/Examples/CollaborativeEditing/React/index.jsx b/demos/src/Examples/CollaborativeEditing/React/index.jsx
@@ -2,7 +2,7 @@ import './styles.scss'
 
 import { TiptapCollabProvider } from '@hocuspocus/provider'
 import Collaboration from '@tiptap/extension-collaboration'
-import CollaborationCursor from '@tiptap/extension-collaboration-cursor'
+import CollaborationCaret from '@tiptap/extension-collaboration-caret'
 import Highlight from '@tiptap/extension-highlight'
 import { TaskItem, TaskList } from '@tiptap/extension-list'
 import { CharacterCount } from '@tiptap/extensions'
@@ -89,7 +89,7 @@ export default () => {
       Collaboration.configure({
         document: ydoc,
       }),
-      CollaborationCursor.configure({
+      CollaborationCaret.configure({
         provider: websocketProvider,
       }),
     ],
@@ -125,7 +125,7 @@ export default () => {
       <div className="editor__footer">
         <div className={`editor__status editor__status--${status}`}>
           {status === 'connected'
-            ? `${editor.storage.collaborationCursor.users.length} user${editor.storage.collaborationCursor.users.length === 1 ? '' : 's'} online in ${room}`
+            ? `${editor.storage.collaborationCaret.users.length} user${editor.storage.collaborationCaret.users.length === 1 ? '' : 's'} online in ${room}`
             : 'offline'}
         </div>
         <div className="editor__name">
diff --git a/demos/src/Examples/CollaborativeEditing/React/styles.scss b/demos/src/Examples/CollaborativeEditing/React/styles.scss
@@ -172,7 +172,7 @@
 }
 
 /* Give a remote user a caret */
-.collaboration-cursor__caret {
+.collaboration-carets__caret {
   border-left: 1px solid #0d0d0d;
   border-right: 1px solid #0d0d0d;
   margin-left: -1px;
@@ -183,7 +183,7 @@
 }
 
 /* Render the username above the caret */
-.collaboration-cursor__label {
+.collaboration-carets__label {
   border-radius: 3px 3px 3px 0;
   color: #0d0d0d;
   font-size: 12px;
diff --git a/demos/src/Examples/CollaborativeEditing/Vue/index.vue b/demos/src/Examples/CollaborativeEditing/Vue/index.vue
@@ -5,8 +5,8 @@
     <div class="editor__footer">
       <div :class="`editor__status editor__status--${status}`">
         <template v-if="status === 'connected'">
-          {{ editor.storage.collaborationCursor.users.length }} user{{
-            editor.storage.collaborationCursor.users.length === 1 ? '' : 's'
+          {{ editor.storage.collaborationCaret.users.length }} user{{
+            editor.storage.collaborationCaret.users.length === 1 ? '' : 's'
           }}
           online in {{ room }}
         </template>
@@ -24,7 +24,7 @@
 <script>
 import { TiptapCollabProvider } from '@hocuspocus/provider'
 import Collaboration from '@tiptap/extension-collaboration'
-import CollaborationCursor from '@tiptap/extension-collaboration-cursor'
+import CollaborationCaret from '@tiptap/extension-collaboration-caret'
 import Highlight from '@tiptap/extension-highlight'
 import { TaskItem, TaskList } from '@tiptap/extension-list'
 import { CharacterCount } from '@tiptap/extensions'
@@ -88,7 +88,7 @@ export default {
         Collaboration.configure({
           document: ydoc,
         }),
-        CollaborationCursor.configure({
+        CollaborationCaret.configure({
           provider: this.provider,
           user: this.currentUser,
         }),
@@ -251,7 +251,7 @@ export default {
 }
 
 /* Give a remote user a caret */
-.collaboration-cursor__caret {
+.collaboration-carets__caret {
   border-left: 1px solid #0d0d0d;
   border-right: 1px solid #0d0d0d;
   margin-left: -1px;
@@ -262,7 +262,7 @@ export default {
 }
 
 /* Render the username above the caret */
-.collaboration-cursor__label {
+.collaboration-carets__label {
   border-radius: 3px 3px 3px 0;
   color: #0d0d0d;
   font-size: 12px;
diff --git a/demos/src/Extensions/CollaborationCaret/React/index.html b/demos/src/Extensions/CollaborationCaret/React/index.html
diff --git a/demos/src/Extensions/CollaborationCaret/React/index.jsx b/demos/src/Extensions/CollaborationCaret/React/index.jsx
@@ -1,7 +1,7 @@
 import './styles.scss'
 
 import Collaboration from '@tiptap/extension-collaboration'
-import CollaborationCursor from '@tiptap/extension-collaboration-cursor'
+import CollaborationCaret from '@tiptap/extension-collaboration-caret'
 import Document from '@tiptap/extension-document'
 import Paragraph from '@tiptap/extension-paragraph'
 import Text from '@tiptap/extension-text'
@@ -12,7 +12,7 @@ import { WebrtcProvider } from 'y-webrtc'
 import * as Y from 'yjs'
 
 const ydoc = new Y.Doc()
-const provider = new WebrtcProvider('tiptap-collaboration-cursor-extension', ydoc)
+const provider = new WebrtcProvider('tiptap-collaboration-caret-extension', ydoc)
 
 function Component() {
   const editor = useEditor({
@@ -23,7 +23,7 @@ function Component() {
       Collaboration.configure({
         document: ydoc,
       }),
-      CollaborationCursor.configure({
+      CollaborationCaret.configure({
         provider,
         user: {
           name: 'Cyndi Lauper',
diff --git a/demos/src/Extensions/CollaborationCaret/React/index.spec.js b/demos/src/Extensions/CollaborationCaret/React/index.spec.js
@@ -1,6 +1,6 @@
-context('/src/Extensions/CollaborationCursor/React', () => {
+context('/src/Extensions/CollaborationCaret/React', () => {
   beforeEach(() => {
-    cy.visit('/src/Extensions/CollaborationCursor/React/')
+    cy.visit('/src/Extensions/CollaborationCaret/React/')
   })
 
   it('should have a working tiptap instance', () => {
diff --git a/demos/src/Extensions/CollaborationCaret/React/styles.scss b/demos/src/Extensions/CollaborationCaret/React/styles.scss
@@ -18,7 +18,7 @@
   }
 
   /* Give a remote user a caret */
-  .collaboration-cursor__caret {
+  .collaboration-carets__caret {
     border-left: 1px solid #0d0d0d;
     border-right: 1px solid #0d0d0d;
     margin-left: -1px;
@@ -29,7 +29,7 @@
   }
 
   /* Render the username above the caret */
-  .collaboration-cursor__label {
+  .collaboration-carets__label {
     border-radius: 3px 3px 3px 0;
     color: #0d0d0d;
     font-size: 12px;
diff --git a/demos/src/Extensions/CollaborationCaret/Vue/index.html b/demos/src/Extensions/CollaborationCaret/Vue/index.html
diff --git a/demos/src/Extensions/CollaborationCaret/Vue/index.spec.js b/demos/src/Extensions/CollaborationCaret/Vue/index.spec.js
@@ -1,6 +1,6 @@
-context('/src/Extensions/CollaborationCursor/Vue', () => {
+context('/src/Extensions/CollaborationCaret/Vue', () => {
   beforeEach(() => {
-    cy.visit('/src/Extensions/CollaborationCursor/Vue/')
+    cy.visit('/src/Extensions/CollaborationCaret/Vue/')
   })
 
   it('should have a working tiptap instance', () => {
diff --git a/demos/src/Extensions/CollaborationCaret/Vue/index.vue b/demos/src/Extensions/CollaborationCaret/Vue/index.vue
@@ -4,7 +4,7 @@
 
 <script>
 import Collaboration from '@tiptap/extension-collaboration'
-import CollaborationCursor from '@tiptap/extension-collaboration-cursor'
+import CollaborationCaret from '@tiptap/extension-collaboration-caret'
 import Document from '@tiptap/extension-document'
 import Paragraph from '@tiptap/extension-paragraph'
 import Text from '@tiptap/extension-text'
@@ -28,7 +28,7 @@ export default {
   mounted() {
     const ydoc = new Y.Doc()
 
-    this.provider = new WebrtcProvider('tiptap-collaboration-cursor-extension', ydoc)
+    this.provider = new WebrtcProvider('tiptap-collaboration-caret-extension', ydoc)
 
     this.editor = new Editor({
       extensions: [
@@ -38,7 +38,7 @@ export default {
         Collaboration.configure({
           document: ydoc,
         }),
-        CollaborationCursor.configure({
+        CollaborationCaret.configure({
           provider: this.provider,
           user: {
             name: 'Cyndi Lauper',
@@ -80,7 +80,7 @@ export default {
   }
 
   /* Give a remote user a caret */
-  .collaboration-cursor__caret {
+  .collaboration-carets__caret {
     border-left: 1px solid #0d0d0d;
     border-right: 1px solid #0d0d0d;
     margin-left: -1px;
@@ -91,7 +91,7 @@ export default {
   }
 
   /* Render the username above the caret */
-  .collaboration-cursor__label {
+  .collaboration-carets__label {
     border-radius: 3px 3px 3px 0;
     color: #0d0d0d;
     font-size: 12px;
diff --git a/packages/extension-collaboration-caret/CHANGELOG.md b/packages/extension-collaboration-caret/CHANGELOG.md
diff --git a/packages/extension-collaboration-caret/README.md b/packages/extension-collaboration-caret/README.md
@@ -1,8 +1,8 @@
-# @tiptap/extension-collaboration-cursor
+# @tiptap/extension-collaboration-caret
 
-[![Version](https://img.shields.io/npm/v/@tiptap/extension-collaboration-cursor.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-collaboration-cursor)
-[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-collaboration-cursor.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
-[![License](https://img.shields.io/npm/l/@tiptap/extension-collaboration-cursor.svg)](https://www.npmjs.com/package/@tiptap/extension-collaboration-cursor)
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-collaboration-caret.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-collaboration-caret)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-collaboration-caret.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
+[![License](https://img.shields.io/npm/l/@tiptap/extension-collaboration-caret.svg)](https://www.npmjs.com/package/@tiptap/extension-collaboration-caret)
 [![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
 
 ## Introduction
diff --git a/packages/extension-collaboration-caret/package.json b/packages/extension-collaboration-caret/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "@tiptap/extension-collaboration-cursor",
-  "description": "collaboration cursor extension for tiptap",
+  "name": "@tiptap/extension-collaboration-caret",
+  "description": "collaboration caret extension for tiptap",
   "version": "3.0.0-next.6",
   "homepage": "https://tiptap.dev",
   "keywords": [
@@ -43,7 +43,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/ueberdosis/tiptap",
-    "directory": "packages/extension-collaboration-cursor"
+    "directory": "packages/extension-collaboration-caret"
   },
   "scripts": {
     "build": "tsup",
diff --git a/packages/extension-collaboration-caret/src/collaboration-caret.ts b/packages/extension-collaboration-caret/src/collaboration-caret.ts
diff --git a/packages/extension-collaboration-caret/src/index.ts b/packages/extension-collaboration-caret/src/index.ts
diff --git a/packages/extension-collaboration-caret/tsup.config.ts b/packages/extension-collaboration-caret/tsup.config.ts
diff --git a/packages/extension-collaboration-cursor/src/index.ts b/packages/extension-collaboration-cursor/src/index.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
