README

Micromodal.js

Tiny, dependency-free javascript library for creating accessible modal dialogs

The aim of this library is to make modal dialogs accessible and easy to include in your project with minimum configuration. It's only ~1.8kb minified and gzipped - A tiny library for big change.

Demo and documentation

Features

✔ Toggles relevant aria attributes on open and close

✔ Closes modal on overlay click

✔ Closes modal on pressing the esc key

✔ Traps tab focus within the modal

✔ Focuses on the first focusable element within the modal

✔ Retains the focused element state after closing the modal

Installation

via npm

npm install micromodal --save

via yarn

yarn add micromodal

via CDN direct link

<script src="https://cdn.jsdelivr.net/npm/micromodal/dist/micromodal.min.js"></script>
<!-- or -->
<script src="https://unpkg.com/micromodal/dist/micromodal.min.js"></script>

direct download

curl -O -L https://unpkg.com/micromodal/dist/micromodal.min.js

IE 11 and below

Please use this pollyfill suggested here.

Changelog

Find the latest changelog here.

Contributing

We are always open and invite developers to contribute to Micromodal. We have kept the guidelines and process dead simple, so you invest more time in making modals accessible to all.

Micromodal follows the standardjs coding standard and is part of our package.json file. It will help us to maintain consistency in the code base.

Development setup

1. Clone Github repo $ git clone https://github.com/ghosh/micromodal.git
2. Install yarn package manager (Read installation guide)
3. Run yarn install in the root folder to install all dependencies
4. Run yarn dev to start a dev server. This serves the example directory and live reloads when any files are changed
5. [Optional] Run yarn build to build the files for distribution. This is run automatically as a pre-commit hook as well.
6. Send us pull request and chill

Licensing

This project is licensed under MIT license.

Related

• Microtip - Modern, lightweight, accessible css tooltip library. Just 1kb.

Contact

You can mention us on Twitter for any questions, suggestions or just send us funny GIF. We ♥️ GIFs.

Tweet some love

Tweet about Micromodal and help us to spread the message about the importance of Web accessibility and Inclusive design.

Created and maintained by

Indrashish Ghosh – @_ighosh 🇮🇳

Kalpesh Singh - @knowkalpesh 🇮🇳

Darpan Kakadia - @kakadiadarpan 🇩🇪

Contributors - list 🌐