patternfly-react icon indicating copy to clipboard operation
patternfly-react copied to clipboard

JumpLinks - add aria-labelledby prop and warning for aria labels

Open thatblindgeye opened this issue 2 years ago • 3 comments

Is this a new component or an extension of an existing one? JumpLinks

Describe the feature Follow up to comments in https://github.com/patternfly/patternfly-org/pull/3808

Basically right now the default value of the aria-label on JumpLinks is set to the label prop if passed in, and only if label is a string. Ideally we should consider making updates so that:

  • an aria-labelledby prop can be passed in which can be given an id of the label element or some other element that labels the jump links nav.
  • if label is not a string and aria-labelledby is not manually passed in, generate a random id internally that's applied to the label wrapper element (pf-v5-c-jump-links__label), with that id passed to an aria-labelledby attribute on the outer JumpLinks nav element.
  • We could also consider removing the default value of the aria-label prop, but that may need to wait for a breaking change. Rationale here is that it would make more sense to link to the visible text label via aria-labelledby rather than repeat the text in an aria-label; while React is automating that for the consumer, it's only when the label prop is a string and in the HTML implementation there isn't that same automation provided by us

We should also add in a console warning if neither aria-label or aria-labelledby are passed in, otherwise there's a chance that the JumpLinks internal nav has no proper accessible name.

Are there visuals for this feature? If applicable, please include examples for each state and for varying widths Include screenshots or links to Marvel or other mockups.

Any other information? A followup will need to be made in org to add verbiage to the a11y docs for JumpLinks

thatblindgeye avatar Nov 08 '23 14:11 thatblindgeye

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

github-actions[bot] avatar Jan 27 '25 11:01 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

github-actions[bot] avatar Mar 30 '25 11:03 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

github-actions[bot] avatar May 31 '25 11:05 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

github-actions[bot] avatar Aug 06 '25 11:08 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

github-actions[bot] avatar Oct 07 '25 11:10 github-actions[bot]