Skip to content
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

fix(vue-3): late-registering plugins #5616

Merged
merged 5 commits into from
Sep 18, 2024
Merged

fix(vue-3): late-registering plugins #5616

merged 5 commits into from
Sep 18, 2024

Conversation

svenadlung
Copy link
Contributor

@svenadlung svenadlung commented Sep 13, 2024

Changes Overview

It seems that y-prosemirror 1.2.4 or 1.2.5 breaks late registering plugins, specifically in Vue 3. This might be related to a point Kevin mentioned here.

The issue arises because this.view.updateState(state) doesn't immediately update this.view.state. This delay means the reconfigured state in registerPlugin() doesn't include newly registered plugins.

Implementation Approach

To address this, I've adjusted the code to use the state returned by this.state.reconfigure directly.

Testing Done

I tested the changes, added Vue and React demos of a collaboration setup in combination with bubble and floating menu, and added tests.

Verification Steps

Open the CollaborationWithMenus Vue demo and check if collaboration and menus are working properly.

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

Closes #5259

Copy link

changeset-bot bot commented Sep 13, 2024

🦋 Changeset detected

Latest commit: 6c28c1e

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

This PR includes changesets to release 54 packages
Name Type
@tiptap/vue-3 Patch
@tiptap/core Patch
@tiptap/extension-blockquote Patch
@tiptap/extension-bold Patch
@tiptap/extension-bubble-menu Patch
@tiptap/extension-bullet-list Patch
@tiptap/extension-character-count Patch
@tiptap/extension-code-block-lowlight Patch
@tiptap/extension-code-block Patch
@tiptap/extension-code Patch
@tiptap/extension-collaboration-cursor Patch
@tiptap/extension-collaboration Patch
@tiptap/extension-color Patch
@tiptap/extension-document Patch
@tiptap/extension-dropcursor Patch
@tiptap/extension-floating-menu Patch
@tiptap/extension-focus Patch
@tiptap/extension-font-family Patch
@tiptap/extension-gapcursor Patch
@tiptap/extension-hard-break Patch
@tiptap/extension-heading Patch
@tiptap/extension-highlight Patch
@tiptap/extension-history Patch
@tiptap/extension-horizontal-rule Patch
@tiptap/extension-image Patch
@tiptap/extension-italic Patch
@tiptap/extension-link Patch
@tiptap/extension-list-item Patch
@tiptap/extension-list-keymap Patch
@tiptap/extension-mention Patch
@tiptap/extension-ordered-list Patch
@tiptap/extension-paragraph Patch
@tiptap/extension-placeholder Patch
@tiptap/extension-strike Patch
@tiptap/extension-subscript Patch
@tiptap/extension-superscript Patch
@tiptap/extension-table-cell Patch
@tiptap/extension-table-header Patch
@tiptap/extension-table-row Patch
@tiptap/extension-table Patch
@tiptap/extension-task-item Patch
@tiptap/extension-task-list Patch
@tiptap/extension-text-align Patch
@tiptap/extension-text-style Patch
@tiptap/extension-text Patch
@tiptap/extension-typography Patch
@tiptap/extension-underline Patch
@tiptap/extension-youtube Patch
@tiptap/html Patch
@tiptap/pm Patch
@tiptap/react Patch
@tiptap/starter-kit Patch
@tiptap/suggestion Patch
@tiptap/vue-2 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

Copy link

netlify bot commented Sep 13, 2024

Deploy Preview for tiptap-embed ready!

Name Link
🔨 Latest commit 6c28c1e
🔍 Latest deploy log https://app.netlify.com/sites/tiptap-embed/deploys/66eac8a2a9609c0008b7eeac
😎 Deploy Preview https://deploy-preview-5616--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 site configuration.

@svenadlung svenadlung self-assigned this Sep 13, 2024
if (this.reactiveState) {
this.reactiveState.value = this.view.state
this.reactiveState.value = state
Copy link
Contributor

Choose a reason for hiding this comment

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

This is the only real difference from what it was doing before no? Why do we need to duplicate what the editor class is doing?

The same was done for the unregistering, so I'd like to understand better what the actual problem was

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are right. I’ve added more context to the PR's description. I'm using the reconfigured state directly since this.view.state is not updated at that point.

@svenadlung svenadlung marked this pull request as ready for review September 17, 2024 16:16
Copy link
Contributor

@nperez0111 nperez0111 left a comment

Choose a reason for hiding this comment

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

I refactored it a little to not have to expose the internals to the vue package

@nperez0111 nperez0111 merged commit cbe06d1 into develop Sep 18, 2024
14 checks passed
@nperez0111 nperez0111 deleted the fix/5259 branch September 18, 2024 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Bug]: Bubble Menu Not Working with Collaboration Extension
2 participants