Skip to content

Latest commit

 

History

History
117 lines (74 loc) · 3.81 KB

grid.mdx

File metadata and controls

117 lines (74 loc) · 3.81 KB
Raw

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

export default Layout(MDX_DATA.Grid);

Usage

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

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:

Grow

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

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.

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.

Multiple rows

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

Justify and align

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

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 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):

overflow: hidden

By default, Grid has overflow: visible style on the root element. In some cases you might want to change it to overflow: hidden to prevent negative margins from overflowing the grid container. For example, if you use Grid without parent container which has padding.

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

function Demo() {
  return (
    <Grid overflow="hidden">
      <Grid.Col span={6}>1</Grid.Col>
      <Grid.Col span={6}>2</Grid.Col>
    </Grid>
  );
}