# react-dev-comps.modal

> React Modal Component for Accessible Rich Internet Applications.

Latest version **0.0.2** (published 2019-05-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-dev-comps.modal
pnpm add react-dev-comps.modal
yarn add react-dev-comps.modal
bun add react-dev-comps.modal
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2019-05-28 |
| First published | 2019-05-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 20.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ali sait bilgi |
| Maintainers | alisait |

## Links

- npm: https://www.npmjs.com/package/react-dev-comps.modal
- Repository: https://github.com/alisaitbilgi/react-dev-comps.modal
- Homepage: https://github.com/alisaitbilgi/react-dev-comps.modal#readme
- Issues: https://github.com/alisaitbilgi/react-dev-comps.modal/issues
- npm.io page: https://npm.io/package/react-dev-comps.modal

## Dependencies (2)

- [react](https://npm.io/package/react.md) ^16.7.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.7.0

## Recent versions

- 0.0.2 (latest) — 2019-05-28
- 0.0.1 — 2019-05-27

## README

<p align="center" style="font-size: 1.2rem; margin-bottom: 30px;">
    React Modal Component for Accessible Rich Internet Applications.
</p>

# Installation

```sh
npm install react-dev-comps.modal --save
```

# Usage

You can use **Modal** component with 3 *required* props.

Other than that, you can customize and extend almost anything that **Modal** component provides. 
Please check [API](#API) section.

1) **Modal** component has 2 required props:
    * **isOpen**: A *boolean* that is used to track open state of the modal.
    * **onExit**: A *callback* that will be called on any user action causing a **Modal** closed
    according to ARIA standarts.

    ```js
    import Modal from 'react-dev-comps.modal';  
  
    import * as React from 'react';
    import Modal from 'react-dev-comps.modal';
    
    interface Prop {}
    interface State { isModalOpen: boolean; }
    
    class MyComponent extends React.Component<Prop, State> {
      constructor(props: Prop) {
        super(props);
        this.state = { isModalOpen: false };
      }
    
      toggleModal(isModalOpen: boolean) {
        return () => {
          this.setState({ isModalOpen });
        };
      }
    
      render() {
        const { isModalOpen } = this.state;
    
        return (
          <div className="body-container">
            <button onClick={this.toggleModal(true)}>
             {'Open Modal'}         
            </button>
            <Modal
              isOpen={isModalOpen}
              onExit={this.toggleModal(false)}
            >
              <div className="modal-content">
                {/* You can  create your modal content here.*/}
              </div>
            </Modal>
          </div>
        );
      }
    
    }
    
    export default MyComponent;

    ```
# API

`react-dev-comps.modal` exposes a React Component which takes the following props:

* `isOpen`: A *boolean* that is used to track open state of the **Modal**.

* `onExit`: A *callback* that will be called on any user action causing a **Modal** closed
                according to ARIA standarts.

* `children`: A *React Child Component* that will create the **Modal** content.

* `preventDefaultStyles`: A *boolean* determines the default style usage. Defaults to **false**.

* `preventOutsideClickExits`: A *boolean* determines the default closing behaviour of **Modal** component.
Defaults to **false**.

* `className`: A *string* that will be added as a class name to the parent element.

* `title`: A *string* that can be used as default header component's title text.

* `headerComp`: A *React Child Component* that can be used to override default header component of **Modal**.

* `footerComp`: A *React Child Component* that can be used to have a custom footer component of **Modal**.


# License

Licensed under the MIT License, Copyright © 2019-present.

See [LICENSE](./LICENSE) for more information.

---
_Source: https://npm.io/package/react-dev-comps.modal · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._