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 (Material UI)

Import

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

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

Props

Props of the native component are also available.

children

columns

columnSpacing

container

direction

disableEqualOverflow

lgOffset

mdOffset

rowSpacing

smOffset

spacing

wrap

xlOffset

xsOffset

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-root

.MuiGrid-container

.MuiGrid-direction-xs-column

.MuiGrid-direction-xs-column-reverse

.MuiGrid-direction-xs-row-reverse

.MuiGrid-wrap-xs-nowrap

.MuiGrid-wrap-xs-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.

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.