Skip to content

Commit 7d20a59

Browse files
committed
Improving usage instructions, closes JedWatson#69
1 parent 2738964 commit 7d20a59

File tree

1 file changed

+28
-10
lines changed

1 file changed

+28
-10
lines changed

README.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,37 +27,55 @@ You can also use the standalone build by including `dist/react-codemirror.js` in
2727
npm install react-codemirror --save
2828
```
2929

30-
Ensure that ``codemirror.css`` is loaded. It can be included in your module css as shown in [example.less](example/src/example.less) or linked explicitly in your index.html file e.g ``<link href="css/codemirror.css" rel="stylesheet">``.
31-
3230

3331
## Usage
3432

33+
Require the CodeMirror component and render it with JSX:
34+
3535
```javascript
3636
var React = require('react');
37-
var Codemirror = require('react-codemirror');
37+
var CodeMirror = require('react-codemirror');
3838

3939
var App = React.createClass({
4040
getInitialState: function() {
4141
return {
42-
code: "// Code"
42+
code: "// Code",
4343
};
4444
},
4545
updateCode: function(newCode) {
4646
this.setState({
47-
code: newCode
47+
code: newCode,
4848
});
4949
},
5050
render: function() {
5151
var options = {
52-
lineNumbers: true
52+
lineNumbers: true,
5353
};
54-
return <Codemirror value={this.state.code} onChange={this.updateCode} options={options} />
54+
return <CodeMirror value={this.state.code} onChange={this.updateCode} options={options} />
5555
}
5656
});
5757

5858
React.render(<App />, document.getElementById('app'));
5959
```
6060

61+
### Include the CSS
62+
63+
Ensure that CodeMirror's stylesheet `codemirror.css` is loaded.
64+
65+
If you're using LESS (similar for Sass) you can import the css directly from the codemirror package, as shown in [example.less](example/src/example.less):
66+
67+
```less
68+
@import (inline) "./node_modules/codemirror/lib/codemirror.css";
69+
```
70+
71+
If you're using Webpack with the css loader, you can require the codemirror css in your application instead:
72+
73+
```js
74+
require('codemirror/lib/codemirror.css');
75+
```
76+
77+
Alternatively, you can explicitly link the `codemirror.css` file from the CodeMirror project in your index.html file, e.g `<link href="css/codemirror.css" rel="stylesheet">`.
78+
6179
### Methods
6280

6381
* `focus` focuses the CodeMirror instance
@@ -88,13 +106,13 @@ By default (to optimise bundle size) all modes are not included. To enable synta
88106

89107
```js
90108
var React = require('react');
91-
var Codemirror = require('react-codemirror');
109+
var CodeMirror = require('react-codemirror');
92110
require('codemirror/mode/javascript/javascript');
93111
require('codemirror/mode/xml/xml');
94112
require('codemirror/mode/markdown/markdown');
95113

96-
<Codemirror ... options={{
97-
mode: 'javascript'
114+
<CodeMirror ... options={{
115+
mode: 'javascript',
98116
}} />
99117
```
100118

0 commit comments

Comments
 (0)