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

[docs] Add focus indicator style guidance #2132

Open
hellogreg opened this issue Jan 16, 2025 · 5 comments
Open

[docs] Add focus indicator style guidance #2132

hellogreg opened this issue Jan 16, 2025 · 5 comments
Assignees
Labels
docs Improvements or additions to documentation

Comments

@hellogreg
Copy link
Collaborator

hellogreg commented Jan 16, 2025

Because we currently have so many disparate keyboard focus styles across our site system (dashed/dotted/solid/inset outlines, background highlights, text color changes, etc.), we're standardizing these indicators to align with WCAG 2.2's recommendation:

Solid, offset outlines of at least 2px with at least 3:1 background/adjacent contrast

We need to craft some verbiage, add some relevant imagery, find a logical home for this at ux.redhat.com, and get the word out to our designers and engineers.

We've already got some documentation on this topic strewn across the site (e.g. the CTA Styles page), some of which we can consolidate for this issue.

References:

Focus style as-is and proposed to-be

@hellogreg hellogreg added the docs Improvements or additions to documentation label Jan 16, 2025
@hellogreg hellogreg added this to the 2025/Q1 — Cubone release milestone Jan 16, 2025
@hellogreg hellogreg self-assigned this Jan 16, 2025
@hellogreg hellogreg moved this from Backlog to Todo in Red Hat Design System Jan 16, 2025
@hellogreg
Copy link
Collaborator Author

hellogreg commented Jan 20, 2025

I'm working on an initial draft of the text for this now. But we also need to decide where this content will live.

There is currently a Focus section on the Accessibility > Design page. We could put this new content in a subsection under that section, and put the existing content in new subsections:

  • Design page
    • Focus section
      • Focus indicator styles (new subsection and content)
      • Focus and context changes (new subsection heading for existing content)
      • Focus traps (new subsection heading for existing content)

Or we could put it somewhere in the Foundations area of the site (either on an existing page or a new Interactions page), to make it clear that this is a design standard--and not just an accessibility topic. Or we could do something else altogether!

Thoughts, @markcaron or @coreyvickery ?

@hellogreg hellogreg moved this from Todo to In Progress 🟢 in Red Hat Design System Jan 30, 2025
@markcaron
Copy link
Collaborator

I would think that we're wanting to document the focus states in 2 ways:

  1. Under Accessibility > Design > Interactions — as guidance on accessibility requirements and general affordance, using our graphics as examples.
  2. Under a new page: Foundations > Interactions — as guidance on our design system's approach to interactions, including focus states as well as guidelines around ALL interactions, with graphics/examples

There may be some repetition, but I think that's ok. We can also cross-link the sections where appropriate.

Note: @hellogreg, when you messaged me in chat, I arrived at the Foundations idea ahead of coming here and reading your comment above. Great minds!

@hellogreg
Copy link
Collaborator Author

Thanks, @markcaron ! I do like the idea of an Interactions page.

@coreyvickery
Copy link
Collaborator

@hellogreg @markcaron I agree with everything.

Can we also add a subnavigation to the Accessibility > Design page at some point?

@hellogreg
Copy link
Collaborator Author

@coreyvickery I think that's a great idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Status: In Progress 🟢
Status: Todo
Development

No branches or pull requests

3 participants