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:

Grid

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.

children

The content of the component.

Type:

node

classes

See CSS API below for more details.

Type:

object

columns

The number of columns.

Type:

Array<number> | number | object

Default:

12

columnSpacing

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

Type:

Array<number | string> | number | object | string

component

Type:

elementType

container

If true, the component will have the flex container behavior. You should be wrapping items with a container.

Type:

bool

Default:

false

direction

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

Type:

'column-reverse' | 'column' | 'row-reverse' | 'row' | Array<'column-reverse' | 'column' | 'row-reverse' | 'row'> | object

Default:

'row'

item

Type:

bool

Default:

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.

Type:

'auto' | number | bool

Default:

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.

Type:

'auto' | number | bool

Default:

false

rowSpacing

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

Type:

Array<number | string> | number | object | string

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.

Type:

'auto' | number | bool

Default:

false

spacing

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

Type:

Array<number | string> | number | object | string

Default:

0

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object

wrap

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

Type:

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

Default:

'wrap'

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.

Type:

'auto' | number | bool

Default:

false

Type:

'auto' | number | bool

Default:

false

zeroMinWidth

Type:

bool

Default:

false

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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiGrid-rootroot

Styles applied to the root element.

.MuiGrid-containercontainer

Styles applied to the root element if container={true}.

.MuiGrid-itemitem

.MuiGrid-zeroMinWidthzeroMinWidth

.MuiGrid-direction-xs-columndirection-xs-column

Styles applied to the root element if direction="column".

.MuiGrid-direction-xs-column-reversedirection-xs-column-reverse

Styles applied to the root element if direction="column-reverse".

.MuiGrid-direction-xs-row-reversedirection-xs-row-reverse

Styles applied to the root element if direction="row-reverse".

.MuiGrid-wrap-xs-nowrapwrap-xs-nowrap

Styles applied to the root element if wrap="nowrap".

.MuiGrid-wrap-xs-wrap-reversewrap-xs-wrap-reverse

Styles applied to the root element if wrap="reverse".

.MuiGrid-spacing-xs-1spacing-xs-1

.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-spacing-xs-10spacing-xs-10

.MuiGrid-grid-xs-autogrid-xs-auto

.MuiGrid-grid-xs-truegrid-xs-true

.MuiGrid-grid-xs-1grid-xs-1

.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-10grid-xs-10

.MuiGrid-grid-xs-11grid-xs-11

.MuiGrid-grid-xs-12grid-xs-12

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.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.