Skip to content

Commit a2e5952

Browse files
linmicclaydiffrient
authored andcommitted
[docs] added required props info to README (#274)
1 parent f460c10 commit a2e5952

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Diff for: README.md

+7
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ npm install --save react-modal
1212

1313
## Usage
1414

15+
The Modal object has two required props:
16+
17+
- `isOpen` to render its children.
18+
- `contentLabel` to improve a11y, since `v1.6.0`.
19+
20+
Example:
21+
1522
```xml
1623
<Modal
1724
isOpen={bool}

0 commit comments

Comments
 (0)