Merge pull request react-bootstrap#947 from AlexKVal/gridDocs

Document Grid, Row and Col properties
spindlegame · Jul 10, 2015 · 31dac7f · 31dac7f
2 parents e8e9f5a + 5d9db00
commit 31dac7f
Show file tree

Hide file tree

Showing 3 changed files with 126 additions and 0 deletions.
diff --git a/src/Col.js b/src/Col.js
@@ -5,22 +5,137 @@ import CustomPropTypes from './utils/CustomPropTypes';
 
 const Col = React.createClass({
   propTypes: {
+    /**
+     * The number of columns you wish to span
+     *
+     * for Extra small devices Phones (<768px)
+     *
+     * class-prefix `col-xs-`
+     */
     xs: React.PropTypes.number,
+    /**
+     * The number of columns you wish to span
+     *
+     * for Small devices Tablets (≥768px)
+     *
+     * class-prefix `col-sm-`
+     */
     sm: React.PropTypes.number,
+    /**
+     * The number of columns you wish to span
+     *
+     * for Medium devices Desktops (≥992px)
+     *
+     * class-prefix `col-md-`
+     */
     md: React.PropTypes.number,
+    /**
+     * The number of columns you wish to span
+     *
+     * for Large devices Desktops (≥1200px)
+     *
+     * class-prefix `col-lg-`
+     */
     lg: React.PropTypes.number,
+    /**
+     * Move columns to the right
+     *
+     * for Extra small devices Phones
+     *
+     * class-prefix `col-xs-offset-`
+     */
     xsOffset: React.PropTypes.number,
+    /**
+     * Move columns to the right
+     *
+     * for Small devices Tablets
+     *
+     * class-prefix `col-sm-offset-`
+     */
     smOffset: React.PropTypes.number,
+    /**
+     * Move columns to the right
+     *
+     * for Medium devices Desktops
+     *
+     * class-prefix `col-md-offset-`
+     */
     mdOffset: React.PropTypes.number,
+    /**
+     * Move columns to the right
+     *
+     * for Large devices Desktops
+     *
+     * class-prefix `col-lg-offset-`
+     */
     lgOffset: React.PropTypes.number,
+    /**
+     * Change the order of grid columns to the right
+     *
+     * for Extra small devices Phones
+     *
+     * class-prefix `col-xs-push-`
+     */
     xsPush: React.PropTypes.number,
+    /**
+     * Change the order of grid columns to the right
+     *
+     * for Small devices Tablets
+     *
+     * class-prefix `col-sm-push-`
+     */
     smPush: React.PropTypes.number,
+    /**
+     * Change the order of grid columns to the right
+     *
+     * for Medium devices Desktops
+     *
+     * class-prefix `col-md-push-`
+     */
     mdPush: React.PropTypes.number,
+    /**
+     * Change the order of grid columns to the right
+     *
+     * for Large devices Desktops
+     *
+     * class-prefix `col-lg-push-`
+     */
     lgPush: React.PropTypes.number,
+    /**
+     * Change the order of grid columns to the left
+     *
+     * for Extra small devices Phones
+     *
+     * class-prefix `col-xs-pull-`
+     */
     xsPull: React.PropTypes.number,
+    /**
+     * Change the order of grid columns to the left
+     *
+     * for Small devices Tablets
+     *
+     * class-prefix `col-sm-pull-`
+     */
     smPull: React.PropTypes.number,
+    /**
+     * Change the order of grid columns to the left
+     *
+     * for Medium devices Desktops
+     *
+     * class-prefix `col-md-pull-`
+     */
     mdPull: React.PropTypes.number,
+    /**
+     * Change the order of grid columns to the left
+     *
+     * for Large devices Desktops
+     *
+     * class-prefix `col-lg-pull-`
+     */
     lgPull: React.PropTypes.number,
+    /**
+     * You can use a custom element for this component
+     */
     componentClass: CustomPropTypes.elementType
   },
 

diff --git a/src/Grid.js b/src/Grid.js
@@ -4,7 +4,15 @@ import CustomPropTypes from './utils/CustomPropTypes';
 
 const Grid = React.createClass({
   propTypes: {
+    /**
+     * Turn any fixed-width grid layout into a full-width layout by this property.
+     *
+     * Adds `container-fluid` class.
+     */
     fluid: React.PropTypes.bool,
+    /**
+     * You can use a custom element for this component
+     */
     componentClass: CustomPropTypes.elementType
   },
 

diff --git a/src/Row.js b/src/Row.js
@@ -4,6 +4,9 @@ import CustomPropTypes from './utils/CustomPropTypes';
 
 const Row = React.createClass({
   propTypes: {
+    /**
+     * You can use a custom element for this component
+     */
     componentClass: CustomPropTypes.elementType
   },