Add deprecated isReversed prop to Button #5325
Merged
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
🦋 Changeset detectedLatest commit: 9e48c68 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
3ff6d0e to
4ae4a0f
Compare
dougmacknz
previously approved these changes
Nov 29, 2024
HeartSquared
previously approved these changes
Dec 1, 2024
Co-authored-by: Cassandra <cassandra.tam@cultureamp.com>
36845b9
HeartSquared
approved these changes
Dec 2, 2024
Zystix
pushed a commit
that referenced
this pull request
Dec 4, 2024
* add deprecated isReversed props to Button * update type description and how reversed variant is set * Update packages/components/src/__actions__/Button/v3/Button.tsx Co-authored-by: Cassandra <cassandra.tam@cultureamp.com> --------- Co-authored-by: Cassandra <cassandra.tam@cultureamp.com>
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.
Why
The current method to set reversed styles on Button v3 is to use the
ReverseColorsprovider that we export from"@kaizen/components/v3/utilities".This presents a risk for the codemod, as each instance of Button that was reversed would likely need to be wrapped in a Provider, whereas the intent behind
ReverseColorsis to wrap a parent element to reduce the number of props needed to style reversed color themes.As we can’t predictably say how this could impact renders or their performance we think a safer methods of gradual migration is to add a deprecated
isReversedprop. This will allow the codemod to run safely and provide type warning to our consumers which is a clearer way to describe the new pattern.What
isReversedprop and JSdoc deprecated flag to Button v3