Update Button props to ensure they correctly type check
#2445
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: cc79c6c 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 |
size-limit report 📦
|
mattcosta7
changed the title
Button props to ensure they correctly type check
mattcosta7
commented
Oct 17, 2022
mattcosta7
commented
Oct 17, 2022
mattcosta7
commented
Oct 17, 2022
mattcosta7
commented
Oct 17, 2022
mattcosta7
commented
Oct 17, 2022
mattcosta7
commented
Oct 17, 2022
|
Not sure why canary release seems to fail |
|
I tested the canary build on memex - https://github.com/github/memex/pull/12803 button now properly catches a bunch of type errors that were introduced in that codebase, without any false positives. Feeling pretty confident here |
jclem
reviewed
Oct 20, 2022
jclem
approved these changes
Oct 25, 2022
joshblack
approved these changes
Oct 25, 2022
Merged
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.
Describe your changes here.
Discussed separately in slack
types for Button were being broadened signficantly because the generic interface exposed by the polymorphic component could not be adequately described by the base
forwardRefimplementation. Using the PolymorphicForwardRefComponent helper, allows the type fidelity to be maintained.I've added a type test to validate a few simple cases, and updated places where the types were incorrect in the codebase (now easily noted as failures to build)
One thing to consider - this might be a breaking change for consumers, even though the api should have been this way already
fixes #1956
Screenshots
Please provide before/after screenshots for any visual changes
Merge checklist
Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.