https://github.com/beapi/be-a11y
Be a11y is a collection of useful accessible components such as tabs, accordion, modal dialog...
https://github.com/beapi/be-a11y
a11y accessibility accordion components js megamenu modal slider tabs video
Last synced: 10 months ago
JSON representation
Be a11y is a collection of useful accessible components such as tabs, accordion, modal dialog...
- Host: GitHub
- URL: https://github.com/beapi/be-a11y
- Owner: BeAPI
- License: gpl-3.0
- Created: 2021-04-24T20:11:40.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-07T13:31:23.000Z (11 months ago)
- Last Synced: 2025-04-22T15:11:59.990Z (10 months ago)
- Topics: a11y, accessibility, accordion, components, js, megamenu, modal, slider, tabs, video
- Language: JavaScript
- Homepage: https://beapi.fr/
- Size: 1.13 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://beapi.fr)
# Be a11y
[](https://GitHub.com/BeAPI/be-a11y/graphs/commit-activity)
This repository contains a collection of useful accessible components such as tabs, accordion, modal dialog...
## Installation
Start by installing the package.
```bash
pnpm add @beapi/be-a11y # or npm install @beapi/be-a11y --save or yarn add @beapi/be-a11y
```
Then, import in your JavaScript file the component you need.
```js
import { Accordion } from '@beapi/be-a11y';
Accordion.init('#my-accordion', {
allowMultiple: true,
});
```
For more details about components, check the documentations:
* [Accordion](examples/accessible-accordion/)
* [Dropdown](examples/accessible-dropdown/)
* [Modal](examples/accessible-modal/)
* [Slider](examples/accessible-slider/)
* [Tabs](examples/accessible-tabs/)
* [Toggle](examples/accessible-toggle/)
## Want to contribute?
Project works with [Vite ⚡](https://vitejs.dev/) and [Playwright 🎭](https://playwright.dev/).
### Development
```bash
pnpm # Install dependencies
pnpm dev # Start development server
```
### Build
In `examples` directory you can find sample of components. First of all you have to build the JS with the following command.
```bash
pnpm build
```
Then, you can launch a local server.
```bash
pnpm preview
```
### Test your code
You can run UI tests with the following command.
```bash
pnpm test
```