-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rename CollaborationCursor extension to CollaborationCaret #6173
Conversation
🦋 Changeset detectedLatest commit: c13172f The changes in this PR will be included in the next version bump. This PR includes changesets to release 59 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for tiptap-embed ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR renames the CollaborationCursor extension to CollaborationCaret to improve clarity regarding its functionality.
- Updated changesets to reflect the new package name.
- Renamed import paths, test paths, and associated UI usage in both React and Vue demos.
- Adjusted CSS class names in Vue demos to match the new extension name.
Reviewed Changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
.changeset/many-laws-vanish.md | Updated changeset file to list the new extension name. |
demos/src/Extensions/CollaborationCaret/React/index.spec.js | Updated React test paths from CollaborationCursor to CollaborationCaret. |
demos/src/Extensions/CollaborationCaret/Vue/index.spec.js | Updated Vue test paths from CollaborationCursor to CollaborationCaret. |
.changeset/eighty-gifts-matter.md | Reflects the new extension name in the changeset. |
demos/src/Demos/SingleRoomCollab/React/index.jsx | Updated import and runtime references from CollaborationCursor to CollaborationCaret. |
.changeset/chilled-trees-agree.md | Updated changeset file for new naming. |
demos/src/Examples/CollaborativeEditing/React/index.jsx | Updated import and runtime references from CollaborationCursor to CollaborationCaret. |
.changeset/cuddly-impalas-heal.md | Updated changeset file for the renamed extension. |
demos/src/Demos/CollaborationSplitPane/React/Editor.jsx | Updated import and runtime references for the renamed extension. |
demos/src/Extensions/CollaborationCaret/React/index.jsx | Updated React component usage and provider naming. |
demos/src/Extensions/CollaborationCaret/Vue/index.vue | Updated Vue component usage and CSS class names for the renamed extension. |
demos/src/Examples/CollaborativeEditing/Vue/index.vue | Updated Vue example usage including CSS class updates. |
Comments suppressed due to low confidence (2)
.changeset/many-laws-vanish.md:5
- Consider updating the explanation text by replacing 'cursor' with 'caret' for consistency with the new naming.
+Renamed `@tiptap/extension-collaboration-cursor` to `@tiptap/extension-collaboration-caret` to clarify what kind of cursor this extension is implementing.
demos/src/Extensions/CollaborationCaret/Vue/index.vue:94
- [nitpick] The CSS class name 'collaboration-carets__label' uses a plural form that may be inconsistent with the singular 'CollaborationCaret'. Consider aligning the CSS naming convention with the new extension name.
+ .collaboration-carets__label {
Changes Overview
This PR renames the
collaboration-cursor
extension tocollaboration-caret
to clarify what kind of cursors this extension is implementing.Implementation Approach
I renamed all occurrences of the CollaborationCursor extensions, updated imports, builds and demos.
Testing Done
I tested my changes locally in our demos and ran tests locally to make sure this is not breaking anything.
Verification Steps
See above
Additional Notes
This PR is a breaking change for 3.0.0
Checklist