accessible-menu-bootstrap-5

A JavaScript library to help you generate WAI-ARIA accessible menus with in the DOM using Bootstrap 5.

This project is an extension of accessible-menu to allow out-of-the-box for Bootstrap 5 compatibility.

The supported menu types are:

• Disclosure Navigation Menus,
• Disclosure Navigation Menus with Top-Level Links,
• Navigation Menubar, and
• Navigation Treeview

Getting Started

Please follow the main project's documentation.

Installation

You can install Accessible Menu Bootstrap 5 into your project using NPM.

# latest stable
npm install accessible-menu-bootstrap-5

Using Accessible Menu from a CDN

You can use Accessible Menu Bootstrap 5 directly from a CDN via a script tag.

<script src="https://cdn.jsdelivr.net/npm/accessible-menu-bootstrap-5/dist/accessible-menu-bs5.iife.js"></script>

We use jsdelivr as the example, but you can use any cdn you prefer, such as unpkg. You can also download the files listed in the CDN and host them yourself if preferred.

Examples

The following codepens are available as examples of how to use accessible-menu:

• Disclosure Navigation Menu
• Disclosure Navigation Menu with Top-Level Links
• Navigation Menubar
• Navigation Treeview

Sponsors

Versioning

This project uses Semantic Versioning 2.0.0 to keep track of releases.

For more detailed information about SemVer, please see the official documentation.

Contributing

If you're interested in contributing to the project, please read the Contribution Guidelines. Any and all contributions must follow these guidelines or they will not be accepted.