Skip to content

Commit e26ba25

Browse files
committed
Include CSS installation notes
1 parent cd92b5d commit e26ba25

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
1111
![Demo](demo.gif)
1212

13-
## Installation
13+
## Usage
14+
15+
### Installation
1416

1517
The easiest way to use react-checkbox-tree is to install using your favorite dependency manager and include it in your own React build process (e.g. using [Webpack](http://webpack.github.io/docs/what-is-webpack.html)):
1618

@@ -24,7 +26,23 @@ yarn add react-checkbox-tree
2426

2527
> **Note** – This library makes use of [Font Awesome](http://fontawesome.io/) styles and expects them to be loaded in the browser.
2628
27-
## Usage
29+
30+
### Include CSS
31+
32+
For your convenience, the library's styles can be consumed utilizing one of the following files:
33+
34+
* `node_modules/react-checkbox-tree/lib/react-checkbox-tree.css`
35+
* `node_modules/react-checkbox-tree/src/less/react-checkbox-tree.less`
36+
* `node_modules/react-checkbox-tree/src/sass/react-checkbox-tree.scss`
37+
38+
Either include one of these files in your stylesheets or utilize a CSS loader:
39+
40+
``` javascript
41+
import 'react-checkbox-tree/lib/react-checkbox-tree.css';
42+
```
43+
44+
45+
### Render Component
2846

2947
A quick usage example is included below. Note that the react-checkbox-tree component is [controlled](https://facebook.github.io/react/docs/forms.html#controlled-components). In other words, it is stateless. You must update its `checked` and `expanded` properties whenever a change occurs.
3048

0 commit comments

Comments
 (0)