feat(portable_text): expose block index to BlockContainerBuilder - #58
Open
Ortes wants to merge 1 commit into
Open
feat(portable_text): expose block index to BlockContainerBuilder#58Ortes wants to merge 1 commit into
Ortes wants to merge 1 commit into
Conversation
Thread the 0-based block index through buildBlock and the default 'block' builder into BlockContainerBuilder and BlockWidgetBuilder, so containers can vary by position — e.g. suppressing leading space on the first block. Breaking change: BlockContainerBuilder and BlockWidgetBuilder now take a trailing int index argument.
This file contains hidden or 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
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.
What
Threads the 0-based block index through
buildBlockand the defaultblockbuilder intoBlockContainerBuilderandBlockWidgetBuilder.Why
Block containers currently receive only
(context, child), so they have no way to know a block's position in the list. That makes position-dependent styling impossible — e.g. suppressing the leading space above the first heading while keeping it for headings in the middle of the content.With the index available, a container can do:
Changes
BlockContainerBuilder:Function(BuildContext, Widget)→Function(BuildContext, Widget, int index)BlockWidgetBuilder: adds a trailingint indexPortableTextConfig.buildBlock: takes and forwardsindexPortableTextBlock: newindexfield (defaults to0for standalone use), forwarded to the container builderdefaultListBuilderpasses theListView.builderindex throughdefaultBlockContainerBuilder,blockquote,block) updated to the new arityBreaking change
BlockContainerBuilderandBlockWidgetBuildernow take a trailingint indexargument. Existing custom builders need the extra parameter (ignore it if unused).All package tests pass;
dart analyzeis clean.