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 emptyTextBlock detection to handle leaf nodes too #5838

Merged
merged 3 commits into from
Nov 30, 2024
Merged

Conversation

bdbch
Copy link
Member

@bdbch bdbch commented Nov 17, 2024

Changes Overview

This pull request includes a small but significant change to the FloatingMenuView class in the packages/extension-floating-menu/src/floating-menu-plugin.ts file. The change ensures that the isEmptyTextBlock condition also checks if the parent node has no children (childCount === 0).

This fixes a bug (see #4327) causing leaf nodes not to be counted as content of a node. It also deprecates the PR #4444

Changes in FloatingMenuView:

  • Updated the isEmptyTextBlock condition to include a check for childCount === 0 to ensure the block is truly empty.

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

Copy link

changeset-bot bot commented Nov 17, 2024

🦋 Changeset detected

Latest commit: dce2bf0

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-floating-menu 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-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

@bdbch bdbch self-assigned this Nov 17, 2024
Copy link

netlify bot commented Nov 17, 2024

Deploy Preview for tiptap-embed ready!

Name Link
🔨 Latest commit dce2bf0
🔍 Latest deploy log https://app.netlify.com/sites/tiptap-embed/deploys/674b0c60ae812f0008e51da3
😎 Deploy Preview https://deploy-preview-5838--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.

@nperez0111
Copy link
Contributor

I wonder if this fix is still valid #4444

@nperez0111
Copy link
Contributor

Your check is similar, but I think that one covers more cases (like a node specifying a way to render to text)

@bdbch
Copy link
Member Author

bdbch commented Nov 17, 2024

Do we need to be that specific in that case though? I thought about it and I couldn't find a reason why a node should be considered empty even when it has any child nodes. Do you have any thing in mind that would cause a node to have child content but still should be considered empty for the floating menu?

@nperez0111
Copy link
Contributor

nperez0111 commented Nov 18, 2024

Do we need to be that specific in that case though? I thought about it and I couldn't find a reason why a node should be considered empty even when it has any child nodes. Do you have any thing in mind that would cause a node to have child content but still should be considered empty for the floating menu?

I think you understood me in reverse, if a node is something that can serialize to text (e.g. a mention), which has no child nodes, then to the floating menu it will be considered empy.

I did this in the current version to show what I mean (which obviously should not happen). Note: this happened after completing the mention and backspacing once to remove the added space character.
image
The reason that it does happen is that the mention node does serialize to text but is actually considered empty by these checks. What the other fix did was compare this to a serialized to text version of the mention node which should fix this.

You can apply this diff in your project to see if your fix addresses this too, but I'm pretty sure the other fix addresses this:

diff --git a/demos/src/Nodes/Mention/React/index.jsx b/demos/src/Nodes/Mention/React/index.jsx
index 8d40a8d4d..ef78a95b6 100644
--- a/demos/src/Nodes/Mention/React/index.jsx
+++ b/demos/src/Nodes/Mention/React/index.jsx
@@ -4,7 +4,7 @@ import Document from '@tiptap/extension-document'
 import Mention from '@tiptap/extension-mention'
 import Paragraph from '@tiptap/extension-paragraph'
 import Text from '@tiptap/extension-text'
-import { EditorContent, useEditor } from '@tiptap/react'
+import { EditorContent, FloatingMenu, useEditor } from '@tiptap/react'
 import React from 'react'
 
 import suggestion from './suggestion.js'
@@ -35,5 +35,28 @@ export default () => {
     return null
   }
 
-  return <EditorContent editor={editor} />
+  return <div>
+  {editor && <FloatingMenu editor={editor} tippyOptions={{ duration: 100 }}>
+    <div className="floating-menu">
+      <button
+        onClick={() => editor.chain().focus().toggleHeading({ level: 1 }).run()}
+        className={editor.isActive('heading', { level: 1 }) ? 'is-active' : ''}
+      >
+        H1
+      </button>
+      <button
+        onClick={() => editor.chain().focus().toggleHeading({ level: 2 }).run()}
+        className={editor.isActive('heading', { level: 2 }) ? 'is-active' : ''}
+      >
+        H2
+      </button>
+      <button
+        onClick={() => editor.chain().focus().toggleBulletList().run()}
+        className={editor.isActive('bulletList') ? 'is-active' : ''}
+      >
+        Bullet list
+      </button>
+    </div>
+  </FloatingMenu>}
+  <EditorContent editor={editor} /></div>
 }

@bdbch
Copy link
Member Author

bdbch commented Nov 18, 2024

No worries, sometimes I may sound a bit to annoyed/harsh but I was just curious about the differences.

I'll try your diff and report back. Pretty sure this should also work as the mention will still be counted as a child node of the paragraph parent increasing the childCount to 1.

I'm also fine parsing the text content via the node schema if needed.

@nperez0111
Copy link
Contributor

If yours works, then I'd go with the simpler one which is yours

Copy link

pkg-pr-new bot commented Nov 30, 2024

Open in Stackblitz

@tiptap/core

npm i https://pkg.pr.new/@tiptap/core@5838

@tiptap/extension-bold

npm i https://pkg.pr.new/@tiptap/extension-bold@5838

@tiptap/extension-blockquote

npm i https://pkg.pr.new/@tiptap/extension-blockquote@5838

@tiptap/extension-bubble-menu

npm i https://pkg.pr.new/@tiptap/extension-bubble-menu@5838

@tiptap/extension-character-count

npm i https://pkg.pr.new/@tiptap/extension-character-count@5838

@tiptap/extension-bullet-list

npm i https://pkg.pr.new/@tiptap/extension-bullet-list@5838

@tiptap/extension-code

npm i https://pkg.pr.new/@tiptap/extension-code@5838

@tiptap/extension-code-block

npm i https://pkg.pr.new/@tiptap/extension-code-block@5838

@tiptap/extension-code-block-lowlight

npm i https://pkg.pr.new/@tiptap/extension-code-block-lowlight@5838

@tiptap/extension-collaboration

npm i https://pkg.pr.new/@tiptap/extension-collaboration@5838

@tiptap/extension-collaboration-cursor

npm i https://pkg.pr.new/@tiptap/extension-collaboration-cursor@5838

@tiptap/extension-color

npm i https://pkg.pr.new/@tiptap/extension-color@5838

@tiptap/extension-document

npm i https://pkg.pr.new/@tiptap/extension-document@5838

@tiptap/extension-dropcursor

npm i https://pkg.pr.new/@tiptap/extension-dropcursor@5838

@tiptap/extension-floating-menu

npm i https://pkg.pr.new/@tiptap/extension-floating-menu@5838

@tiptap/extension-focus

npm i https://pkg.pr.new/@tiptap/extension-focus@5838

@tiptap/extension-font-family

npm i https://pkg.pr.new/@tiptap/extension-font-family@5838

@tiptap/extension-gapcursor

npm i https://pkg.pr.new/@tiptap/extension-gapcursor@5838

@tiptap/extension-hard-break

npm i https://pkg.pr.new/@tiptap/extension-hard-break@5838

@tiptap/extension-heading

npm i https://pkg.pr.new/@tiptap/extension-heading@5838

@tiptap/extension-highlight

npm i https://pkg.pr.new/@tiptap/extension-highlight@5838

@tiptap/extension-history

npm i https://pkg.pr.new/@tiptap/extension-history@5838

@tiptap/extension-horizontal-rule

npm i https://pkg.pr.new/@tiptap/extension-horizontal-rule@5838

@tiptap/extension-image

npm i https://pkg.pr.new/@tiptap/extension-image@5838

@tiptap/extension-italic

npm i https://pkg.pr.new/@tiptap/extension-italic@5838

@tiptap/extension-link

npm i https://pkg.pr.new/@tiptap/extension-link@5838

@tiptap/extension-list-item

npm i https://pkg.pr.new/@tiptap/extension-list-item@5838

@tiptap/extension-list-keymap

npm i https://pkg.pr.new/@tiptap/extension-list-keymap@5838

@tiptap/extension-mention

npm i https://pkg.pr.new/@tiptap/extension-mention@5838

@tiptap/extension-ordered-list

npm i https://pkg.pr.new/@tiptap/extension-ordered-list@5838

@tiptap/extension-paragraph

npm i https://pkg.pr.new/@tiptap/extension-paragraph@5838

@tiptap/extension-placeholder

npm i https://pkg.pr.new/@tiptap/extension-placeholder@5838

@tiptap/extension-strike

npm i https://pkg.pr.new/@tiptap/extension-strike@5838

@tiptap/extension-subscript

npm i https://pkg.pr.new/@tiptap/extension-subscript@5838

@tiptap/extension-superscript

npm i https://pkg.pr.new/@tiptap/extension-superscript@5838

@tiptap/extension-table

npm i https://pkg.pr.new/@tiptap/extension-table@5838

@tiptap/extension-table-cell

npm i https://pkg.pr.new/@tiptap/extension-table-cell@5838

@tiptap/extension-table-header

npm i https://pkg.pr.new/@tiptap/extension-table-header@5838

@tiptap/extension-table-row

npm i https://pkg.pr.new/@tiptap/extension-table-row@5838

@tiptap/extension-task-item

npm i https://pkg.pr.new/@tiptap/extension-task-item@5838

@tiptap/extension-task-list

npm i https://pkg.pr.new/@tiptap/extension-task-list@5838

@tiptap/extension-text-align

npm i https://pkg.pr.new/@tiptap/extension-text-align@5838

@tiptap/extension-text

npm i https://pkg.pr.new/@tiptap/extension-text@5838

@tiptap/extension-text-style

npm i https://pkg.pr.new/@tiptap/extension-text-style@5838

@tiptap/extension-typography

npm i https://pkg.pr.new/@tiptap/extension-typography@5838

@tiptap/extension-underline

npm i https://pkg.pr.new/@tiptap/extension-underline@5838

@tiptap/extension-youtube

npm i https://pkg.pr.new/@tiptap/extension-youtube@5838

@tiptap/html

npm i https://pkg.pr.new/@tiptap/html@5838

@tiptap/react

npm i https://pkg.pr.new/@tiptap/react@5838

@tiptap/pm

npm i https://pkg.pr.new/@tiptap/pm@5838

@tiptap/starter-kit

npm i https://pkg.pr.new/@tiptap/starter-kit@5838

@tiptap/suggestion

npm i https://pkg.pr.new/@tiptap/suggestion@5838

@tiptap/vue-2

npm i https://pkg.pr.new/@tiptap/vue-2@5838

@tiptap/vue-3

npm i https://pkg.pr.new/@tiptap/vue-3@5838

commit: dce2bf0

@bdbch bdbch mentioned this pull request Nov 30, 2024
4 tasks
@bdbch bdbch merged commit d9b6ef5 into develop Nov 30, 2024
15 checks passed
@bdbch bdbch deleted the bdbch/fix-4327 branch November 30, 2024 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants