Grid API

API reference docs for the React Grid component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

import Grid from '@mui/system/Grid';
// or
import { Grid } from '@mui/system';

Props of the native component are also available.

Name	Type	Description
children	node	The content of the component.
columns	Array<number> \| number \| object	The number of columns.
columnSpacing	Array<number \| string> \| number \| object \| string	Defines the horizontal space between the type `item` components. It overrides the value of the `spacing` prop.
container	bool	If `true`, the component will have the flex container behavior. You should be wrapping items with a container.
direction	'column-reverse' \| 'column' \| 'row-reverse' \| 'row' \| Array<'column-reverse' \| 'column' \| 'row-reverse' \| 'row'> \| object	Defines the `flex-direction` style property. It is applied for all screen sizes.
offset	string \| number \| Array<string \| number> \| object	Defines the offset value for the type `item` components.
rowSpacing	Array<number \| string> \| number \| object \| string	Defines the vertical space between the type `item` components. It overrides the value of the `spacing` prop.
size	string \| bool \| number \| Array<string \| bool \| number> \| object	Defines the size of the the type `item` components.
spacing	Array<number \| string> \| number \| object \| string	Defines the space between the type `item` components. It can only be used on a type `container` component.
wrap	'nowrap' \| 'wrap-reverse' \| 'wrap'	Defines the `flex-wrap` style property. It's applied for all screen sizes.

As a CSS utility, the Grid component also supports all system properties. You can use them as props directly on the component.

The ref is forwarded to the root element.

You can use MuiGrid to change the default props of this component with the theme.

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiGrid-container	container	Styles applied to the root element if `container={true}`.
.MuiGrid-direction-xs-column	direction-xs-column	Styles applied to the root element if `direction="column"`.
.MuiGrid-direction-xs-column-reverse	direction-xs-column-reverse	Styles applied to the root element if `direction="column-reverse"`.
.MuiGrid-direction-xs-row-reverse	direction-xs-row-reverse	Styles applied to the root element if `direction="row-reverse"`.
.MuiGrid-root	root	Styles applied to the root element.
.MuiGrid-wrap-xs-nowrap	wrap-xs-nowrap	Styles applied to the root element if `wrap="nowrap"`.
.MuiGrid-wrap-xs-wrap-reverse	wrap-xs-wrap-reverse	Styles applied to the root element if `wrap="reverse"`.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.