Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nickdjm/accessible-menu-bootstrap-4
A JavaScript library to help you generate WAI-ARIA accessible menus with in the DOM using Bootstrap 4.
https://github.com/nickdjm/accessible-menu-bootstrap-4
accessibility aria bootstr bootstrap-4 bootstrap4 disclosure-menu hoverable hoverable-dropdown javascript menu menubar navigation treeview wcag
Last synced: 6 days ago
JSON representation
A JavaScript library to help you generate WAI-ARIA accessible menus with in the DOM using Bootstrap 4.
- Host: GitHub
- URL: https://github.com/nickdjm/accessible-menu-bootstrap-4
- Owner: NickDJM
- License: isc
- Created: 2021-06-18T18:56:17.000Z (over 3 years ago)
- Default Branch: 1.x
- Last Pushed: 2024-04-23T10:07:48.000Z (7 months ago)
- Last Synced: 2024-05-01T16:23:37.324Z (7 months ago)
- Topics: accessibility, aria, bootstr, bootstrap-4, bootstrap4, disclosure-menu, hoverable, hoverable-dropdown, javascript, menu, menubar, navigation, treeview, wcag
- Language: JavaScript
- Homepage:
- Size: 1.32 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# accessible-menu-bootstrap-4
[](https://www.npmjs.com/package/accessible-menu-bootstrap-4)
[](/LICENSE)
[](https://github.com/NickDJM/accessible-menu-bootstrap-4/actions/workflows/test.yml)
[](https://github.com/NickDJM/accessible-menu-bootstrap-4/actions/workflows/codeql-analysis.yml)
A JavaScript library to help you generate WAI-ARIA accessible menus with in the DOM using Bootstrap 4.
This project is an extension of [accessible-menu](https://github.com/NickDJM/accessible-menu) to allow out-of-the-box for Bootstrap 4 compatibility.
The supported menu types are:
- [Disclosure Navigation Menus](https://www.w3.org/WAI/ARIA/apg/patterns/disclosure/examples/disclosure-navigation/),
- [Navigation Menubar](https://www.w3.org/WAI/ARIA/apg/patterns/menubar/examples/menubar-navigation/), and
- [Navigation Treeview](https://www.w3.org/WAI/ARIA/apg/patterns/treeview/examples/treeview-navigation/)
## Browser Support
| 
Chrome | 
Firefox | 
Safari | 
Edge | 
Chromium | 
Webkit |
| --- | --- | --- | --- | --- | --- |
| last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
Found something that doesn't work the way it should in one of the listed browsers above? [Open an issue](https://github.com/NickDJM/accessible-menu-bootstrap-4/issues/new?assignees=&labels=bug&template=bug_report.md&title=Bug%3A+%5BBrief+Description%5D)!
## Installation
### NPM
NPM is recommended for large-scale development, since it works well with bundlers like [Webpack](https://webpack.js.org/) or [Rollup](https://rollupjs.org/guide/en/).
```shell
# latest stable
npm install accessible-menu-bootstrap-4
```
### CDN
For learning/prototyping purposes you can use the latest version with:
```html
```
For production environments, it is recommend to use a specific version to avoid unforseen breaking changes:
```html
```
## Usage
To use **accessible-menu-bootstrap-4**, you first need to make sure your menu matches the following structure:
```html
```
Include **accessible-menu-bootstrap-4** through import or bundled library in your project:
```js
import AccessibleMenu from "accessible-menu-bootstrap-4";
```
or
```html
```
Once you have **accessible-menu-bootstrap-4** loaded, declare a new menu object.
`menuElement` is required for all menus. Unlike accessible-menu, **accessible-menu-bootstrap-4** will automatically find dropdown menus since the classes `.dropdown`, `.dropdown-menu`, and `.dropdown-item` are included in the Bootstrap 4 framework.
```js
const menu = new AccessibleMenu.DisclosureMenu({
menuElement: document.querySelector("#example-menu"),
});
```
### Only need one type of menu class?
Bundled versions of each menu are provided in the dist and individual exports are provided in the index.
There are also compiled ES Module versions if you don't want to use an iife!
#### Bootstrap4DisclosureMenu usage
```js
import { Bootstrap4DisclosureMenu } from "accessible-menu-bootstrap-4";
```
or
```html
```
then
```js
const menu = new Bootstrap4DisclosureMenu({
menuElement: document.querySelector("#example-menu"),
});
```
#### Bootstrap4Menubar usage
```js
import { Bootstrap4Menubar } from "accessible-menu-bootstrap-4";
```
or
```html
```
then
```js
const menu = new Bootstrap4Menubar({
menuElement: document.querySelector("#example-menu"),
});
```
#### Bootstrap4Treeview usage
```js
import { Bootstrap4Treeview } from "accessible-menu-bootstrap-4";
```
or
```html
```
then
```js
const menu = new Bootstrap4Treeview({
menuElement: document.querySelector("#example-menu"),
});
```
### Documentation
- [accessible-menu API Documentation](https://accessible-menu.netlify.app/)
- Basics
- [Single-level menu](docs/basics/single-level-menu.md)
- [Single-level menu with toggle](docs/basics/single-level-menu-with-toggle.md)
- [Two-level menu with toggle](docs/basics/two-level-menu-with-toggle.md)
### Conflict with Bootstrap's own navbar toggle
Bootstrap 4 has it's own implementation of expanding/collapsing menus using the `data-toggle` attribute on navbar togglers and dropdown toggles which would cause both **accessible-menu-bootstrap-4** _and_ Bootstrap's own toggler to open/close menus at the same time. To resolve this issue, **accessible-menu-bootstrap-4** removed the `data-toggle` attributes from menu toggles that it controls.
### Other versions of Bootstrap
This project isn't designed to work with other versions of Bootstrap other than v4, however you _could_ probably get it to work with Bootstrap 3 by customizing the selectors and open/close classes when declaring the menu.
You also _might_ be able to get this to work with Bootstrap 5, however v5 changed the `data-toggle` value on dropdowns to `data-bs-toggle` which won't be handled by this project. A Bootstrap 5 specific project may be created if there is enough interest in it.
## 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](https://semver.org/).
## Contributing
If you're interested in contributing to the project, please read the [Contribution Guidelines](.github/CONTRIBUTING.md). Any and all contributions _must_ follow these guidelines or they will not be accepted.
## Sponsors
