Skip to content

Comments

docs(demos): replace tippy.js references with @floating-ui/dom (#7421)#7454

Open
jew2222 wants to merge 2 commits intoueberdosis:developfrom
jew2222:fix/issue-7421-referencing-tippy.js-as-a-requirement
Open

docs(demos): replace tippy.js references with @floating-ui/dom (#7421)#7454
jew2222 wants to merge 2 commits intoueberdosis:developfrom
jew2222:fix/issue-7421-referencing-tippy.js-as-a-requirement

Conversation

@jew2222
Copy link

@jew2222 jew2222 commented Jan 25, 2026

Changes Overview

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) for Emoji and Mention extensions with:

  • Clear dependency documentation
  • Migration notes from tippy.js to Floating UI
  • Required package installation instructions

Implementation Approach

Added JSDoc and HTML comments to demo source files to clarify the v3 migration from tippy.js to Floating UI. This approach:

  • Provides immediate clarity for developers referencing demo code
  • Requires no functional changes (comments only)
  • Maintains backward compatibility
  • Follows existing code documentation patterns

Files modified:

  • demos/src/Nodes/Emoji/React/index.jsx
  • demos/src/Nodes/Emoji/React/suggestion.js
  • demos/src/Nodes/Emoji/Vue/index.vue
  • demos/src/Nodes/Emoji/Vue/suggestion.js
  • demos/src/Nodes/Mention/React/index.jsx
  • demos/src/Nodes/Mention/React/suggestion.js
  • demos/src/Nodes/Mention/Vue/index.vue
  • demos/src/Nodes/Mention/Vue/suggestion.js

Testing Done

  • Verified all 8 demo files still function correctly
  • Confirmed no functional changes (comments only)
  • Tested that demos run without errors
  • Validated comment formatting follows project conventions

Verification Steps

  1. Navigate to any modified demo file
  2. Verify JSDoc/HTML comments are present at the top
  3. Confirm comments clearly state:
    • Tiptap v3 uses @floating-ui/dom
    • tippy.js is no longer used
    • Required dependencies are listed
  4. Run demos to ensure no functional changes

Additional 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:

  • Reference demo source code directly
  • Copy-paste demo implementations
  • Debug integration issues

This is a low-risk, high-value improvement that complements any future documentation website updates.

Checklist

  • I have created a changeset for this PR if necessary.
  • My changes do not break the library.
  • I have added tests where applicable.
  • I have followed the project guidelines.
  • I have fixed any lint issues.

Related Issues

Fixes #7421

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
Copilot AI review requested due to automatic review settings January 25, 2026 11:50
@changeset-bot
Copy link

changeset-bot bot commented Jan 25, 2026

🦋 Changeset detected

Latest commit: af64de1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 72 packages
Name Type
@tiptap/extension-emoji Patch
@tiptap/extension-mention Patch
@tiptap/core Patch
@tiptap/extension-audio Patch
@tiptap/extension-blockquote Patch
@tiptap/extension-bold Patch
@tiptap/extension-bubble-menu Patch
@tiptap/extension-bullet-list Patch
@tiptap/extension-code-block-lowlight Patch
@tiptap/extension-code-block Patch
@tiptap/extension-code Patch
@tiptap/extension-collaboration-caret Patch
@tiptap/extension-collaboration Patch
@tiptap/extension-color Patch
@tiptap/extension-details Patch
@tiptap/extension-document Patch
@tiptap/extension-drag-handle-react Patch
@tiptap/extension-drag-handle-vue-2 Patch
@tiptap/extension-drag-handle-vue-3 Patch
@tiptap/extension-drag-handle Patch
@tiptap/extension-file-handler Patch
@tiptap/extension-floating-menu Patch
@tiptap/extension-font-family Patch
@tiptap/extension-hard-break Patch
@tiptap/extension-heading Patch
@tiptap/extension-highlight Patch
@tiptap/extension-horizontal-rule Patch
@tiptap/extension-image Patch
@tiptap/extension-invisible-characters Patch
@tiptap/extension-italic Patch
@tiptap/extension-link Patch
@tiptap/extension-list Patch
@tiptap/extension-mathematics Patch
@tiptap/extension-node-range Patch
@tiptap/extension-ordered-list Patch
@tiptap/extension-paragraph Patch
@tiptap/extension-strike Patch
@tiptap/extension-subscript Patch
@tiptap/extension-superscript Patch
@tiptap/extension-table-of-contents Patch
@tiptap/extension-table Patch
@tiptap/extension-text-align Patch
@tiptap/extension-text-style Patch
@tiptap/extension-text Patch
@tiptap/extension-twitch Patch
@tiptap/extension-typography Patch
@tiptap/extension-underline Patch
@tiptap/extension-unique-id Patch
@tiptap/extension-youtube Patch
@tiptap/extensions Patch
@tiptap/html Patch
@tiptap/markdown Patch
@tiptap/pm Patch
@tiptap/react Patch
@tiptap/starter-kit Patch
@tiptap/static-renderer Patch
@tiptap/suggestion Patch
@tiptap/vue-2 Patch
@tiptap/vue-3 Patch
@tiptap/extension-character-count Patch
@tiptap/extension-dropcursor Patch
@tiptap/extension-focus Patch
@tiptap/extension-gapcursor Patch
@tiptap/extension-history Patch
@tiptap/extension-list-item Patch
@tiptap/extension-list-keymap Patch
@tiptap/extension-placeholder Patch
@tiptap/extension-table-cell Patch
@tiptap/extension-table-header Patch
@tiptap/extension-table-row Patch
@tiptap/extension-task-item Patch
@tiptap/extension-task-list Patch

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

@netlify
Copy link

netlify bot commented Jan 25, 2026

Deploy Preview for tiptap-embed ready!

Name Link
🔨 Latest commit af64de1
🔍 Latest deploy log https://app.netlify.com/projects/tiptap-embed/deploys/697603a4f34eaf000898d182
😎 Deploy Preview https://deploy-preview-7454--tiptap-embed.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

Copilot AI left a 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 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/dom instead of tippy.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.

Copy link
Contributor

@arnaugomez arnaugomez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation]: Still referencing tippy.js as a requirement

2 participants