Refactor Button component. #10824
Open
Refactor Button component. #10824
+418
−87
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
|
Build files for d06317f are ready:
|
|
Size Change: +3.55 kB (+0.17%) Total Size: 2.13 MB ℹ️ View Unchanged
|
nfmohit
requested changes
Jun 5, 2025
assets/js/googlesitekit/components-gm2/Button/MaybeTooltip.test.js
Outdated
Show resolved
Hide resolved
assets/js/googlesitekit/components-gm2/Button/SemanticButton.test.js
Outdated
Show resolved
Hide resolved
assets/js/googlesitekit/components-gm2/Button/SemanticButton.test.js
Outdated
Show resolved
Hide resolved
|
Thank you @nfmohit for reviewing the PR and adding your valuable suggestions. I've addressed the feedback and sending it your way to review those. Thanks again! |
nfmohit
requested changes
Jun 11, 2025
Comment on lines
66
to
72
| MaybeTooltip.defaultProps = { | ||
| disabled: false, | ||
| tooltip: false, | ||
| tooltipTitle: null, | ||
| hasIconOnly: false, | ||
| tooltipEnterDelayInMS: 100, | ||
| }; |
There was a problem hiding this comment.
Let's use default parameters in the exported function, as defaultProps on functional components will eventually be deprecated (see RFC).
With that said, as we're already refactoring, we should apply this refactor to the parent component too, if capacity permits, thank you!
| } | ||
| ); | ||
|
|
||
| SemanticButton.displayName = 'SemanticButton'; |
There was a problem hiding this comment.
Sorry for not flagging this earlier, but I don't think the displayName property is necessary here, as it should ideally only be used when the component should be labelled differently than the exported function.
This should also be removed from the parent component, IMO.
Comment on lines
81
to
101
| SemanticButton.propTypes = { | ||
| children: PropTypes.node, | ||
| href: PropTypes.string, | ||
| text: PropTypes.bool, | ||
| className: PropTypes.string, | ||
| danger: PropTypes.bool, | ||
| disabled: PropTypes.bool, | ||
| target: PropTypes.string, | ||
| icon: PropTypes.element, | ||
| trailingIcon: PropTypes.element, | ||
| 'aria-label': PropTypes.string, | ||
| inverse: PropTypes.bool, | ||
| tertiary: PropTypes.bool, | ||
| callout: PropTypes.bool, | ||
| calloutStyle: PropTypes.oneOf( [ 'primary', 'warning', 'error' ] ), | ||
| title: PropTypes.string, | ||
| customizedTooltip: PropTypes.element, | ||
| tooltip: PropTypes.bool, | ||
| hideTooltipTitle: PropTypes.bool, | ||
| tooltipEnterDelayInMS: PropTypes.number, | ||
| }; |
There was a problem hiding this comment.
I don't think icon, trailingIcon, title, customizedTooltip, tooltip, hideTooltipTitle, and tooltipEnterDelayInMS are valid props for this component.
Suggested change
| SemanticButton.propTypes = { | |
| children: PropTypes.node, | |
| href: PropTypes.string, | |
| text: PropTypes.bool, | |
| className: PropTypes.string, | |
| danger: PropTypes.bool, | |
| disabled: PropTypes.bool, | |
| target: PropTypes.string, | |
| icon: PropTypes.element, | |
| trailingIcon: PropTypes.element, | |
| 'aria-label': PropTypes.string, | |
| inverse: PropTypes.bool, | |
| tertiary: PropTypes.bool, | |
| callout: PropTypes.bool, | |
| calloutStyle: PropTypes.oneOf( [ 'primary', 'warning', 'error' ] ), | |
| title: PropTypes.string, | |
| customizedTooltip: PropTypes.element, | |
| tooltip: PropTypes.bool, | |
| hideTooltipTitle: PropTypes.bool, | |
| tooltipEnterDelayInMS: PropTypes.number, | |
| }; | |
| SemanticButton.propTypes = { | |
| children: PropTypes.node, | |
| href: PropTypes.string, | |
| text: PropTypes.bool, | |
| className: PropTypes.string, | |
| danger: PropTypes.bool, | |
| disabled: PropTypes.bool, | |
| target: PropTypes.string, | |
| 'aria-label': PropTypes.string, | |
| inverse: PropTypes.bool, | |
| tertiary: PropTypes.bool, | |
| callout: PropTypes.bool, | |
| calloutStyle: PropTypes.oneOf( [ 'primary', 'warning', 'error' ] ), | |
| }; |
|
Thanks @nfmohit, I have made the changes suggested above. Assigning this to you for another review. |
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.
Summary
Addresses issue:
assets/js/googlesitekit/components-gm2/Button.js#10357Relevant technical choices
PR Author Checklist
Do not alter or remove anything below. The following sections will be managed by moderators only.
Code Reviewer Checklist
Merge Reviewer Checklist