Grid

Responsive grid system

Import

Usage

1
2
3
import { Grid } from '@mantine/core';

function Demo() {
  return (
    <Grid>
      <Grid.Col span={4}>1</Grid.Col>
      <Grid.Col span={4}>2</Grid.Col>
      <Grid.Col span={4}>3</Grid.Col>
    </Grid>
  );
}

Columns span

Grid.Col span prop controls the ratio of column width to the total width of the row. By default, grid uses 12 columns layout, so 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

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
1
2
3
4
import { Grid } from '@mantine/core';

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

Gutter

Set gutter prop to control spacing between columns. 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 gutter based on viewport width:

1
2
3
import { Grid } from '@mantine/core';

function Demo() {
  return (
    <Grid gutter={{ base: 5, xs: 'md', md: 'xl', xl: 50 }}>
      <Grid.Col span={4}>1</Grid.Col>
      <Grid.Col span={4}>2</Grid.Col>
      <Grid.Col span={4}>3</Grid.Col>
    </Grid>
  );
}

Grow

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

1
2
3
4
5
Gutter
import { Grid } from '@mantine/core';

function Demo() {
  return (
    <Grid grow>
      <Grid.Col span={4}>1</Grid.Col>
      <Grid.Col span={4}>2</Grid.Col>
      <Grid.Col span={4}>3</Grid.Col>
      <Grid.Col span={4}>4</Grid.Col>
      <Grid.Col span={4}>5</Grid.Col>
    </Grid>
  );
}

Column offset

Set offset prop on Grid.Col component to add gaps to the grid. offset prop supports the same syntax as 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.

1
2
3
import { Grid } from '@mantine/core';

function Demo() {
  return (
    <Grid>
      <Grid.Col span={3}>1</Grid.Col>
      <Grid.Col span={3}>2</Grid.Col>
      <Grid.Col span={3} offset={3}>3</Grid.Col>
    </Grid>
  );
}

Order

Set the order prop on Grid.Col component to change the order of columns. order prop supports the same syntax as 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.

2
3
1
import { Grid } from '@mantine/core';

function Demo() {
  return (
    <Grid>
      <Grid.Col span={3} order={{ base: 2, sm: 1, lg: 3 }}>2</Grid.Col>
      <Grid.Col span={3} order={{ base: 3, sm: 2, lg: 2 }}>3</Grid.Col>
      <Grid.Col span={3} order={{ base: 1, sm: 3, lg: 1 }}>1</Grid.Col>
    </Grid>
  );
}

Multiple rows

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

1
2
3
4
import { Grid } from '@mantine/core';

function Demo() {
  return (
    <Grid>
      <Grid.Col span={4}>1</Grid.Col>
      <Grid.Col span={4}>2</Grid.Col>
      <Grid.Col span={4}>3</Grid.Col>
      <Grid.Col span={4}>4</Grid.Col>
    </Grid>
  );
}

Justify and align

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

1
2
3
import { Grid, rem } from '@mantine/core';

function Demo() {
  return (
    <Grid justify="flex-start" align="stretch">
      <Grid.Col span={3} style={{ minHeight: rem(80) }}>1</Grid.Col>
      <Grid.Col span={3} style={{ minHeight: rem(120) }}>2</Grid.Col>
      <Grid.Col span={3}>3</Grid.Col>
    </Grid>
  );
}

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:

1
2
3
import { Grid } from '@mantine/core';

function Demo() {
  return (
    <Grid>
      <Grid.Col span="auto">span=auto</Grid.Col>
      <Grid.Col span={6}>span=6</Grid.Col>
      <Grid.Col span="auto">span=auto</Grid.Col>
    </Grid>
  );
}

Fit column content

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

fit content
2
import { Grid } from '@mantine/core';

function Demo() {
  return (
    <Grid>
      <Grid.Col span="content">fit content</Grid.Col>
      <Grid.Col span={6}>2</Grid.Col>
    </Grid>
  );
}

Change columns count

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

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

1
2
3
import { Grid } from '@mantine/core';

function Demo() {
  return (
    <Grid columns={24}>
      <Grid.Col span={12}>1</Grid.Col>
      <Grid.Col span={6}>2</Grid.Col>
      <Grid.Col span={6}>3</Grid.Col>
    </Grid>
  );
}