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

Prevent selection deletions at the end of list items from joining lists #5863

Merged
merged 2 commits into from
Nov 25, 2024

Conversation

glenn-allen
Copy link
Contributor

Changes Overview

  • Delete text, instead of joining lists, if the selection is:
    • At the end of the list item
    • Not collapsed
    • Within a single list item

Previously the text wasn't being deleted, but the following list item was being joined (see the testing videos within Verification Steps)

NOTE: The fix might be better suited to the isAtEndOfNode function from @tiptap/core - however because that's exposed it might result in unintended regressions out in the wild.

Implementation Approach

Traced the ListKeymap delete handlers and debugged guard statements that were trying to avoid the joinItemForward command.

Testing Done

All initial tests passed & performed manual testing of the http://localhost:3000/preview/Extensions/ListKeymap demo.

Verification Steps

Attempted a deletion of text, starting from the end of a node - then going backwards, before & after the change:

Before

List.keymap.before.mp4

After

List.keymap.after.mp4

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.

If starting a selection at the end of a list item, then pressing delete, the selected text wasn't being deleted, but instead the following list item was joined to the end.

Now the selected text will be deleted.

Joining will only occur if the selection spans multiple nodes or it's collapsed.
Copy link

changeset-bot bot commented Nov 25, 2024

🦋 Changeset detected

Latest commit: 8f7daae

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-list-keymap 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-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 Nov 25, 2024

Deploy Preview for tiptap-embed ready!

Name Link
🔨 Latest commit 8f7daae
🔍 Latest deploy log https://app.netlify.com/sites/tiptap-embed/deploys/6743c48817e7a60008892aae
😎 Deploy Preview https://deploy-preview-5863--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.

Fantastic contribution, thanks @glenn-allen!

@nperez0111 nperez0111 merged commit 86250c6 into ueberdosis:develop Nov 25, 2024
14 checks passed
@nperez0111 nperez0111 mentioned this pull request Nov 26, 2024
5 tasks
nperez0111 pushed a commit that referenced this pull request Nov 26, 2024
…s from joining lists (#5863)

If starting a selection at the end of a list item, then pressing delete, the selected text wasn't being deleted, but instead the following list item was joined to the end.

Now the selected text will be deleted.

Joining will only occur if the selection spans multiple nodes or it's collapsed.
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