Introduce State v2 #88
Draft
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
Instead of relying on V1 State extending a V2 interface. This is primarily so we can test V2 within Essential without having to lock in its entire API (meaning we can't yet add any interface implementations to existing API classes).
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.
Most significant changes compared to v1:
Stateis now an interface instead of an abstract classMutableStateis a separate interface and implementations are generally expected to forwardsetto their source states (whereas before, asetwould only ever affect the state it was called on, and would frequently get overwritten if one of its input states changed)WeakReference) by default, this allows a child component to transparently use the state of its parent without potentially leaking the child component memoryrebinding (and no longer return special types; they are much simpler in general now), instead there's a dedicatedDelegatingStatewhich can be wrapped around an input where rebinding is requiredStatedirectly)derivedStatebuilder function to create a state which is derived from any number of other states (all the combinators are based on this)This new API should be fully compatible and be able to coexist with the legacy State API:
To use a v2 API with v1 states, the old
Stateclass extends the newMutableState, so people still using the old API can transparently use functionality designed for the new API.To use a v1 API with v2 states, a old
Stateinstance can be created from a newStatewith theState.toV1()extension function.As an example, the
MarkdownComponentand thePixelConstrainthave been converted to use/support the new v2 API for their existing functionality.