Grid

import { GridDemos } from '@docs/demos'; import { Layout } from '@/layout'; import { MDX_DATA } from '@/mdx';

export default Layout(MDX_DATA.Grid);

Usage

Columns span

The Grid.Col span prop controls the ratio of column width to the total width of the row. By default, grid uses a 12 columns layout, so the span prop can be any number from 1 to 12.

Examples:

• <Grid.Col span={3} /> – 3 / 12 = 25% of row width
• <Grid.Col span={4} /> – 4 / 12 = 33% of row width
• <Grid.Col span={6} /> – 6 / 12 = 50% of row width
• <Grid.Col span={12} /> – 12 / 12 = 100% of row width

The span prop also supports object syntax to change column width based on viewport width. It accepts xs, sm, md, lg and xl keys and values from 1 to 12. The syntax is the same as in style props.

In the following example span={{ base: 12, md: 6, lg: 3 }}:

• base – 12 / 12 = 100% of row width when viewport width is less than md breakpoint
• md – 6 / 12 = 50% of row width when viewport width is between md and lg breakpoints
• lg – 3 / 12 = 25% of row width when viewport width is greater than lg breakpoint

Gap

Set the gap prop to control spacing between columns and rows. The prop works the same way as style props – you can reference theme.spacing values with xs, sm, md, lg and xl strings and use object syntax to change gap based on viewport width:

Row and column gap

Use rowGap and columnGap props to set different spacing for rows and columns. rowGap and columnGap override gap prop if both are set:

Grow

If the grow prop is set, the column will grow to fill the remaining space in the row:

Column offset

Set the offset prop on the Grid.Col component to add gaps to the grid. The offset prop supports the same syntax as the span prop: a number from 1 to 12 or an object with xs, sm, md, lg and xl keys and values from 1 to 12.

Order

Set the order prop on the Grid.Col component to change the order of columns. The order prop supports the same syntax as the span prop: a number from 1 to 12 or an object with xs, sm, md, lg and xl keys and values from 1 to 12.

Multiple rows

Once the columns' span and offset sum exceeds the columns prop (12 by default), columns are moved to the next row:

Justify and align

You can control the justify-content and align-items CSS properties with the justify and align props on the Grid component:

Column alignment

Use the align prop on individual Grid.Col components to control the align-self CSS property for each column. This allows you to override the grid's align prop for specific columns:

Auto sized columns

All columns in a row with span="auto" grow as much as they can to fill the row. In the following example, the second column takes up 50% of the row while the other two columns automatically resize to fill the remaining space:

Fit column content

If you set span="content", the column's size will automatically adjust to match the width of its content:

Change columns count

By default, grid uses a 12 columns layout. You can change it by setting the columns prop on the Grid component. Note that in this case, columns span and offset will be calculated relative to this value.

In the following example, the first column takes 50% with 12 span (12/24), second and third take 25% (6/24):

Container queries

To use container queries instead of media queries, set type="container". With container queries, all responsive values are adjusted based on the container width, not the viewport width.

Note that, when using container queries, it is also required to set breakpoints prop to the exact container width values.

To see how the grid changes, resize the root element of the demo with the resize handle located at the bottom right corner of the demo:

Browser support

Grid component uses flexbox with native gap for layout, which is supported in all modern browsers.

Container queries

When using type="container", the Grid component uses CSS container queries. Container queries are supported in the following browsers:

• Chrome 105+
• Safari 16+
• Firefox 110+
• Edge 105+

If you need to support older browsers, use the default type="media" which uses standard media queries instead of container queries.

Example with media queries (default):

import { Grid } from '@mantine/core';

function Demo() {
  return (
    <Grid gap="md">
      <Grid.Col span={{ base: 12, md: 6 }}>1</Grid.Col>
      <Grid.Col span={{ base: 12, md: 6 }}>2</Grid.Col>
    </Grid>
  );
}

Example with container queries:

import { Grid } from '@mantine/core';

function Demo() {
  return (
    <Grid
      type="container"
      breakpoints={{ xs: '100px', sm: '200px', md: '300px', lg: '400px', xl: '500px' }}
      gap="md"
    >
      <Grid.Col span={{ base: 12, md: 6 }}>1</Grid.Col>
      <Grid.Col span={{ base: 12, md: 6 }}>2</Grid.Col>
    </Grid>
  );
}