2.0.0 ā€¢ Published 22 days ago

@feedzai/react-a11y-tools v2.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
22 days ago

Read The Docs

Table of Contents

The Problem

We find ourselves amidst the age of design systems, where virtually every company, regardless of size, has either established one or contemplated its creation. These systems serve as invaluable resources, equipping us with the means to swiftly construct seamless and uniform user interfaces.

Yet, accessibility remains a challenging endeavor, particularly when integrating frameworks like React. Whether we rely on existing design systems or embark on crafting our own from the ground up, ensuring accessibility often emerges as an afterthought. Regrettably, some companies face constraints in resources and time, making it difficult to prioritize accessibility efforts.

The Solution

Our objective is to streamline certain aspects of the accessibility journey, focusing on key areas such as focus management, navigation, and announcements.

This library offers comprehensive accessibility features and behaviors in line with the WAI-ARIA Authoring Practices, encompassing support for screen-reader and keyboard navigation.

We refrain from imposing any specific styling methodology or design requirements. Instead, our compact package delivers essential behaviors and interactions, allowing you to concentrate on your design without constraints.

Additionally, we include a straightforward testing tool to simulate a mouse-free environment, facilitating thorough accessibility testing during development.

Installation

To integrate React A11y Tools into your React project directory, execute one of the following commands:

$ npm install @feedzai/react-a11y-tools

# or if you use Yarn

$ yarn add @feedzai/react-a11y-tools

Roadmap

Here is a table of the components, custom hooks and their status.

āœ… - Released šŸ›  - Building

StatusName
āœ…Messages Announcer
āœ…Route Announcer
āœ…Focus Manager
āœ…Roving Tabindex
āœ…Keyboard Only
āœ…Skip Links
āœ…Semantic Headings
āœ…Visually Hidden
āœ…useTabbable
āœ…useAutoId

Issues

šŸ› Bugs

Please file an issue for bugs, missing documentation, or unexpected behaviour.

See Bugs

šŸ’” Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a šŸ‘. This helps maintainers prioritize what to work on.

See Feature Requests

Tests

There are three layers of tests written for this library:

  • Unit tests: we use vitest
  • Component tests: we use cypress
  • End-to-end tests: we also use cypress

To run the whole suite of tests, make sure you've done the steps in installation, then:

Run all tests

npm run test

Unit tests

npm run test:unit

Cypress component tests:

npm run test:component-open

End-to-end tests:

npm run test:e2e
2.0.0

22 days ago

1.5.2

2 months ago

1.5.1

2 months ago

1.5.0

2 months ago

1.4.0

1 year ago

1.3.1

2 years ago

1.2.0

2 years ago

1.3.0

2 years ago

1.3.0-rc.0

2 years ago

1.1.0

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.1.0-tabs.3

3 years ago

1.1.0-tabs

3 years ago

1.1.0-tabs.0

3 years ago

1.1.0-tabs.1

3 years ago

1.1.0-tabs.2

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.3-rollup

3 years ago

1.0.1-rc

3 years ago

1.0.0

3 years ago