fix: retain child state through insertions and reorders#361
Open
mayakwd wants to merge 1 commit into
Open
Conversation
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.
Context
I'm working on a library for simple UI animations (crossfades, smooth scrolling, animations for UI elements appearing and disappearing, and so on). In the process, I've found a few bugs in the current implementation of the diff between the old and new widget states.
Problem
Tree::childrenstores the state of the widgets, and in each pass (layout,draw, etc), it pairs the new and old child states based on index. So, reconciliation must assign each surviving child's state to its new index.Tree::diff_children_custombreaks this contract, which can cause several issues:self.childrenends up one shorter than the widget list, so the last widget renders with no state.truncatedrops the named child from the tail before it is ever matched by name, so its state doesn't survive and resets as a result.Summing up: the surviving widget state, such as scroll offset, text cursor, selection, focus, and in-flight animation, lands on the wrong child or resets whenever a sibling is inserted, removed, or reordered.
Fix
Take the old subtrees and split them into named and positional buckets. Rebuild them, matching the following rules:
What I've tested