Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UI: Improve contrast ratio between focus / hover #24205

Merged
merged 8 commits into from
Sep 22, 2023

Conversation

chocoscoding
Copy link
Contributor

@chocoscoding chocoscoding commented Sep 18, 2023

hover and focus states to meet the minimum requirement of 3:1

Closes #24162

What I did

Adjusted the contrast ratio for focus and hover on and to pass 3:1 minimum contrast ratio requirements

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

states to meet the minimum requirement of 3.1
@@ -133,6 +133,7 @@ export const LeafNodeStyleWrapper = styled.div(({ theme }) => ({
'&:hover, &:focus': {
outline: 'none',
background: theme.background.hoverable,
color: theme.color.lighter,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for your changes. I checked the branch locally and the result doesn't seem to work properly. When I hover a story the text is becoming white because you set the hover to use color: theme.color.lighter.
What was your intent by doing that?

CleanShot 2023-09-19 at 09 39 32

Copy link
Contributor Author

@chocoscoding chocoscoding Sep 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, Pardon me. I didn't test for the light mode to see this.
In dark mode, the color of the text on hover and focus was lighter. Which made it pop and more noticable.
Which gave a good contrast ratio score as well.

However, it wasn't so complete.

I have removed them and changed the hover color

@@ -73,6 +73,7 @@ const BranchNode = styled.button<{
background: 'transparent',
'&:hover, &:focus': {
background: theme.background.hoverable,
color: theme.color.lighter,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here. Why did you choose to set it to use color.lighter ? These colors are set and would be the same if you are using dark and light mode.

@chocoscoding
Copy link
Contributor Author

I would love to get your opinion on this though,
If i was to archive the text popping on focus and hover effect on both light mode and dark mode.

I did color: theme.base === 'light' ? theme.color.darkest : theme.color.lighter and it works well.

Do you think its too much or you would like to see it

@ndelangen ndelangen changed the title (bug) Adjust the contrast ratio for focus and hover UI: Improve contrast ratio between focus / hover Sep 19, 2023
@cdedreuille
Copy link
Contributor

Yes the code you shared depending on the them could work. We are working on a new way to set colours in Storybook that will make working with light and dark mode much easier. But for now this solution could work well.

@chocoscoding
Copy link
Contributor Author

chocoscoding commented Sep 20, 2023

Oh, noted.
Would love to see how you handle the theme.
Also I have made the contrast ratio good without any highlighting of the color attribute

Or use the proposed method

@cdedreuille
Copy link
Contributor

cdedreuille commented Sep 22, 2023

Even better. Then I think it's ok to be merged. Thanks a lot @chocoscoding for your help in making Storybook more accessible. 🙏

@cdedreuille cdedreuille merged commit 379d1b0 into storybookjs:next Sep 22, 2023
9 checks passed
@github-actions github-actions bot mentioned this pull request Sep 22, 2023
20 tasks
@yannbf yannbf mentioned this pull request Oct 17, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants