Skip to content

Commit de0b661

Browse files
committed
slightly less junky README
1 parent cde1572 commit de0b661

File tree

1 file changed

+15
-27
lines changed

1 file changed

+15
-27
lines changed

README.md

+15-27
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@ React Modal
44
Accessible React Modal Dialog Component. This isn't ready to be used
55
yet, still under development.
66

7+
Accessibility Notes
8+
-------------------
9+
10+
Etc. etc. etc.
11+
712
Usage
813
-----
914

1015
```xml
1116
<Modal
12-
isOpen={this.state.modalIsOpen}
13-
onRequestClose={this.handleModalCloseRequest}
14-
closeTimeoutMS={150}
17+
isOpen={bool}
18+
onRequestClose={fn}
19+
closeTimeoutMS={n}
1520
>
1621
<h1>Modal Content</h1>
1722
<p>Etc.</p>
1823
</Modal>
1924
```
2025

21-
Accessibility Notes
22-
-------------------
23-
24-
25-
26-
Inside the app:
26+
Inside an app:
2727

2828
```js
2929
/** @jsx React.DOM */
@@ -50,35 +50,23 @@ var App = React.createClass({
5050
this.setState({modalIsOpen: false});
5151
},
5252

53-
handleModalCloseRequest: function() {
54-
// opportunity to validate something and keep the modal open even if it
55-
// requested to be closed
56-
this.setState({modalIsOpen: false});
57-
},
58-
5953
render: function() {
6054
return (
6155
<div>
6256
<button onClick={this.openModal}>Open Modal</button>
6357
<Modal
64-
closeTimeoutMS={150}
6558
isOpen={this.state.modalIsOpen}
66-
onRequestClose={this.handleModalCloseRequest}
59+
onRequestClose={this.closeModal}
6760
>
68-
<h1>Hello</h1>
61+
<h2>Hello</h2>
6962
<button onClick={this.closeModal}>close</button>
7063
<div>I am a modal</div>
7164
<form>
7265
<input />
73-
<input />
74-
<input />
75-
<input />
76-
<input />
77-
<br/>
78-
<button>hi</button>
79-
<button>hi</button>
80-
<button>hi</button>
81-
<button>hi</button>
66+
<button>tab navigation</button>
67+
<button>stays</button>
68+
<button>inside</button>
69+
<button>the modal</button>
8270
</form>
8371
</Modal>
8472
</div>

0 commit comments

Comments
 (0)