Skip to content

Commit 5d9db00

Browse files
committed
Document Grid, Row and Col properties
1 parent 7f3ec2d commit 5d9db00

3 files changed

Lines changed: 126 additions & 0 deletions

File tree

src/Col.js

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,137 @@ import CustomPropTypes from './utils/CustomPropTypes';
55

66
const Col = React.createClass({
77
propTypes: {
8+
/**
9+
* The number of columns you wish to span
10+
*
11+
* for Extra small devices Phones (<768px)
12+
*
13+
* class-prefix `col-xs-`
14+
*/
815
xs: React.PropTypes.number,
16+
/**
17+
* The number of columns you wish to span
18+
*
19+
* for Small devices Tablets (≥768px)
20+
*
21+
* class-prefix `col-sm-`
22+
*/
923
sm: React.PropTypes.number,
24+
/**
25+
* The number of columns you wish to span
26+
*
27+
* for Medium devices Desktops (≥992px)
28+
*
29+
* class-prefix `col-md-`
30+
*/
1031
md: React.PropTypes.number,
32+
/**
33+
* The number of columns you wish to span
34+
*
35+
* for Large devices Desktops (≥1200px)
36+
*
37+
* class-prefix `col-lg-`
38+
*/
1139
lg: React.PropTypes.number,
40+
/**
41+
* Move columns to the right
42+
*
43+
* for Extra small devices Phones
44+
*
45+
* class-prefix `col-xs-offset-`
46+
*/
1247
xsOffset: React.PropTypes.number,
48+
/**
49+
* Move columns to the right
50+
*
51+
* for Small devices Tablets
52+
*
53+
* class-prefix `col-sm-offset-`
54+
*/
1355
smOffset: React.PropTypes.number,
56+
/**
57+
* Move columns to the right
58+
*
59+
* for Medium devices Desktops
60+
*
61+
* class-prefix `col-md-offset-`
62+
*/
1463
mdOffset: React.PropTypes.number,
64+
/**
65+
* Move columns to the right
66+
*
67+
* for Large devices Desktops
68+
*
69+
* class-prefix `col-lg-offset-`
70+
*/
1571
lgOffset: React.PropTypes.number,
72+
/**
73+
* Change the order of grid columns to the right
74+
*
75+
* for Extra small devices Phones
76+
*
77+
* class-prefix `col-xs-push-`
78+
*/
1679
xsPush: React.PropTypes.number,
80+
/**
81+
* Change the order of grid columns to the right
82+
*
83+
* for Small devices Tablets
84+
*
85+
* class-prefix `col-sm-push-`
86+
*/
1787
smPush: React.PropTypes.number,
88+
/**
89+
* Change the order of grid columns to the right
90+
*
91+
* for Medium devices Desktops
92+
*
93+
* class-prefix `col-md-push-`
94+
*/
1895
mdPush: React.PropTypes.number,
96+
/**
97+
* Change the order of grid columns to the right
98+
*
99+
* for Large devices Desktops
100+
*
101+
* class-prefix `col-lg-push-`
102+
*/
19103
lgPush: React.PropTypes.number,
104+
/**
105+
* Change the order of grid columns to the left
106+
*
107+
* for Extra small devices Phones
108+
*
109+
* class-prefix `col-xs-pull-`
110+
*/
20111
xsPull: React.PropTypes.number,
112+
/**
113+
* Change the order of grid columns to the left
114+
*
115+
* for Small devices Tablets
116+
*
117+
* class-prefix `col-sm-pull-`
118+
*/
21119
smPull: React.PropTypes.number,
120+
/**
121+
* Change the order of grid columns to the left
122+
*
123+
* for Medium devices Desktops
124+
*
125+
* class-prefix `col-md-pull-`
126+
*/
22127
mdPull: React.PropTypes.number,
128+
/**
129+
* Change the order of grid columns to the left
130+
*
131+
* for Large devices Desktops
132+
*
133+
* class-prefix `col-lg-pull-`
134+
*/
23135
lgPull: React.PropTypes.number,
136+
/**
137+
* You can use a custom element for this component
138+
*/
24139
componentClass: CustomPropTypes.elementType
25140
},
26141

src/Grid.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,15 @@ import CustomPropTypes from './utils/CustomPropTypes';
44

55
const Grid = React.createClass({
66
propTypes: {
7+
/**
8+
* Turn any fixed-width grid layout into a full-width layout by this property.
9+
*
10+
* Adds `container-fluid` class.
11+
*/
712
fluid: React.PropTypes.bool,
13+
/**
14+
* You can use a custom element for this component
15+
*/
816
componentClass: CustomPropTypes.elementType
917
},
1018

src/Row.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ import CustomPropTypes from './utils/CustomPropTypes';
44

55
const Row = React.createClass({
66
propTypes: {
7+
/**
8+
* You can use a custom element for this component
9+
*/
710
componentClass: CustomPropTypes.elementType
811
},
912

0 commit comments

Comments
 (0)