Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nickdjm/accessible-menu

A JavaScript library to help you generate WAI-ARIA accessible menus in the DOM.
https://github.com/nickdjm/accessible-menu

accessibility aria disclosure-menu hoverable hoverable-dropdown javascript menu menubar navigation treeview wcag

Last synced: 20 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/nickdjm/accessible-menu
Owner: NickDJM
License: isc
Created: 2019-11-16T22:57:05.000Z (almost 5 years ago)
Default Branch: 4.x
Last Pushed: 2024-09-27T18:45:55.000Z (about 2 months ago)
Last Synced: 2024-10-26T13:27:05.393Z (20 days ago)
Topics: accessibility, aria, disclosure-menu, hoverable, hoverable-dropdown, javascript, menu, menubar, navigation, treeview, wcag
Language: JavaScript
Homepage:
Size: 3.41 MB
Stars: 38
Watchers: 5
Forks: 8
Open Issues: 11
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
- Support: docs/supported-menus.md

Awesome Lists containing this project

README

        # accessible-menu

[![Latest release](https://img.shields.io/npm/v/accessible-menu?label=RELEASE&style=for-the-badge)](https://www.npmjs.com/package/accessible-menu)

[![License](https://img.shields.io/github/license/NickDJM/accessible-menu?style=for-the-badge)](/LICENSE)

[![Tests](https://img.shields.io/github/actions/workflow/status/nickdjm/accessible-menu/test.yml?branch=4.x&label=Tests&style=for-the-badge)](https://github.com/NickDJM/accessible-menu/actions/workflows/test.yml)

[![GitHub CodeQL](https://img.shields.io/github/actions/workflow/status/nickdjm/accessible-menu/codeql-analysis.yml?branch=4.x&label=CodeQL&style=for-the-badge)](https://github.com/NickDJM/accessible-menu/actions/workflows/codeql-analysis.yml)

A JavaScript library to help you effortlessly create WCAG-compliant menus in the DOM.

The supported menu types are:

- [Disclosure Navigation Menus](https://www.w3.org/WAI/ARIA/apg/patterns/disclosure/examples/disclosure-navigation/),

- [Disclosure Navigation Menus with Top-Level Links](https://www.w3.org/WAI/ARIA/apg/patterns/disclosure/examples/disclosure-navigation-hybrid/),

- [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/)

## Getting Started

Please follow the [documentation](https://accessible-menu.dev/).

## Examples

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

- [Disclosure Navigation Menu](https://codepen.io/nickdjm/pen/NWmWMea)

- [Disclosure Navigation Menu with Top-Level Links](https://codepen.io/nickdjm/pen/xxJNzVR)

- [Navigation Menubar](https://codepen.io/nickdjm/pen/wvZvXvP)

- [Navigation Treeview](https://codepen.io/nickdjm/pen/KKYKewB)

## 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](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.