Fix for #5490 - Adds preventClearDocument meta + makes it easier to disable specific core plugins.
#5514
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: c8a8fa7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 54 packages
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 |
✅ Deploy Preview for tiptap-embed ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
nperez0111
reviewed
Aug 17, 2024
packages/core/src/types.ts
Outdated
| * Extensions not listed in the object will still be enabled. | ||
| * @default true | ||
| */ | ||
| enableCoreExtensions: boolean | Record<'editable' | 'clipboardTextSerializer' | 'commands' | 'focusEvents' | 'keymap' | 'tabindex', any>; |
There was a problem hiding this comment.
Suggested change
| enableCoreExtensions: boolean | Record<'editable' | 'clipboardTextSerializer' | 'commands' | 'focusEvents' | 'keymap' | 'tabindex', any>; | |
| enableCoreExtensions: boolean | Record<'editable' | 'clipboardTextSerializer' | 'commands' | 'focusEvents' | 'keymap' | 'tabindex', false>; |
Since false is the only valid option
There was a problem hiding this comment.
Oops, meant to put boolean, but yeah, I guess false makes more sense.
nperez0111
reviewed
Aug 17, 2024
packages/core/src/types.ts
Outdated
Comment on lines
82
to
98
| /** | ||
| * If `false`, the core extensions will not be loaded. | ||
| * You can pass an object to disable specific extensions (e.g. `{ keymap: false }`). | ||
| * Extensions not listed in the object will still be enabled. | ||
| * @default true | ||
| */ |
There was a problem hiding this comment.
Suggested change
| /** | |
| * If `false`, the core extensions will not be loaded. | |
| * You can pass an object to disable specific extensions (e.g. `{ keymap: false }`). | |
| * Extensions not listed in the object will still be enabled. | |
| * @default true | |
| */ | |
| /** | |
| * Determines whether core extensions are enabled. | |
| * | |
| * If set to `false`, all core extensions will be disabled. | |
| * To disable specific core extensions, provide an object where the keys are the extension names and the values are `false`. | |
| * Extensions not listed in the object will remain enabled. | |
| * | |
| * @example | |
| * // Disable all core extensions | |
| * enabledCoreExtensions: false | |
| * | |
| * @example | |
| * // Disable only the keymap core extension | |
| * enabledCoreExtensions: { keymap: false } | |
| * | |
| * @default true | |
| */ |
|
Incorporated both suggested changes. |
nperez0111
approved these changes
Aug 20, 2024
|
Um, I just realized there is a slight bug with the types... The record should be a partial record. Should I open a new PR? |
|
Ah right, good catch. I'll fix it |
nperez0111
added a commit
that referenced
this pull request
Aug 21, 2024
|
👍 Thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes Overview
preventClearDocumentto the clearDocument plugin to fix the main issue in [Bug]: The "clearDocument" plugin in the core keymap extension can cause issues with custom node change commands. #5490.enableCoreExtensionsto be an object disabling certain core extensions.Implementation Approach
Regarding the disabling of core extensions, @nperez0111, you suggested using
coreExtensionOptions, but I thought this made a bit more sense. It's only a bit weird in that passing something likeenableCoreExtensions: { keymap: true }still enables everything. Only passingfalsewill disable an extension (leaving others enabled). But I think that would be the most common use case.Otherwise what sort of interface did you have in mind?
Testing Done
I'm having a bit of issues running cypress locally. But I see the PRs have github actions.
I also tested it with my app to see everything was getting properly ignore/disabled.
Verification Steps
preventClearDocumenton the transaction. My reproduction in [Bug]: The "clearDocument" plugin in the core keymap extension can cause issues with custom node change commands. #5490 shows the issue clearly.Checklist
Am awaiting the github actions results, but otherwise no.