RedHat-UX / red-hat-design-system

Red Hat's Design System
https://ux.redhat.com
MIT License
97 stars 19 forks source link

[epic][docs] Enhanced Accessibility Information on Component Pages #193

Closed bennypowers closed 1 year ago

bennypowers commented 3 years ago

This is a meta-issue to track updating a11y-related info on component pages. This was instigated by a discussion about the behaviour of search bars in <pfe-nav> that came up in our internal chats. The aim of this issue is to 'catch-up'documentation of existing components.

This issue may be expanded in the future to include non-a11y-related things like live demos / code playgrounds

This issue tries to distinguish between navigation in a "web page" context and navigation in a "web app" context. We may determine that this is out of scope for the time being.

This list is a work-in-progress

Accordion

Alert

Notes: should clarify whether toasts trap focus

Announcement

Notes: should clarify whether announcements precede 'skip to content' in taborder

Audio Player

Avatar

Button

Notes: we should elaborate on action vs. navigation in SPA context, Perhaps combine "Action vs navigation" and "Button vs call to action" sections of prose, and elaborate on cases like tabbed UI in SPA contexts

Call to Action

Card

Disclosure

Filter

Form

Jump links

Link

Link with icon

Notes: should this be collapsed into the Link page?

Modal

Navigation

Progress steps

Promo

Quote

Search bar

Skip navigation

Sticky banner

Sticky card

Tabs

Tooltip

Video thumbnail

markcaron commented 2 years ago

@bennypowers @methomps are you opposed to making this an [epic]?

bennypowers commented 2 years ago

@markcaron sounds good https://github.com/RedHat-UX/red-hat-design-system/milestone/1