Skip to content

Commit 764cc6e

Browse files
committed
Using table example instead of car.
1 parent 9cad95b commit 764cc6e

File tree

1 file changed

+35
-25
lines changed

1 file changed

+35
-25
lines changed

README.md

Lines changed: 35 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,15 @@ In the context of React, CSS Modules look like this:
3535

3636
```js
3737
import React from 'react';
38-
import styles from './car.css';
38+
import styles from './table.css';
3939

40-
export default class Car extends React.Component {
40+
export default class Table extends React.Component {
4141
render () {
42-
return <div className={styles.car}>
43-
<div className={styles.frontDoor}></div>
44-
<div className={styles.backDoor}></div>
42+
return <div className={styles.table}>
43+
<div className={styles.row}>
44+
<div className={styles.cell}>A0</div>
45+
<div className={styles.cell}>B0</div>
46+
</div>
4547
</div>;
4648
}
4749
}
@@ -50,9 +52,11 @@ export default class Car extends React.Component {
5052
Rendering the component will produce a markup similar to:
5153

5254
```js
53-
<div class="car__car___32osj">
54-
<div class="car__front-door___2w27N">front-door</div>
55-
<div class="car__back-door___1oVw5">back-door</div>
55+
<div class="table__table___32osj">
56+
<div class="table__row___2w27N">
57+
<div class="table__cell___2w27N">A0</div>
58+
<div class="table__cell___1oVw5">B0</div>
59+
</div>
5660
</div>
5761
```
5862

@@ -77,19 +81,21 @@ React CSS Modules component automates loading of CSS Modules using `styleName` p
7781

7882
```js
7983
import React from 'react';
80-
import styles from './car.css';
8184
import CSSModules from 'react-css-modules';
85+
import styles from './table.css';
8286

83-
class Car extends React.Component {
87+
class Table extends React.Component {
8488
render () {
85-
return <div styleName='car'>
86-
<div styleName='front-door'></div>
87-
<div styleName='back-door'></div>
89+
return <div styleName='table'>
90+
<div styleName='row'>
91+
<div styleName='cell'>A0</div>
92+
<div styleName='cell'>B0</div>
93+
</div>
8894
</div>;
8995
}
9096
}
9197

92-
export default CSSModules(Car, styles);
98+
export default CSSModules(Table, styles);
9399
```
94100

95101
Using `react-css-modules`:
@@ -159,7 +165,7 @@ Refer to [`css-modulesify`](https://github.com/css-modules/css-modulesify).
159165

160166
/**
161167
* @param {Function} Component
162-
* @param {Object} styles CSS Modules class map.
168+
* @param {Object} defaultStyles CSS Modules class map.
163169
* @param {CSSModules~Options} options
164170
* @return {Function}
165171
*/
@@ -169,19 +175,21 @@ You need to decorate your component using `react-css-modules`, e.g.
169175

170176
```js
171177
import React from 'react';
172-
import styles from './car.css';
173178
import CSSModules from 'react-css-modules';
179+
import styles from './table.css';
174180

175-
class Car extends React.Component {
181+
class Table extends React.Component {
176182
render () {
177-
return <div styleName='car'>
178-
<div styleName='front-door'></div>
179-
<div styleName='back-door'></div>
183+
return <div styleName='table'>
184+
<div styleName='row'>
185+
<div styleName='cell'>A0</div>
186+
<div styleName='cell'>B0</div>
187+
</div>
180188
</div>;
181189
}
182190
}
183191

184-
export default CSSModules(Car, styles);
192+
export default CSSModules(Table, styles);
185193
```
186194

187195
Thats it!
@@ -190,15 +198,17 @@ As the name implies, `react-css-modules` is compatible with the [ES7 decorators]
190198

191199
```js
192200
import React from 'react';
193-
import styles from './car.css';
194201
import CSSModules from 'react-css-modules';
202+
import styles from './table.css';
195203

196204
@CSSModules(styles)
197205
export default class extends React.Component {
198206
render () {
199-
return <div styleName='car'>
200-
<div styleName='front-door'>front-door</div>
201-
<div styleName='back-door'>back-door</div>
207+
return <div styleName='table'>
208+
<div styleName='row'>
209+
<div styleName='cell'>A0</div>
210+
<div styleName='cell'>B0</div>
211+
</div>
202212
</div>;
203213
}
204214
}

0 commit comments

Comments
 (0)