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

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

Closed
9 of 27 tasks
bennypowers opened this issue Oct 7, 2021 · 2 comments
Closed
9 of 27 tasks
Assignees
Labels
docs Improvements or additions to documentation feature New feature or request needs discovery Needs discovery

Comments

@bennypowers
Copy link
Member

bennypowers commented Oct 7, 2021

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

  • Keyboard behaviour
  • Live Demo
  • WCAG & MDN links

Alert

  • Keyboard behaviour
  • Live Demo

Notes: should clarify whether toasts trap focus

Announcement

  • Keyboard behaviour
  • Live Demo
  • WCAG & MDN links

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

Audio Player

  • Keyboard behaviour
  • Focus behaviour
  • Live Demo
  • WCAG & MDN links

Avatar

  • Keyboard behaviour (n/a)
  • Contrast, alt text or presentation role
  • Live Demo
  • WCAG & MDN links if applicable

Button

  • Keyboard behaviour
  • Interaction states specification
  • Live Demo
  • WCAG & MDN links

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

  • Interaction states specification
  • Keyboard behaviour
  • Live Demo
  • WCAG & MDN links

Card

Disclosure

Filter

Form

Jump links

Link

Link with icon

Notes: should this be collapsed into the Link page?

Modal

Navigation

  • Keyboard behaviour
  • Clarify: does expanding a hidden control auto focus the control?
  • WCAG & MDN links

Progress steps

Promo

Quote

Search bar

Skip navigation

Sticky banner

Sticky card

Tabs

Tooltip

Video thumbnail

@markcaron markcaron added the docs Improvements or additions to documentation label Apr 20, 2022
@markcaron markcaron changed the title Enhanced Accessibility Information on Component Pages [doc] Enhanced Accessibility Information on Component Pages May 5, 2022
@markcaron markcaron changed the title [doc] Enhanced Accessibility Information on Component Pages [docs] Enhanced Accessibility Information on Component Pages May 5, 2022
@methomps methomps added feature New feature or request needs discovery Needs discovery labels May 24, 2022
@markcaron
Copy link
Collaborator

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

@bennypowers
Copy link
Member Author

bennypowers commented Jun 6, 2022

@bennypowers bennypowers added this to the Enhanced Accessibility Documentation milestone Jun 6, 2022
@markcaron markcaron modified the milestones: Enhanced Accessibility Documentation, Epic: redesign of documentation site (new IA) Feb 28, 2023
@markcaron markcaron changed the title [docs] Enhanced Accessibility Information on Component Pages [epic][docs] Enhanced Accessibility Information on Component Pages Mar 13, 2023
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 feature New feature or request needs discovery Needs discovery
Projects
Status: Done ☑️
Development

No branches or pull requests

3 participants