https://github.com/meemaw/react-micro-modal

Accessible, lightweight and configurable modal component with a11y-enabled.
https://github.com/meemaw/react-micro-modal

accessibility frontend javascript micro modal react typescript

Last synced: 1 day ago
JSON representation

Accessible, lightweight and configurable modal component with a11y-enabled.

• Host: GitHub
• URL: https://github.com/meemaw/react-micro-modal
• Owner: Meemaw
• License: mit
• Created: 2019-04-01T13:48:09.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-21T08:15:21.000Z (5 days ago)
• Last Synced: 2024-12-21T09:20:26.202Z (5 days ago)
• Topics: accessibility, frontend, javascript, micro, modal, react, typescript
• Language: TypeScript
• Homepage: https://meemaw.github.io/react-micro-modal
• Size: 3.72 MB
• Stars: 36
• Watchers: 3
• Forks: 1
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-micro-modal

[![npm](https://img.shields.io/npm/v/react-micro-modal.svg)](https://www.npmjs.com/package/react-micro-modal) [![](https://badgen.net/bundlephobia/minzip/react-micro-modal)](https://bundlephobia.com/result?p=react-micro-modal) ![CI](https://github.com/Meemaw/react-micro-modal/workflows/CI/badge.svg) [![codecov](https://codecov.io/gh/Meemaw/react-micro-modal/branch/master/graph/badge.svg?token=xdrppK2PPf)](https://codecov.io/gh/Meemaw/react-micro-modal) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

_Accessible, lightweight and configurable modal component with a11y-enabled inspired by [Micromodal.js](https://github.com/Ghosh/micromodal)._

### [Release notes](https://github.com/Meemaw/react-micro-modal/releases) | [Documentation](https://github.com/Meemaw/react-micro-modal/tree/master/docs)

---

- NPM: `npm install react-micro-modal`

- Yarn: `yarn add react-micro-modal`

---

## Features

- Micro bundle - 1.9 KB 📦

- a11y friendly 👓

- Supports nested modals

- Focuses on the first focusable element within the modal

- Traps focus inside the modal

- Closes on document click

- Closes on `Escape` keypress

- Usage as controlled or uncontrolled component

## Example

Here is a minimal uncontrolled modal example in 3 lines of code.

```tsx

import React from 'react';

import { render } from 'react-dom';

import MicroModal from 'react-micro-modal';

const App = () => {

  return (

     
Open!
}>

      {(close) => Close!}

    

  );

};


render(, document.getElementById('root'));

```

## Live Playground

For more examples of micro-modal in action, go to https://meemaw.github.io/react-micro-modal.

OR

To run that demo on your own computer:

- Clone this repository

- `yarn install`

- `yarn storybook`

- Visit http://localhost:9001/