Add ability for compound focus indicator #7479
Merged
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
jcfilben
reviewed
Jan 24, 2025
| }; | ||
| shadow?: | ||
| | string | ||
| | { | ||
| color?: ColorType; | ||
| size?: string; | ||
| blur?: string; | ||
| }; |
There was a problem hiding this comment.
Do we need to include allowAll here?
There was a problem hiding this comment.
Yes, thank you. Will add.
jcfilben
approved these changes
Jan 28, 2025
halocline
reviewed
Jan 28, 2025
src/js/themes/base.js
Outdated
| @@ -281,6 +281,7 @@ export const generate = (baseSpacing = 24, scale = 6) => { | |||
| color: 'focus', | |||
| size: '2px', | |||
| }, | |||
| allowAll: undefined, | |||
There was a problem hiding this comment.
Pausing on the name of this property. From a Grommet convention, typically we haven't used verbs, instead use a noun / specific property.
How were we thinking of describing this in the documentation? Something like?:
If true, applies both outline and shadow styles to create a compound focus ring.
OR,
If true, applies both outline and shadow styles to create a two-color focus ring.
A couple naming options:
twoColorcompound
"Two-color" seemed to be the most common terminology used in search results.
There was a problem hiding this comment.
Good feedback, let's use the term twoColor since it speaks to the technique this is seeking to enable.
halocline
approved these changes
Jan 28, 2025
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.
What does this PR do?
Enhances Grommet theme to allow for user to do compound focus style that combines both "outline" and "box-shadow" -- this is useful to enable alignment to WCAG recommendation: https://www.w3.org/WAI/WCAG21/Techniques/css/C40
Previously, Grommet would should outline or shadow, so the caller's theme must "opt-in" via
theme.global.focus.twoColor.Where should the reviewer start?
What testing has been done on this PR?
Locally and added jest test
Screen.Recording.2025-01-23.at.5.21.02.PM.mov
How should this be manually tested?
Do Jest tests follow these best practices?
screenis used for querying.asFragment()is used for snapshot testing.Any background context you want to provide?
What are the relevant issues?
Closes #7475
Screenshots (if appropriate)
Do the grommet docs need to be updated?
Should this PR be mentioned in the release notes?
Is this change backwards compatible or is it a breaking change?