docs(demos): replace tippy.js references with @floating-ui/dom (#7421)#7454
docs(demos): replace tippy.js references with @floating-ui/dom (#7421)#7454jew2222 wants to merge 2 commits intoueberdosis:developfrom
Conversation
Add comments to demo files explicitly stating that Tiptap v3 uses @floating-ui/dom instead of tippy.js for suggestion positioning. Updated 8 demo files (React/Vue) with: - Clear dependency documentation - Migration notes from tippy.js to Floating UI - Required package installation instructions Fixes ueberdosis#7421
🦋 Changeset detectedLatest commit: af64de1 The changes in this PR will be included in the next version bump. This PR includes changesets to release 72 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 project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR updates demo files to clarify the migration from tippy.js to @floating-ui/dom in Tiptap v3 by adding documentation comments.
Changes:
- Added JSDoc/HTML comments to 8 demo files (React and Vue) for Emoji and Mention extensions
- Comments clarify that Tiptap v3 uses
@floating-ui/dominstead oftippy.js - Included dependency installation instructions in comments
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| demos/src/Nodes/Mention/Vue/suggestion.js | Added JSDoc comment documenting the switch from tippy.js to @floating-ui/dom |
| demos/src/Nodes/Mention/Vue/index.vue | Added HTML comment listing dependencies and migration note |
| demos/src/Nodes/Mention/React/suggestion.js | Added JSDoc comment documenting the switch from tippy.js to @floating-ui/dom |
| demos/src/Nodes/Mention/React/index.jsx | Added JSDoc comment listing dependencies and migration note |
| demos/src/Nodes/Emoji/Vue/suggestion.js | Added JSDoc comment documenting the switch from tippy.js to @floating-ui/dom |
| demos/src/Nodes/Emoji/Vue/index.vue | Added HTML comment listing dependencies and migration note |
| demos/src/Nodes/Emoji/React/suggestion.js | Added JSDoc comment documenting the switch from tippy.js to @floating-ui/dom |
| demos/src/Nodes/Emoji/React/index.jsx | Added JSDoc comment listing dependencies and migration note |
| .changeset/fix-tippy-docs.md | Added changeset documenting the documentation improvements |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
arnaugomez
left a comment
There was a problem hiding this comment.
If I am not mistaken, demos typically do not have a documentation comment at the beginning of the file. If anything, these clarifications can be included in the docs, that's what my recommendation would be.
I'm not against adding comments but I think the information of these comments (like the dependencies) can be easily deduced from the imports at the beginning of the files. So I feel like they're a bit redundant.
Changes Overview
Add comments to demo files explicitly stating that Tiptap v3 uses
@floating-ui/dominstead oftippy.jsfor suggestion positioning.Updated 8 demo files (React/Vue) for Emoji and Mention extensions with:
Implementation Approach
Added JSDoc and HTML comments to demo source files to clarify the v3 migration from tippy.js to Floating UI. This approach:
Files modified:
demos/src/Nodes/Emoji/React/index.jsxdemos/src/Nodes/Emoji/React/suggestion.jsdemos/src/Nodes/Emoji/Vue/index.vuedemos/src/Nodes/Emoji/Vue/suggestion.jsdemos/src/Nodes/Mention/React/index.jsxdemos/src/Nodes/Mention/React/suggestion.jsdemos/src/Nodes/Mention/Vue/index.vuedemos/src/Nodes/Mention/Vue/suggestion.jsTesting Done
Verification Steps
@floating-ui/domtippy.jsis no longer usedAdditional Notes
Scope of this PR:
This PR addresses the demo source code in the main Tiptap repository. The documentation website (tiptap.dev) is maintained in a separate repository and may require additional updates.
Why this approach:
While the issue mentions the documentation website, improving demo code documentation provides immediate value to developers who:
This is a low-risk, high-value improvement that complements any future documentation website updates.
Checklist
Related Issues
Fixes #7421