vuejs/docs

aria-labelledby example with id and components

Closed

#1,510 opened on Feb 10, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Vue (5,040 forks)user submission
good first issue

Repository metrics

Stars
 (3,230 stars)
PR merge metrics
 (Avg merge 54d 19h) (13 merged PRs in 30d)

Description

The documentation at https://v3.vuejs.org/guide/a11y-semantics.html#labels shows using aria-labelledby however with Vue Components that breaks down as id is global within the page rather than local in scope to your component. I feel the documentation could do this a more vue way allowing components to be re-used multiple times within the page while still doing aria-labelledby.

For example something like https://github.com/vuejs/vue/issues/5886#issuecomment-308607131 works well.

Contributor guide

Research direction
Examine the current documentation at https://v3.vuejs.org/guide/a11y semantics.html#labels. Review the linked comment https://github.com/vuejs/vue/issues/5886#issuecomment 308607131 for a recommended approach. Update the example to use a method that generates unique IDs or uses a different pattern, and ensure components can be reused multiple times. The fix is localized to that specific section.
Tech stack
vuehtmlcss
Domain
documentationaccessibility
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic Vue component knowledgeunderstanding of ARIA attributes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85