ToolbarButton: Deprecate isDisabled prop and merge with disabled
#63101
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
# Conflicts: # packages/components/src/toolbar/toolbar-button/index.tsx
mirka
added
[Type] Enhancement
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +6 B (0%) Total Size: 1.76 MB
ℹ️ View Unchanged
|
ciampo
approved these changes
Jul 3, 2024
| // TODO: Possible bug; maybe use onClick instead of props.onClick. | ||
| if ( props.onClick ) { | ||
| props.onClick( event ); | ||
| // TODO: Possible bug; maybe use onClick instead of restProps.onClick. |
There was a problem hiding this comment.
Unrelated, but what is this comment about? 🤔
There was a problem hiding this comment.
The onClick function written here will be overridden by the consumer's onClick function passed through with the restProps 🙃
Good catch 😳 I confirmed this also happens in trunk, but I think it will be normalized by #63102. |
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Jul 18, 2024
…ordPress#63101) * ToolbarButton: Deprecate `isDisabled` prop and merge with `disabled` # Conflicts: # packages/components/src/toolbar/toolbar-button/index.tsx * Migrate `isDisabled` usage in codebase * Add changelog Co-authored-by: mirka <[email protected]> Co-authored-by: ciampo <[email protected]>
lipemat
added a commit
to lipemat/types-js-boilerplate
that referenced
this pull request
Aug 21, 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.
Follow-up to #62306 (comment)
Fixes #63070
What?
Deprecates the
isDisabledprop onToolbarButtonand merges it intodisabled.Why?
ToolbarButton accepts both
isDisabledanddisabledprops to disable the button, and can result in slightly different behavior between the two, especially when wanting to achieve a focusable disabled button (see details in #63070).Current API usage in our codebase shows that most people reach for the
disabledprop. I could also find no meaningful significance for theisDisabledprop to be there (original PR where it was introduced).How?
Passive deprecate
isDisabledand alias it todisabled.Testing Instructions
Play around with the Storybook code for the
ToolbarButtons in theToolbarstory. PassingisDisabledshould result in the same behavior as passingdisabled, especially in combination with accessible disabled props like__experimentalIsFocusableoraccessibleWhenDisabled.