chore(web-components): add hasMatchingState and swapStates functions #33156
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
marchbox
reviewed
Oct 28, 2024
radium-v
force-pushed
the
users/radium-v/wc-guard-states
branch
from
321b1f4
to
09feacb
Compare
📊 Bundle size report✅ No changes found |
fabricteam
reviewed
Oct 29, 2024
change/@fluentui-web-components-7bba75e2-576b-4e9f-821b-9501f016a3a6.json
Show resolved
Hide resolved
marchbox
approved these changes
Oct 29, 2024
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.
Previous Behavior
For each instance where we're toggling between two states, we remove the previous state if it exists, and then apply the new state if it exists.
There are no checks to see if the new state getting checked is an allowed state for the attribute. This allows for arbitrary states to be applied, which can lead to unexpected behavior. For instance, an
appearanceattribute could be set to any value, and that value would be applied toElementInternals.states.It could also lead to state collisions, where setting something like
appearance="large"would simultaneously be invalid ("large" is not a valid state forappearance), and would apply thelargestate to theElementInternals.statesset (largeis a valid state for thesizeattribute, but thesizeattribute isn't set tolarge.)New Behavior
This PR adds the
hasMatchingStatefunction, which can be used to determine if a given string state is valid and accepted for a given state object.This PR also adds the
swapStatesfunction, which can be used to swap between two states. This is a really common pattern in our codebase, and this function will make it easier to remove the old state, and apply the new state, while also ensuring that the new state is accepted for that attribute.