React Suite Grid Props

Last Updated : 25 Jul, 2022

React Suite is a popular front-end library with a set of React components that are designed for the middle platform and back-end products. The grid component allows the user to provide 24 grids. It helps in achieving response design. There are different props for react suite grid rows and columns for the user to design.

<Grid> Props:

as: It denotes the element type of the component. It is ‘div’ by default but one can custom the element for this component.
fluid: It is a boolean value. It defines the layout as covering 100% of the width of the parent component. It is true by default.

<Grid.Row> Props:

componentClass: It can be used for the custom element type for this component.
gutter: It is used to denote the spacing of the grids.

<Grid.Col> Props:

as: It denotes the element type of the component. It is ‘div’ by default but one can custom the element for this component.
xxl: It is used to denote the number of columns you wish to span for Extra Large devices Desktops having screen size ≥ 1400 pixels.
xl: It is used to denote the number of columns you wish to span for Extra Large devices Desktops having screen size ≥ 1200 pixels.
lg: It is used to denote the number of columns you wish to span for Large devices Desktops having screen size ≥ 992 pixels.
md: It is used to denote the number of columns you wish to span for Medium devices Desktops having screen size ≥ 768 pixels.
sm: It is used to denote the number of columns you wish to span for Small devices or Tablets having a screen size ≥ 576 pixels.
xs: It is used to denote the number of columns you wish to span for Extra small devices Phones having a screen size < 576 pixels.
xsHidden: It is used to hide the column on Extra small devices like Phones.
smHidden: It is used to hide the column on Small devices or Tablets.
mdHidden: It is used to hide the columns on Medium devices Desktops.
lgHidden, xlHidden, xxlHidden: It is used to hide the columns on Large devices like Desktops.
xsOffset: It is used to move the columns to the right for Extra small devices and Phones.
smOffset: It is used to move columns to the right for Small devices and Tablets.
mdOffset: It is used to move columns to the right for Medium devices Desktops.
lgOffset, xlOffset, xxlOffset: It is used to move columns to the right for Large devices like Desktops.
xsPull: It is used to change the order of grid columns to the left for Extra small devices Phones.
smPull: It is used to change the order of grid columns to the left for Small devices and Tablets.
mdPull: It is used to change the order of grid columns to the left for Medium devices Desktops.
lgPull, xlPull, xxlPull: It is used to change the order of grid columns to the left for Large devices Desktops.
xsPush: It is used to change the order of grid columns to the right for Extra small devices and Phones.
smPush: It is used to change the order of grid columns to the right for Small devices and Tablets.
mdPush: It is used to change the order of grid columns to the right for Medium devices Desktops.
lgPush, xlPush, xxlPush: It is used to change the order of grid columns to the right for Large devices Desktops.

Approach: Let us create a React project and install React Suite module. Then we will create a UI that will showcase React Suite Grid Props.

Creating React Project:

Step 1: To create a react app, you need to install react modules through npx command. "npx" is used instead of "npm" because you will be needing this command in your app's lifecycle only once.

npx create-react-app project_name

Step 2: After creating your react project, move into the folder to perform different operations.

cd project_name

Step 3: After creating the ReactJS application, Install the required module using the following command:

npm install rsuite

Project Structure: After running the commands mentioned in the above steps, if you open the project in an editor you can see a similar project structure as shown below. The new component user makes or the code changes, we will be performing will be done in the source folder.

Step to Run Application: Run the application using the following command from the root directory of the project:

npm start

Example 1: We are creating a UI that shows React Suite Grid props.

App.js

import React from 'react'
import '../node_modules/rsuite/dist/rsuite.min.css';
import { Grid, Row, Col } from 'rsuite';

export default function App() {
    return (
        <center>
            <div style={{ padding: 20 }}>
                <h2>GeeksforGeeks</h2>
                <h2 style={{ color: "green" }}>
                    React Suite Grid Props
                </h2>
                <br /><br />
                
                <Grid fluid>
                    <Row className="show-grid">
                        <Col style={{ backgroundColor: 'lightblue' }}
                            xs={6}>Size xs = 6
                        </Col>
                        <Col style={{ backgroundColor: 'lightgrey' }}
                            xs={6}>Size xs = 6
                        </Col>
                        <Col style={{ backgroundColor: 'lightgreen' }}
                            xs={12}>Size xs = 12
                        </Col>
                    </Row>
                    <br></br>
                    <Row className="show-grid">
                        <Col style={{ backgroundColor: 'lightgreen' }}
                            xs={8}>Size xs = 8
                        </Col>
                        <Col style={{ backgroundColor: 'lightblue' }}
                            xs={8}>Size xs = 8
                        </Col>
                        <Col style={{ backgroundColor: 'lightgrey' }}
                            xs={8}>Size xs = 8
                        </Col>
                    </Row>
                </Grid>
            </div>
        </center>
    );
}

Output: Now open your browser and go to http://localhost:3000/, you will see the following output:

Example 2: We are creating a UI that shows React Suite Grid props. It shows 3 different React Suite Grid Rows with its props.

App.js

import React from 'react'
import '../node_modules/rsuite/dist/rsuite.min.css';
import { Grid, Row, Col } from 'rsuite';

export default function App() {

    return (
        <div style={{
            margin: 100
        }}>
            <h4>React Suite Grid Row Props</h4> <br></br>
            <Grid fluid>
                <Row gutter={4}>
                    <p>Gutter spacing 4</p>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 1</div>
                    </Col>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 2</div>
                    </Col>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 3</div>
                    </Col>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 4</div>
                    </Col>
                </Row>
                <br /><br />
                <p>Gutter spacing 32</p>
                <Row gutter={32}>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 1</div>
                    </Col>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 2</div>
                    </Col>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 3</div>
                    </Col>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 4</div>
                    </Col>
                </Row>
                <br /><br />
                <p>Gutter spacing 64</p>
                <Row gutter={64}>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 1</div>
                    </Col>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 2</div>
                    </Col>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 3</div>
                    </Col>
                    <Col xs={4}>
                        <div style={{ backgroundColor: 'lightgreen' }}
                            className="show-col">Row 4</div>
                    </Col>
                </Row>
            </Grid>
        </div>
    );
}