Skip to content

docs: add useId example for aria-labelledby in reusable components #3398

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

docs: add useId example for aria-labelledby in reusable components #3398

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
32 changes: 32 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,38 @@ 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)

:::tip Using `aria-labelledby` in reusable components
When using `aria-labelledby` inside a Vue component that may be rendered multiple times on the same page, static `id` values will conflict. Use Vue's [`useId`](/api/composition-api-helpers.html#useid) helper to generate unique IDs that are stable across server and client rendering:

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

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

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

This ensures each component instance gets unique IDs, preventing collisions when the same component is used multiple times on a page.
:::

#### `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