Skip to content

docs: mention useId for aria-labelledby #3394

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
popsiclelmlm wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: mention useId for aria-labelledby #3394

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
42 changes: 38 additions & 4 deletions src/guide/best-practices/accessibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,19 +214,53 @@ Using [`aria-labelledby`](https://developer.mozilla.org/en-US/docs/Web/Accessibi
>
<h1 id="billing">Billing</h1>
<div class="form-item">
<label for="name">Name: </label>
<label id="name-label" for="name">Name: </label>
<input
type="text"
name="name"
id="name"
v-model="name"
aria-labelledby="billing name"
aria-labelledby="billing name-label"
/>
</div>
<button type="submit">Submit</button>
</form>
```

When this pattern is used in a reusable component, avoid hard-coded `id` values because they must be unique in the whole document. Use [`useId()`](/api/composition-api-helpers#useid) to generate stable IDs for each component instance:

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

const billingId = useId()
const nameId = useId()
const name = ref('')
</script>

<template>
<form
class="demo"
action="/dataCollectionLocation"
method="post"
autocomplete="on"
>
<h1 :id="billingId">Billing</h1>
<div class="form-item">
<label :id="`${nameId}-label`" :for="nameId">Name: </label>
<input
type="text"
name="name"
:id="nameId"
v-model="name"
:aria-labelledby="`${billingId} ${nameId}-label`"
/>
</div>
<button type="submit">Submit</button>
</form>
</template>
```

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

#### `aria-describedby` {#aria-describedby}
Expand All @@ -242,13 +276,13 @@ Using [`aria-labelledby`](https://developer.mozilla.org/en-US/docs/Web/Accessibi
>
<h1 id="billing">Billing</h1>
<div class="form-item">
<label for="name">Full Name: </label>
<label id="full-name-label" for="name">Full Name: </label>
<input
type="text"
name="name"
id="name"
v-model="name"
aria-labelledby="billing name"
aria-labelledby="billing full-name-label"
aria-describedby="nameDescription"
/>
<p id="nameDescription">Please provide first and last name.</p>
Expand Down