Skip to content
/ be-a11y Public

Be a11y is a collection of useful accessible components such as tabs, accordion, modal dialog...

License

Notifications You must be signed in to change notification settings

BeAPI/be-a11y

Repository files navigation

Be API Github Banner

Be a11y

Maintenance

This repository contains a collection of useful accessible components such as tabs, accordion, modal dialog...

Installation

Start by installing the package.

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.

import { Accordion } from '@beapi/be-a11y';

Accordion.init('#my-accordion', {
    allowMultiple: true,
});

For more details about components, check the documentations:

Want to contribute?

Project works with Vite ⚡ and Playwright 🎭.

Development

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.

pnpm build

Then, you can launch a local server.

pnpm preview

Test your code

You can run UI tests with the following command.

pnpm test