Add EmptyBlocks plugin that prevents adding in exported data.
#17756
+274
−0
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
Mati365
changed the title
EmptyBlocks plugin that allows for preserving empty block elements in the editor.EmptyBlocks plugin that prevents adding in exported data.
niegowski
requested changes
Jan 16, 2025
Comment on lines
+19
to
+21
| * Empty elements are detected during upcast and marked with a special attribute. | ||
| * During downcast, elements with this attribute have their `getFillerOffset` set to `null` | ||
| * which prevents adding block fillers. |
There was a problem hiding this comment.
This describes the internals of the plugin. Docs should focus on plugin usage.
Comment on lines
+25
to
+27
| * * Preserve empty block elements exactly as they were in the source HTML | ||
| * * Allow for styling empty blocks with CSS (block fillers can interfere with height/margin) | ||
| * * Maintain compatibility with external systems that expect empty blocks to remain empty |
There was a problem hiding this comment.
Suggested change
| * * Preserve empty block elements exactly as they were in the source HTML | |
| * * Allow for styling empty blocks with CSS (block fillers can interfere with height/margin) | |
| * * Maintain compatibility with external systems that expect empty blocks to remain empty | |
| * * Preserve empty block elements exactly as they were in the source HTML. | |
| * * Allow for styling empty blocks with CSS (block fillers can interfere with height/margin). | |
| * * Maintain compatibility with external systems that expect empty blocks to remain empty. |
| const editor = this.editor; | ||
| const schema = editor.model.schema; | ||
|
|
||
| // Register the attribute for block elements |
There was a problem hiding this comment.
Suggested change
| // Register the attribute for block elements | |
| // Register the attribute for block elements. |
| allowAttributes: [ EMPTY_BLOCK_MODEL_ATTRIBUTE ] | ||
| } ); | ||
|
|
||
| // Upcast conversion - detect empty elements |
There was a problem hiding this comment.
Suggested change
| // Upcast conversion - detect empty elements | |
| // Upcast conversion - detect empty elements. |
| return; | ||
| } | ||
|
|
||
| const modelElement = modelRange?.start.nodeAfter as Element; |
There was a problem hiding this comment.
We do not yet support ?. operator.
Comment on lines
+67
to
+69
| schema.extend( '$block', { | ||
| allowAttributes: [ EMPTY_BLOCK_MODEL_ATTRIBUTE ] | ||
| } ); |
There was a problem hiding this comment.
Have you considered extending the $container? What about table cells? Those are not $block.
| }, { priority: 'lowest' } ); | ||
| } ); | ||
|
|
||
| // Data downcast conversion - prevent filler in empty elements |
There was a problem hiding this comment.
Suggested change
| // Data downcast conversion - prevent filler in empty elements | |
| // Data downcast conversion - prevent filler in empty elements. |
| } ); | ||
|
|
||
| // Data downcast conversion - prevent filler in empty elements | ||
| editor.conversion.for( 'dataDowncast' ).add( dispatcher => { |
There was a problem hiding this comment.
What about the editing downcast?
| if ( viewElement && data.attributeNewValue ) { | ||
| viewElement.getFillerOffset = () => null; | ||
| } | ||
| }, { priority: 'highest' } ); |
There was a problem hiding this comment.
Do we need this priority or maybe it could be the default?
| document.body.appendChild( element ); | ||
|
|
||
| editor = await ClassicTestEditor.create( element, { | ||
| plugins: [ Paragraph, EmptyBlocks ] |
There was a problem hiding this comment.
We would need more tests with more HTML element types, especially table cells. Missing tests for the editing pipeline.
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.
Suggested merge commit message (convention)
Feature (html-support): Add
EmptyBlocksplugin that prevents adding in exported data.Additional information
It's part of https://github.com/cksource/ckeditor5-commercial/pull/6942
Original issue https://github.com/cksource/ckeditor5-commercial/issues/6941
More details: Notion