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

Add element to shouldShow in BubbleMenuPlugin #5790

Merged
merged 2 commits into from
Nov 4, 2024

Conversation

alanpoulain
Copy link
Contributor

Changes Overview

The internal implementation of shouldShow is using this.element.
The user cannot reuse the internal implementation and add some logic, because the element parameter is missing.

Implementation Approach

Add the element parameter to shouldShow.

Testing Done

Not really tested.

Verification Steps

Implements your own shouldShow:

import { isTextSelection } from "@tiptap/core";
import { BubbleMenuPluginProps } from "@tiptap/extension-bubble-menu";

export const bubbleMenuShouldShow: Exclude<BubbleMenuPluginProps["shouldShow"], null> =
  ({ editor, element, view, state, from, to }) => {
  const { doc, selection } = state;
  const { empty } = selection;

  const isEmptyTextBlock = !doc.textBetween(from, to).length && isTextSelection(state.selection);

  const isChildOfMenu = element.contains(document.activeElement);

  const hasEditorFocus = view.hasFocus() || isChildOfMenu;

  return hasEditorFocus && !empty && !isEmptyTextBlock && editor.isEditable;
};

Additional Notes

N/A

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

N/A

Copy link

changeset-bot bot commented Oct 30, 2024

🦋 Changeset detected

Latest commit: 36b1e80

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

This PR includes changesets to release 54 packages
Name Type
@tiptap/extension-bubble-menu Patch
@tiptap/core Patch
@tiptap/extension-blockquote Patch
@tiptap/extension-bold 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
@tiptap/vue-3 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 Oct 30, 2024

Deploy Preview for tiptap-embed ready!

Name Link
🔨 Latest commit 36b1e80
🔍 Latest deploy log https://app.netlify.com/sites/tiptap-embed/deploys/67289eb9f6aa74000817bb95
😎 Deploy Preview https://deploy-preview-5790--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.

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.

Makes sense to me

@nperez0111 nperez0111 merged commit 830e683 into ueberdosis:develop Nov 4, 2024
12 of 13 checks passed
@alanpoulain alanpoulain deleted the patch-1 branch November 4, 2024 10:24
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.

2 participants