Skip to content

docs: show useId with aria-labelledby #3393

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.

Sign up for GitHub

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

Open
MukundaKatta wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: show useId with aria-labelledby #3393

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions src/guide/best-practices/accessibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,34 @@ Using [`aria-labelledby`](https://developer.mozilla.org/en-US/docs/Web/Accessibi

![Chrome Developer Tools showing input accessible name from aria-labelledby](./images/AccessibleARIAlabelledbyDevTools.png)

When this pattern is used inside a reusable component, generate the IDs with
[`useId()`](/api/composition-api-helpers.html#useid) instead of hard-coding
them. This keeps each component instance's `id` values unique while still
linking the visible text to the form control:

```vue
<script setup>
import { useId } from 'vue'

const sectionId = useId()
const nameId = useId()
</script>

<template>
<section class="form-section">
<h2 :id="sectionId">Billing</h2>

<label :id="nameId" :for="`${nameId}-input`">Name: </label>
<input
:id="`${nameId}-input`"
type="text"
name="name"
:aria-labelledby="`${sectionId} ${nameId}`"
/>
</section>
</template>
```

#### `aria-describedby` {#aria-describedby}

[aria-describedby](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-describedby) is used the same way as `aria-labelledby` except provides a description with additional information that the user might need. This can be used to describe the criteria for any input:
Expand Down