Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pmndrs/react-three-a11y
♿️ Accessibility tools for React Three Fiber
https://github.com/pmndrs/react-three-a11y
a11y accessibility react-three-fiber reactjs threejs
Last synced: 27 days ago
JSON representation
♿️ Accessibility tools for React Three Fiber
- Host: GitHub
- URL: https://github.com/pmndrs/react-three-a11y
- Owner: pmndrs
- License: other
- Created: 2021-01-04T12:39:31.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T13:04:31.000Z (9 months ago)
- Last Synced: 2024-05-01T11:29:10.248Z (6 months ago)
- Topics: a11y, accessibility, react-three-fiber, reactjs, threejs
- Language: TypeScript
- Homepage: https://docs.pmnd.rs/a11y/introduction
- Size: 32.6 MB
- Stars: 515
- Watchers: 6
- Forks: 13
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - react-three-a11y
- awesome-react-three-fiber - react-three-a11y
README
@react-three/a11y
[](https://www.npmjs.com/package/@react-three/a11y)
[](https://www.npmjs.com/package/@react-three/a11y)
[](https://discord.gg/ZZjjNvJ)
@react-three/a11y brings accessibility to webGL with easy-to-use react-three-fiber components:
- Focus and focus indication
- Tab index and keyboard navigation
- Screen reader support and alt-text
- Roles and cursor shapes
- Descriptive links
You can try a [live demo here](https://n4rzi.csb.app).
```bash
npm install @react-three/a11y
```
## Quick overview to get started
note: The full documentation can be found on the [pmndrs website](https://docs.pmnd.rs/a11y/introduction).
### The A11yAnnouncer component
First, place the A11yAnnouncer component next to the R3F Canvas component. this componant is critical since it manage some screen-reader features.
```jsx
import { Canvas } from '@react-three/fiber';
import { A11yAnnouncer } from '@react-three/a11y';
function App() {
return (
<>
>
);
}
```
### Then wrap components you want to make accessible with the A11y component
To add accessibility features to your scene you'll have to wrap components you want to make focusable with the `A11y` component:
```jsx
import { A11y } from '@react-three/a11y'
[...]
```
`MyComponent` can now receive focus. More accurately, the emulated "focus" will be handled at the `A11y` components which acts as a provider
for children to access its state. But even if objects are focusable, nothing will be displayed or shown by default.
## Call function on focus
The `focusCall` prop of `A11y` will be called each time this component receives focus (usually through tab navigation).
```jsx
console.log("in focus")} ... />
```
## Call function on click / keyboard Click
The `actionCall` prop of `A11y` will be called each time this component gets clicked, focused, keyboard activated etc.
```jsx
console.log("clicked")} ... />
```
## Provide a description of the currently focused / hovered element
When using the `description` prop in combination with the `role` prop, the `A11y` component will provide a description to the screen reader users on focus/hover.
Optionally, you can also show the description to the user on hover by setting `showAltText={true}`.
```jsx
// Reads "A rotating red square" to screen readers on focus / hover while also showing it on mouseover
// Reads "Button, open menu + (description on how to activate depending on the screen reader)" to screen readers on focus / hover
{someFunction()}} ... />
```
## The four roles of the A11y component
Like in HTML, you can focus different kind of elements and expect different things depending on what you're focusing.
#### Content
```jsx
```
Uses the `default` cursor. This role is meant to provide information to screen readers or to serve as a step for a user to navigate your site using Tab for instance. It's not meant to trigger anything on click or to be activable with the Keyboard. Therefore it won't show a pointer cursor on hover.
[Read more about role content](/a11y/roles/content)
#### Button
```jsx
```
Uses the `pointer` cursor. Special attributes: `activationMsg`.
This role is meant to emulate the behaviour of a button or a togglable button. It will display a cursor pointer when your cursor is over the linked 3D object. It will call a function on click but also on any kind of action that would trigger a focused button (Enter, Double-Tap, ...). It is also actionnable by user using a screen reader.
[Read more about role button](https://docs.pmnd.rs/a11y/roles/button)
#### ToggleButton
By using the role togglebutton, you'll emulate a button with two state that will have the `aria-pressed` attribute.
You'll then be able to use the deactivationMsg property in addition to the usual description and activationMsg properties.
```jsx
```
Special attributes: `deactivationMsg`
[Read more about role ToggleButton](https://docs.pmnd.rs/a11y/roles/togglebutton)
#### Link
```jsx
```
Uses the `pointer` cursor. Special attributes: `href`.
This role is meant to emulate the behaviour of a regular html link. It should be used in combination with something that will trigger navigation on click.
> [!NOTE]
> Don't forget to provide the href attribute as he is required for screen readers to read it correctly ! - It will have no effect on the navigation, it's just used as information
[Read more about role link](https://docs.pmnd.rs/a11y/roles/link)
## Screen Reader Support
In order to provide informations to screen reader users and use this package at its full potential, fill the `description` prop of all your `A11y` components and use the appropriate `role` prop on each of them.
### Use of section
For screen readears, it might be useful to provide additionnal information on how to use some unconventional UI.
You can do it by wrapping the concerned part of your code relative to this UI in the A11ySection like so.
```jsx
[...]
```
## Access user preferences
The A11yUserPreferences component is available in order to access user preferences such as
- prefers-reduced-motion
- prefers-color-scheme
Take a look at [the A11yUserPreferences page](https://docs.pmnd.rs/a11y/access-user-preferences) or the [demo](https://n4rzi.csb.app) to see it in action and how to use it. The demo will adapt to your system preferences.
## Additionals Features
Use a custom tabindex with for your A11y components by providing a number to the tabIndex attribute
```jsx
```
> [!CAUTION]
> Avoid using `tabindex` values greater than 0. Doing so makes it difficult for people who rely on assistive technology to navigate and operate page content.
> Instead, write the document with the elements in a logical sequence. More about the use of tabIndex on [developer.mozilla.org](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex)
### Author:
- [`twitter 👋 @AlaricBaraou`](https://twitter.com/AlaricBaraou)