[Quill] - Make consecutive node merges configurable (Resolves #2510) #2511
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
…can, for example, merge block types that can have different properties (like a BannerAttribution with Orange vs with Green).
… of just the next one. This is necessary to, e.g., compare the color of two BannerAttributions.
|
@angelosilvestre I'm gonna merge in to cut a release. Feel free to review after. |
matthew-carroll
deleted the
2510_quill-configurable-block-merging-when-parsed
branch
|
|
||
| var shouldMerge = false; | ||
| for (final rule in blockMergeRules) { | ||
| final ruleShouldMerge = rule.shouldMerge(blockTypeToMerge, node.getMetadataValue(NodeMetadata.blockType)); |
There was a problem hiding this comment.
Just a small detail, we could cache node.getMetadataValue(NodeMetadata.blockType) in a variable outside of this for loop.
| abstract interface class DeltaBlockMergeRule { | ||
| /// Returns `true` if two consecutive blocks with the given types should merge, | ||
| /// `false` if they shouldn't, or `null` if this rule has no opinion about the merge. | ||
| bool? shouldMerge(Attribution block1, Attribution block2); |
There was a problem hiding this comment.
Using a nullable bool looks a bit weird to me, because when reading the code that uses this, it isn't immediately obvious. I would suggest to use an enum instead.
| ); | ||
| expect((document.getNodeAt(0)! as ParagraphNode).getMetadataValue("blockType"), blockquoteAttribution); | ||
| expect((document.getNodeAt(1)! as ParagraphNode).text.toPlainText(), ""); | ||
| expect(document.nodeCount, 2); |
There was a problem hiding this comment.
Shouldn't the node count expectation be placed before the other ones? If, for some reason, there is only one node in the document the test will fail in the line above.
| expect((document.getNodeAt(0)! as ParagraphNode).getMetadataValue("blockType"), blockquoteAttribution); | ||
| expect((document.getNodeAt(1)! as ParagraphNode).text.toPlainText(), ""); | ||
| expect((document.getNodeAt(2)! as ParagraphNode).getMetadataValue("blockType"), blockquoteAttribution); | ||
| expect(document.nodeCount, 4); |
| ); | ||
| expect((document.getNodeAt(0)! as ParagraphNode).getMetadataValue("blockType"), codeAttribution); | ||
| expect((document.getNodeAt(1)! as ParagraphNode).text.toPlainText(), ""); | ||
| expect(document.nodeCount, 2); |
| expect((document.getNodeAt(0)! as ParagraphNode).getMetadataValue("blockType"), codeAttribution); | ||
| expect((document.getNodeAt(1)! as ParagraphNode).text.toPlainText(), ""); | ||
| expect((document.getNodeAt(2)! as ParagraphNode).getMetadataValue("blockType"), codeAttribution); | ||
| expect(document.nodeCount, 4); |
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.
[Quill] - Make consecutive node merges configurable (Resolves #2510)
We previously hard-coded the merging of consecutive code blocks into a single block, which seemed to be the standard Quill editor behavior. The Quill editor didn't seem to merge any other blocks.
However, an app might want to merge any number of block types, including blockquotes. An app might also want to merge custom block types, which this package can't possibly know about. Therefore, this PR makes the merge decision configurable.