Skip to content

List - examples should use unique aria labeling #11396

@thatblindgeye

Description

@thatblindgeye

Describe the enhancement or change
The lists in examples should have unique aria labeling to follow the recommendation of doing so when multiple are on a page. For nested lists, the label could be the text of its parent item, but would require tweaking the list item content in examples to include the example name, e.g. "Basic first item" instead of "First".

Components with lists that should be updated are below, and should include their own examples/demos as well as anywhere else they're being used (e.g. Breadcrumbs being used in our Dashboard demo components). We're ignoring issues that would need to be fixed in Org, <ul> or <ol> elements with a role other than list (like TreeView), as well as Markdown lists; the Markdown lists would need discussion for updating them or not and how to go about it best.

  • AlertGroup
  • Breadcrumb
  • Divider ("Using li" example)
  • JumpLinks (component code may also need tweaking; we export a JumpLinksList component, but JumpLinks isn't using it and doesn't allow passing any other props to the ul)
  • LabelGroup (specific callout for the Toolbar examples "With filters" and "With custom label group content" are using the same labeling for labelgroups and need to be unique)
  • List
  • LoginPage (the footer list of links in demos could use their own unique labling
  • Multiple file upload (the "Rejected" demo's status list after something is uploaded)
  • Navigation (similar to JumpLinks; we export a NavList but NavExpandable and NavGroup aren't using it+don't have a way to pass an aria-label in to label the NavList)
  • NotificationDrawer (full page demos)
  • ProgressStepper ("Compact" example and "Basic" demo)
  • Skip to content basic demo is using several u/ol's
  • Toolbar (the "Sticky" example using a plain ul element)
  • Wizard (the WizardNav component)

Is this request originating from a Red Hat product team? If so, which ones and is there any sort of deadline for this enhancement?

Any other information?

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions