![](\"https://www.dropbox.com/s/tbaooyi4yh8pbi7/logo.png?raw=1\"){kind=logo}
\n\n \n
\n \n ![\"Made](\"https://img.shields.io/badge/made%20with-love-E760A4.svg\"){kind=icon}
\n \n \n ![\"License\"](\"https://img.shields.io/badge/license-MIT-blue.svg\"){kind=icon}
\n \n \n ![\"Package](\"https://img.shields.io/npm/v/micromodal.svg\")
\n \n \n ![\"Build](\"https://api.travis-ci.org/ghosh/micromodal.svg\")
\n \n
\n Tiny, dependency-free javascript library for creating accessible modal dialogs\n
\n\n---\n\n![](\"https://www.dropbox.com/s/8g7fr091tk8o62j/micromodal.gif?raw=1\")
\n\nThe 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.\n\n**[Demo and documentation](https://micromodal.now.sh/)**\n\n \n\n## Features\n✔ Toggles relevant aria attributes on open and close\n\n✔ Closes modal on overlay click\n\n✔ Closes modal on pressing the `esc` key\n\n✔ Traps tab focus within the modal\n\n✔ Focuses on the first focusable element within the modal\n\n✔ Retains the focused element state after closing the modal\n\n \n\n## Installation\n\n**via npm**\n```shell\nnpm install micromodal --save\n```\n\n**via yarn**\n```shell\nyarn add micromodal\n```\n\n**via CDN direct link**\n```html\n\n\n\n```\n\n**direct download**\n```shell\ncurl -o https://unpkg.com/micromodal/dist/micromodal.min.js\n```\n\n \n\n## IE 11 and below\n\nPlease use this pollyfill suggested [here](https://github.com/ghosh/Micromodal/issues/49#issuecomment-424213347).\n\n \n\n## Changelog\n\nFind the latest changelog [here](https://github.com/ghosh/micromodal/blob/master/CHANGELOG.md).\n\n \n\n## Contributing\n\nWe 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.\n\nMicromodal follows the [standardjs](https://standardjs.com/) coding standard and is part of our `package.json` file. It will help us to maintain consistency in the code base.\n\n#### Development setup\n1. Clone Github repo `$ git clone https://github.com/ghosh/micromodal.git`\n2. Install `yarn` package manager (Read [installation guide](https://yarnpkg.com/en/docs/install#mac-tab))\n3. Run `yarn install` in the root folder to install all dependencies\n4. Run `yarn dev` to start a dev server. This serves the example directory and live reloads when any files are changed\n5. [Optional] Run `yarn build` to build the files for distribution. This is run automatically as a pre-commit hook as well.\n6. Send us pull request and chill\n\n \n\n## Licensing\nThis project is licensed under [MIT license](https://opensource.org/licenses/MIT).\n\n \n## Related\n- [Microtip](https://github.com/ghosh/microtip) - Modern, lightweight, accessible css tooltip library. Just 1kb.\n\n \n\n## Contact\nYou can mention us on Twitter for any questions, suggestions or just send us funny GIF. We ♥️ GIFs.\n\n#### Tweet some love\n[Tweet](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgoo.gl%2FsEgnBZ&text=Make%20your%20modal%20dialogs%20accessible%20to%20all%20using%20Micromodal.js%2C%20a%20tiny%20library%20for%20big%20change.&hashtags=a11y \"Tweet about Micromodal\") about Micromodal and help us to spread the message about the importance of Web accessibility and Inclusive design.\n\n \n\n## Created and maintained by\n\nIndrashish Ghosh – [@_ighosh](https://twitter.com/_ighosh) 🇮🇳\n\nKalpesh Singh - [@knowkalpesh](https://twitter.com/knowkalpesh) 🇮🇳\n\nDarpan Kakadia - [@kakadiadarpan](https://twitter.com/kakadiadarpan) 🇩🇪\n\nContributors - [list](https://github.com/ghosh/micromodal/graphs/contributors) 🌐\n","readmeFilename":"README.md"}