fix: Adjust the splitBlock command to return false when it was unsuccessful

[mgreystone]

Changes Overview

Fix the splitBlock command so that it returns true when it successfully split a block & false when it does not. Allows for consumers to determine if the command was successful & act accordingly.

Implementation Approach

splitBlock already determined if a split was possible & saved those results to a can variable. This change returns the can variable, both when dispatch is defined & undefined.

Testing Done

I altered the CustomDocument example to only allow a single block by setting content: heading block. I then added a custom Enter keyboard shortcut to log if splitBlock returned false. Pushing the enter key anywhere in the document will now log "success".

Verification Steps

• Create a schema where splitting a block is impossible--for example, setting content: 'block' on a document. Call editor.commands.splitBlock() & ensure it returns false.
• Adjust the schema to allow for blocks to be split--for example, setting content: 'block+'. Ensure that editor.commands.splitBlock() now returns true.

Additional Notes

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: #5363

[changeset-bot]

🦋 Changeset detected

Latest commit: cc8541a

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

This PR includes changesets to release 54 packages

Name	Type
@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
@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

[netlify]

✅ Deploy Preview for tiptap-embed ready!

Name	Link
🔨 Latest commit	cc8541a
🔍 Latest deploy log	https://app.netlify.com/sites/tiptap-embed/deploys/669a83a232b03b0008150342
😎 Deploy Preview	https://deploy-preview-5371--tiptap-embed.netlify.app
📱 Preview on mobile	Toggle 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]

Sorry this is not correct, it should only ever manipulate the transaction if dispatch is true. This would break the behavior of commands being allowed to fail silently

[mgreystone]

Good call. This made me find another issue, where if the block cannot be split, the selection is erroneously deleted. So i've moved this to only occur when both dispatch and can are truthy.

Not sure why/if we'd want to ensureMarks or scrollIntoView if we cannot split the block, but that behavior was already present, & i don't see how it breaks anything?