Skip to content
Influence Material UI's 2024 roadmap! Participate in the latest Developer Survey

Grid API

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

Demos

Import

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

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode-

The content of the component.

classesobject-

See CSS classes API below for more details.

columnsArray<number>
| number
| object		12

The number of columns.

columnSpacingArray<number
| string>
| number
| object
| string		-

Defines the horizontal space between the type item components. It overrides the value of the spacing prop.

componentelementType-
containerboolfalse

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		'row'

Defines the flex-direction style property. It is applied for all screen sizes.

itemboolfalse
lg'auto'
| number
| bool		false

If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the lg breakpoint and wider screens if not overridden.

md'auto'
| number
| bool		false

If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the md breakpoint and wider screens if not overridden.

rowSpacingArray<number
| string>
| number
| object
| string		-

Defines the vertical space between the type item components. It overrides the value of the spacing prop.

sm'auto'
| number
| bool		false

If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the sm breakpoint and wider screens if not overridden.

spacingArray<number
| string>
| number
| object
| string		0

Defines the space between the type item components. It can only be used on a type container component.

sxArray<func
| object
| bool>
| func
| object		-

See the `sx` page for more details.

wrap'nowrap'
| 'wrap-reverse'
| 'wrap'		'wrap'

Defines the flex-wrap style property. It's applied for all screen sizes.

xl'auto'
| number
| bool		false

If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the xl breakpoint and wider screens if not overridden.

xs'auto'
| number
| bool		false

If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for all the screen sizes with the lowest priority.

zeroMinWidthboolfalse
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.

Theme default props

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

CSS classes

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

Class nameRule nameDescription
.MuiGrid-containercontainerStyles applied to the root element if container={true}.
.MuiGrid-direction-xs-columndirection-xs-columnStyles applied to the root element if direction="column".
.MuiGrid-direction-xs-column-reversedirection-xs-column-reverseStyles applied to the root element if direction="column-reverse".
.MuiGrid-direction-xs-row-reversedirection-xs-row-reverseStyles applied to the root element if direction="row-reverse".
.MuiGrid-grid-xs-1grid-xs-1
.MuiGrid-grid-xs-10grid-xs-10
.MuiGrid-grid-xs-11grid-xs-11
.MuiGrid-grid-xs-12grid-xs-12
.MuiGrid-grid-xs-2grid-xs-2
.MuiGrid-grid-xs-3grid-xs-3
.MuiGrid-grid-xs-4grid-xs-4
.MuiGrid-grid-xs-5grid-xs-5
.MuiGrid-grid-xs-6grid-xs-6
.MuiGrid-grid-xs-7grid-xs-7
.MuiGrid-grid-xs-8grid-xs-8
.MuiGrid-grid-xs-9grid-xs-9
.MuiGrid-grid-xs-autogrid-xs-auto
.MuiGrid-grid-xs-truegrid-xs-true
.MuiGrid-itemitemStyles applied to the root element if `item={true}`.
.MuiGrid-rootrootStyles applied to the root element.
.MuiGrid-spacing-xs-1spacing-xs-1
.MuiGrid-spacing-xs-10spacing-xs-10
.MuiGrid-spacing-xs-2spacing-xs-2
.MuiGrid-spacing-xs-3spacing-xs-3
.MuiGrid-spacing-xs-4spacing-xs-4
.MuiGrid-spacing-xs-5spacing-xs-5
.MuiGrid-spacing-xs-6spacing-xs-6
.MuiGrid-spacing-xs-7spacing-xs-7
.MuiGrid-spacing-xs-8spacing-xs-8
.MuiGrid-spacing-xs-9spacing-xs-9
.MuiGrid-wrap-xs-nowrapwrap-xs-nowrapStyles applied to the root element if wrap="nowrap".
.MuiGrid-wrap-xs-wrap-reversewrap-xs-wrap-reverseStyles applied to the root element if wrap="reverse".
.MuiGrid-zeroMinWidthzeroMinWidthStyles applied to the root element if `zeroMinWidth={true}`.

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