Make ToolbarButton API consistent #22961
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
diegohaz
requested review from
ajitbohra,
chrisvanpatten and
youknowriad
as code owners
diegohaz
added
[Package] Components
|
Size Change: +1 B Total Size: 1.12 MB
ℹ️ View Unchanged
|
gziolo
approved these changes
Jun 6, 2020
youknowriad
added
the
[Type] Code Quality
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.
Currently,
ToolbarButtonaccepts different props depending on the context in which it's being rendered:If it's a descendant of
<Toolbar>, it acceptsextraProps,titleandisActiveprops.If it's a descendant of
<Toolbar __experimentalAccessibilityLabel>, it accepts additionalButtonprops likelabelandisPressed(which are equivalent totitleandisActive). This is soToolbarButtonhas the same API asButton, which makes it easier to migrate from one to another.The problem is that, depending on the situation, the same
ToolbarButtoncomponent may be rendered within differentToolbarcomponents, and, because of that, it'll unpredictably change its own API.The following
ToolbarButtonwould work only when within<Toolbar __experimentalAccessibilityLabel>:If it's rendered within
<Toolbar>, bothlabelandisPressedprops would be ignored.There's another PR (#22637) that proposes deprecating
title,isActiveandextraPropsfromToolbarButton, but it turns out that getting rid of those props is not as simple as I'd anticipated, so I'm creating this simpler PR just to avoid future issues.This PR updates the component so both cases have the same API: both will accept the
Buttonprops in addition to theToolbarButtoncustom props.