Global Styles Sidebar: Rename NavigationButton so semantics are clearer
#40590
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
mirka
added
[Type] Code Quality
|
Size Change: +4 B (0%) Total Size: 1.23 MB
ℹ️ View Unchanged
|
mirka
commented
Apr 25, 2022
Comment on lines
+47
to
+48
| <ItemGroup> | ||
| <NavigationButtonAsItem path="/variations"> |
There was a problem hiding this comment.
This "fixes" the semantic issue, but wrapping this single item in an ItemGroup is not ideal. Ideally I would like to use a vanilla NavigatorButton here instead of the Item-wrapped version, but unfortunately there is a styling inconsistency (#40591) that makes that weird too.
I think we can go with this bandaid fix, since we'll probably overhaul this view (#40478) anyway.
There was a problem hiding this comment.
What about overriding the role, so that at least we don't have a semantically weird one-item list ?
Suggested change
| <ItemGroup> | |
| <NavigationButtonAsItem path="/variations"> | |
| <ItemGroup role={ null }> | |
| <NavigationButtonAsItem | |
| path="/variations" | |
| role={ null } | |
| > |
Just a caveat: eslint complains about passing null as a value, but it's the only way to properly override this value (passing undefined would make ItemGroup and Item fallback on their default role values)
There was a problem hiding this comment.
Yeah, I'm hesitant to do that too since I agree with eslint that role={ null } is not at all kosher 😅 And neither is role="generic", apparently.
My preference would be to fix the focus outline inconsistency so we can just use a vanilla NavigatorButton. (A potential path to overriding semantics cleanly is the as prop though.)
There was a problem hiding this comment.
Agreed. Let's improve the focus outline inconsistency, and then look at a way to rewrite ItemGroup in a way that makes possible using as to override semantics (together with a few other tweaks that we took note of)
Comment on lines
+23
to
+24
| <View role="list"> | ||
| <NavigationBackButtonAsItem |
There was a problem hiding this comment.
This bandaid fix will be ripped off in #40592.
ciampo
approved these changes
Apr 25, 2022
Comment on lines
+47
to
+48
| <ItemGroup> | ||
| <NavigationButtonAsItem path="/variations"> |
There was a problem hiding this comment.
What about overriding the role, so that at least we don't have a semantically weird one-item list ?
Suggested change
| <ItemGroup> | |
| <NavigationButtonAsItem path="/variations"> | |
| <ItemGroup role={ null }> | |
| <NavigationButtonAsItem | |
| path="/variations" | |
| role={ null } | |
| > |
Just a caveat: eslint complains about passing null as a value, but it's the only way to properly override this value (passing undefined would make ItemGroup and Item fallback on their default role values)
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.
Part of #38934
Based on #40588
What?
NavigationButtontoNavigationButtonAsItem, so future devs are less likely to make the same mistake.Why?
There was a local component called
NavigationButton, which hadlistitemsemantics under the hood but were mistakenly reused in non-list contexts.How?
See PR code comments for specifics.
Testing Instructions
npm run dev