@@ -14,7 +14,7 @@ Demo: https://trendmicro-frontend.github.io/react-grid-system
14
14
npm install --save react @trendmicro/react-grid-system
15
15
```
16
16
17
- 2 . Install [ react-grid-system] ( https://github.com/trendmicro-frontend/react-grid-system ) ` with <b >@trendmicro </b > scope:
17
+ 2 . Install [ react-grid-system] ( https://github.com/trendmicro-frontend/react-grid-system ) with <b >@trendmicro </b > scope:
18
18
19
19
``` js
20
20
import { Provider , Container , Row , Col } from ' @trendmicro/react-grid-system' ;
@@ -44,6 +44,54 @@ Demo: https://trendmicro-frontend.github.io/react-grid-system
44
44
45
45
### Properties
46
46
47
+ #### Provider
48
+
49
+ Name | Type | Default | Description
50
+ :--- | :--- | :------ | :----------
51
+ breakpoints | Number[ ] | [ 576, 768, 992, 1200, 1600] | The breakpoints (minimum width) of devices in screen class sm, md, lg, xl, and xxl.
52
+ containerWidths | Number[ ] | [ 540, 720, 960, 1140, 0] | The container widths in pixels of devices in screen class sm, md, lg, xl, and xxl.
53
+ columns | Number | 12 | The number of columns. Defaults to 12.
54
+ gutterWidth | Number | 30 | The horizontal padding (called gutter) between two columns. A gutter width of 30 means 15px on each side of a column.
55
+ layout | One of:<br >'float'<br >'flex' | 'float' | The grid system layout.
56
+
57
+ #### Container
58
+
59
+ Name | Type | Default | Description
60
+ :--- | :--- | :------ | :----------
61
+ fluid | Boolean | false | True makes the container full-width, false fixed-width.
62
+ xs | Boolean | false | True makes container fluid only in xs, not present means fluid everywhere.
63
+ sm | Boolean | false | True makes container fluid only in sm, not present means fluid everywhere.
64
+ md | Boolean | false | True makes container fluid only in md, not present means fluid everywhere.
65
+ lg | Boolean | false | True makes container fluid only in lg, not present means fluid everywhere.
66
+ xl | Boolean | false | True makes container fluid only in xl, not present means fluid everywhere.
67
+ xxl | Boolean | false | True makes container fluid only in xxl, not present means fluid everywhere.
68
+ gutterWidth | Number | 30 | The horizontal padding (called gutter) between two columns. A gutter width of 30 means 15px on each side of a column.
69
+ layout | One of:<br >'float'<br >'flex' | 'float' | The grid system layout.
70
+ onResize | Function({ screenClass }) | | A callback fired when the resize event occurs.
71
+
72
+ #### Row
73
+
74
+ Name | Type | Default | Description
75
+ :--- | :--- | :------ | :----------
76
+ gutterWidth | Number | 30 | The horizontal padding (called gutter) between two columns. A gutter width of 30 means 15px on each side of a column.
77
+ layout | One of:<br >'float'<br >'flex' | 'float' | The grid system layout.
78
+
79
+
80
+ #### Col
81
+
82
+ Name | Type | Default | Description
83
+ :--- | :--- | :------ | :----------
84
+ width | Number | | The width of the column for all screen classes.
85
+ xs | Boolean or Number | | The width of the column for screen class ` xs ` .
86
+ sm | Boolean or Number | | The width of the column for screen class ` sm ` .
87
+ md | Boolean or Number | | The width of the column for screen class ` md ` .
88
+ lg | Boolean or Number | | The width of the column for screen class ` lg ` .
89
+ xl | Boolean or Number | | The width of the column for screen class ` xl ` .
90
+ xxl | Boolean or Number | | The width of the column for screen class ` xxl ` .
91
+ offset | { xs, sm, md, lg, xl, xxl } | | The offset of this column for all screen classes.
92
+ pull | { xs, sm, md, lg, xl, xxl } | | The amount this column is pulled to the left for all screen classes.
93
+ push | { xs, sm, md, lg, xl, xxl } | | The amount this column is pushed to the right for all screen classes.
94
+
47
95
## License
48
96
49
97
MIT
0 commit comments