patternfly / patternfly/patternfly-react
JumpLinks - add aria-labelledby prop and warning for aria labels
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 862
- Forks
- 392
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 9
Description
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-labelledbyprop can be passed in which can be given anidof thelabelelement or some other element that labels the jump links nav. -
if
labelis not a string andaria-labelledbyis not manually passed in, generate a randomidinternally that's applied to thelabelwrapper element (pf-v5-c-jump-links__label), with thatidpassed to an aria-labelledby attribute on the outer JumpLinksnavelement. -
We could also consider removing the default value of the
aria-labelprop, 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 viaaria-labelledbyrather than repeat the text in anaria-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
Jira Issue: PF-109
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the JumpLinks component entry point and read its existing label and aria-label handling. Trace how props reach the label wrapper and nav, then verify that aria-labelledby support, the generated label id, and the missing accessible-name warning satisfy the issue; the related PatternFly org accessibility documentation remains a follow-up.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- accessibility, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100