Grid version 2

The responsive layout grid adapts to screen size and orientation, ensuring consistency across layouts.

The Grid component works well for a layout with a known number of columns. The columns can be configured with multiple breakpoints to specify the column span of each child.

How it works

The grid system is implemented with the Grid component:

• It uses CSS Flexbox (rather than CSS Grid) for high flexibility.
• The grid is always a flex item. Use the container prop to add a flex container.
• Item widths are set in percentages, so they're always fluid and sized relative to their parent element.
• There are five default grid breakpoints: xs, sm, md, lg, and xl. If you need custom breakpoints, check out custom breakpoints grid.
• You can give integer values for each breakpoint, to indicate how many of the 12 available columns are occupied by the component when the viewport width satisfies the breakpoint constraints.
• It uses the gap CSS property to add spacing between items.
• It does not support row spanning. Children elements cannot span multiple rows. We recommend using CSS Grid if you need this functionality.
• It does not automatically place children. It will try to fit the children one by one, and if there is not enough space, the rest of the children will start on the next line, and so on. If you need auto-placement, we recommend using CSS Grid instead.

Fluid grids

Fluid grids use columns that scale and resize content. A fluid grid's layout can use breakpoints to determine if the layout needs to change dramatically.

Basic grid

In order to create a grid layout, you need a container. Use the container prop to create a grid container that wraps the grid items (the Grid is always an item).

Column widths are integer values between 1 and 12. For example, an item with size={6} occupies half of the grid container's width.

Multiple breakpoints

Items may have multiple widths defined, causing the layout to change at the defined breakpoint. Width values apply to all wider breakpoints, and larger breakpoints override those given to smaller breakpoints.

For example, a component with size={{ xs: 12, sm: 6 }} occupies the entire viewport width when the viewport is less than 600 pixels wide. When the viewport grows beyond this size, the component occupies half of the total width—six columns rather than 12.

Spacing

Use the spacing prop to control the space between children. The spacing value can be any positive number (including decimals) or a string. The prop is converted into a CSS property using the theme.spacing() helper.

The following demo illustrates the use of the spacing prop:

Row and column spacing

The rowSpacing and columnSpacing props let you specify row and column gaps independently of one another. They behave similarly to the row-gap and column-gap properties of CSS Grid.

Responsive values

You can set prop values to change when a given breakpoint is active. For instance, we can implement Material Design's recommended responsive layout grid, as seen in the following demo:

Responsive values are supported by:

• size
• columns
• columnSpacing
• direction
• rowSpacing
• spacing
• offset

Auto-layout

The auto-layout feature gives equal space to all items present. When you set the width of one item, the others will automatically resize to match it.

Variable width content

When a breakpoint's value is given as "auto", then a column's size will automatically adjust to match the width of its content. The demo below shows how this works:

Nested grid

The grid container that renders as a direct child inside another grid container is a nested grid that inherits its columns and spacing from the top level. It will also inherit the props of the top-level grid if it receives those props.

Inheriting spacing

A nested grid container inherits the row and column spacing from its parent unless the spacing prop is specified to the instance.

Inheriting columns

A nested grid container inherits the columns from its parent unless the columns prop is specified to the instance.

Columns

Use the columns prop to change the default number of columns (12) in the grid, as shown below:

Offset

The offset prop pushes an item to the right side of the grid. This props accepts:

• numbers—for example, offset={{ md: 2 }} pushes an item two columns to the right when the viewport size is equal to or greater than the md breakpoint.
• "auto"—this pushes the item to the far right side of the grid container.

The demo below illustrates how to use the offset props:

Custom breakpoints

If you specify custom breakpoints in the theme, you can use those names as grid item props in responsive values:

import { ThemeProvider, createTheme } from '@mui/material/styles';

function Demo() {
  return (
    <ThemeProvider
      theme={createTheme({
        breakpoints: {
          values: {
            laptop: 1024,
            tablet: 640,
            mobile: 0,
            desktop: 1280,
          },
        },
      })}
    >
      <Grid container spacing={{ mobile: 1, tablet: 2, laptop: 3 }}>
        {Array.from(Array(4)).map((_, index) => (
          <Grid key={index} size={{ mobile: 6, tablet: 4, laptop: 3 }}>
            <div>{index + 1}</div>
          </Grid>
        ))}
      </Grid>
    </ThemeProvider>
  );
}

TypeScript

You have to set module augmentation on the theme breakpoints interface.

declare module '@mui/system' {
  interface BreakpointOverrides {
    // Your custom breakpoints
    laptop: true;
    tablet: true;
    mobile: true;
    desktop: true;
    // Remove default breakpoints
    xs: false;
    sm: false;
    md: false;
    lg: false;
    xl: false;
  }
}

Customization

Centered elements

To center a grid item's content, specify display="flex" directly on the item. Then use justifyContent and/or alignItems to adjust the position of the content, as shown below:

Full border

Half border

Limitations

Column direction and reversing

The size and offset props are not supported within containers that use direction="column" or direction="column-reverse".

Size and offset props define the number of columns the component will use for a given breakpoint. They are intended to control the width using flex-basis in row containers, but they will impact the height in column containers. If used, these props may have undesirable effects on the height of the Grid item elements.

API

See the documentation below for a complete reference to all of the props and classes available to the components mentioned here.

• <Grid2 />
• <PigmentGrid />