https://github.com/KittyGiraudel/a11y-dialog

A very lightweight and flexible accessible modal dialog script.
https://github.com/KittyGiraudel/a11y-dialog

a11y accessibility dialog modal

Last synced: 5 days ago
JSON representation

A very lightweight and flexible accessible modal dialog script.

• Host: GitHub
• URL: https://github.com/KittyGiraudel/a11y-dialog
• Owner: KittyGiraudel
• License: mit
• Created: 2016-02-11T11:01:11.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T13:19:25.000Z (11 days ago)
• Last Synced: 2024-10-29T14:04:49.534Z (10 days ago)
• Topics: a11y, accessibility, dialog, modal
• Language: TypeScript
• Homepage: https://a11y-dialog.netlify.app
• Size: 6.23 MB
• Stars: 2,417
• Watchers: 31
• Forks: 131
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-starred - KittyGiraudel/a11y-dialog - A very lightweight and flexible accessible modal dialog script. (others)

README

        
# [A11y Dialog](https://a11y-dialog.netlify.app)

This is a lightweight (1.7Kb) yet flexible script to create accessible dialog windows.

- [Documentation ↗](https://a11y-dialog.netlify.app)

- [Demo on CodeSandbox ↗](https://codesandbox.io/s/a11y-dialog-v8-5gqfz8)

## Features

- Follows the [Dialog (Modal) pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialogmodal/) from the ARIA Authoring Practices Guide (APG)

- Supports [alert dialogs](https://w3c.github.io/aria/#alertdialog) as per the WAI-ARIA specifications

- Supports nested dialogs (however questionable)

- Exposes events to react to changes

- Provides both a DOM and a JavaScript API

- Plays nicely with Shadow DOM and web components

- Is unopinionated with styling

- Is extensively tested and documented

- Is fast and tiny

## Contributing

Contributing guidelines can be found in [CONTRIBUTING.md](https://github.com/KittyGiraudel/a11y-dialog/blob/main/CONTRIBUTING.md)