Skip to content

Commit

Permalink
docs: add accessibility docs to Seat component
Browse files Browse the repository at this point in the history
  • Loading branch information
DSil committed Nov 7, 2024
1 parent 786219f commit 7e881a9
Showing 1 changed file with 60 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: Accessibility
redirect_from:
- /components/seat/accessibility/
---

# Accessibility

## Seat

The Seat component has been designed with accessibility in mind.

It can be used with keyboard navigation, and it includes the following properties that allow to improve the experience for users of assistive technologies:

| Name | Type | Description |
| :-------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------- |
| aria-labelledby | `string` | Id(s) of elements that announce the component to screen readers. |

Check failure on line 17 in docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Kiwi.OptionalPlurals] Don't use plurals in parentheses such as in 'Id(s)'. Raw Output: {"message": "[Kiwi.OptionalPlurals] Don't use plurals in parentheses such as in 'Id(s)'.", "location": {"path": "docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx", "range": {"start": {"line": 17, "column": 32}}}, "severity": "ERROR"}
| title | `string` | Adds the `title` attribute to the rendered SVG element. Announced by screen readers after the `aria-labelledby` element(s). |

Check failure on line 18 in docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Kiwi.OptionalPlurals] Don't use plurals in parentheses such as in 'element(s)'. Raw Output: {"message": "[Kiwi.OptionalPlurals] Don't use plurals in parentheses such as in 'element(s)'.", "location": {"path": "docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx", "range": {"start": {"line": 18, "column": 144}}}, "severity": "ERROR"}
| description | `string` | Adds the `description` attribute to the rendered SVG element. Announced by screen readers after the `title` value. |

All the props above are optional, but recommended to use to ensure the best experience for all users.

The `aria-labelledby` prop can reference multiple ids, separated by a space.
The elements with those ids can be hidden, so that their text is only announced by screen readers.

The `title` and `description` props are used to provide additional context to the rendered SVG element that visually represents the seat.
They are also announced by screen readers.

Check warning on line 27 in docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Kiwi.Contractions] Feel free to use a contraction instead of 'They are': https://orbit.kiwi/content/technical-content/language/#use-contractions Raw Output: {"message": "[Kiwi.Contractions] Feel free to use a contraction instead of 'They are': https://orbit.kiwi/content/technical-content/language/#use-contractions", "location": {"path": "docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx", "range": {"start": {"line": 27, "column": 1}}}, "severity": "INFO"}

The conjugation of these properties allows to provide a detailed description of the seat to users of assistive technologies.

For example, the following code snippet shows how to use these properties:

```jsx
<p id="l1" style={{ display: "none", visibility: "hidden" }}>
For passenger John Doe
</p>
<Seat
aria-labelledby="l1"
title="Seat 1A"
description="Extra legroom"
label="25€"
/>
```

It would have the screen reader announce: "For passenger John Doe. Seat 1A. Extra legroom.".

Note that the `label` prop is **not** announced by screen readers, as it is intended for visual representation only.

Check warning on line 47 in docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Kiwi.Contractions] Feel free to use a contraction instead of 'it is': https://orbit.kiwi/content/technical-content/language/#use-contractions Raw Output: {"message": "[Kiwi.Contractions] Feel free to use a contraction instead of 'it is': https://orbit.kiwi/content/technical-content/language/#use-contractions", "location": {"path": "docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx", "range": {"start": {"line": 47, "column": 71}}}, "severity": "INFO"}
So be sure to include all relevant information on the three properties that are announced by screen readers.

Alternatively, the paragraph element with the id `l1` is visually hidden, so that its text is only read by screen readers but not present on the screen.

It is also recommended to have those strings translated and change dynamically based on the state of the user journey (eg: if the seat is selected and the user is about to deselect it, the screen reader should announce it).

Check warning on line 52 in docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Kiwi.Contractions] Feel free to use a contraction instead of 'It is': https://orbit.kiwi/content/technical-content/language/#use-contractions Raw Output: {"message": "[Kiwi.Contractions] Feel free to use a contraction instead of 'It is': https://orbit.kiwi/content/technical-content/language/#use-contractions", "location": {"path": "docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx", "range": {"start": {"line": 52, "column": 1}}}, "severity": "INFO"}

Check failure on line 52 in docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'eg'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'eg'?", "location": {"path": "docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx", "range": {"start": {"line": 52, "column": 120}}}, "severity": "ERROR"}

## SeatLegend

The SeatLegend component is not interactive. However, it accepts the `aria-label` prop, that is passed to the rendered SVG element.

Check warning on line 56 in docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Kiwi.Contractions] Feel free to use a contraction instead of 'is not': https://orbit.kiwi/content/technical-content/language/#use-contractions Raw Output: {"message": "[Kiwi.Contractions] Feel free to use a contraction instead of 'is not': https://orbit.kiwi/content/technical-content/language/#use-contractions", "location": {"path": "docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx", "range": {"start": {"line": 56, "column": 26}}}, "severity": "INFO"}

Check warning on line 56 in docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Kiwi.Contractions] Feel free to use a contraction instead of 'that is': https://orbit.kiwi/content/technical-content/language/#use-contractions Raw Output: {"message": "[Kiwi.Contractions] Feel free to use a contraction instead of 'that is': https://orbit.kiwi/content/technical-content/language/#use-contractions", "location": {"path": "docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx", "range": {"start": {"line": 56, "column": 89}}}, "severity": "INFO"}

It allows for screen readers to provide a meaningful description of the seat type, which can be useful for users of assistive technologies.

The `label` prop is also announced by screen readers.

0 comments on commit 7e881a9

Please sign in to comment.