Skip to content

Commit 89beb91

Browse files
add readme
1 parent 22b216f commit 89beb91

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# rmodal-component
2+
3+
<p>✔️ In desktop devices in modal and in mobile device is draggable drawer.</p>
4+
<p>✔️ In mobile device can close modal with dragging like instagram modals.</p>
5+
<p>✔️ Lock Body scroll when modal opened.</p>
6+
7+
8+
9+
[![NPM](https://img.shields.io/npm/v/rmodal-component.svg)](https://www.npmjs.com/package/rmodal-component) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
10+
11+
## Full Document
12+
- [Document](https://mostafarostami72.github.io/rmodal-component/)
13+
## Demo
14+
- [Demo](https://mostafarostami72.github.io/rmodal-component/)
15+
16+
## Install
17+
18+
```bash
19+
npm install --save rmodal-component
20+
```
21+
22+
## Usage
23+
24+
```jsx
25+
import React, {useState} from 'react';
26+
import Modal from 'rmodal-component';
27+
import 'rmodal-component/dist/index.css'
28+
29+
const Example = () => {
30+
const [show, setShow] = useState(false);
31+
32+
return (
33+
<div>
34+
<Modal show={show} onClose={() => setShow(false)} smModal={true} lockBodyScroll={true} modalTitle={"modal Title"}>
35+
...
36+
</Modal>
37+
</div>
38+
);
39+
};
40+
41+
export default Example;
42+
43+
```
44+
45+
## License
46+
47+
MIT © [MostafaRostami72](https://github.com/MostafaRostami72)

0 commit comments

Comments
 (0)