JGuang
中

Grid

Grid · Mantine Core

Preview
npm install @mantine/core@9.7.1 @mantine/hooks@9.7.1

Grid

Install: npm install @mantine/core@9.7.1 @mantine/hooks@9.7.1

Version and compatibility

Pinned Mantine Core 9.7.1 requires React and React DOM ^19.2.0 and matching @mantine/hooks@9.7.1, from the installed npm package's peerDependencies. Do not force it into React 18 or another incompatible version. Explain upgrade impact and agree on a plan with the project owner; do not hide conflicts with --force/--legacy-peer-deps. The native Provider enables theme.respectReducedMotion and uses forceColorScheme for light/dark.

Use case

Compose a responsive column grid.

Native props used by this example

These props are extracted from the local typechecked JSX and grouped by their owning native component. This is not an exhaustive prop list; see pinned source signatures and inheritance below.

Component propExplanation
Grid.wMantine width style prop.
Grid.Col.spanColumn span in the native grid.
Paper.pMantine padding style prop.
Paper.withBorderShow the native border.

Interaction and state checks

Current scenarios: Default. Check actual behavior after selecting supported disabled/error/read-only scenarios; components without those native states do not receive invented universal props. Verify keyboard focus and exits, then connect changed values through the native callback signature.

Business integration boundary

Demo content/state is local, without server persistence, authorization or fetching. A static display component is not a completed business workflow.

Host setup

Install pinned @mantine/core and @mantine/hooks, import @mantine/core/styles.css at the entry and use MantineProvider. The example's theme/variant are JGuang-authored host props, not universal native component APIs; forceColorScheme synchronizes the app theme. Native implementation source is a reading reference: use npm exports rather than copying internal engines. This batch covers Core, not dates/charts/forms extension packages. Detailed upstream prose remains English.

Runnable usage

import { useState } from 'react';
import * as M from '@mantine/core';
import '@mantine/core/styles.css';


function ComponentPreview({ variant = 'Default' }: { variant?: string }) {

return <M.Grid w={300}><M.Grid.Col span={6}><M.Paper p="md" withBorder>One</M.Paper></M.Grid.Col><M.Grid.Col span={6}><M.Paper p="md" withBorder>Two</M.Paper></M.Grid.Col></M.Grid>;
}
export default function Example({ variant = 'Default', theme = 'light' }: { variant?: string; theme?: 'light' | 'dark' }) {
return <M.MantineProvider forceColorScheme={theme} theme={{ respectReducedMotion: true }}><ComponentPreview variant={variant} /></M.MantineProvider>;
}

Preview states

Default

The example uses the native Mantine API. For supported input demos, change the local variant to Disabled, Invalid or Read only; these are example labels, not new component props. Keep the documented data, controlled values, stores and compound children when adapting the example.

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>
  );
}

Source-backed parameter reference

Implementation signatures and types are generated from the pinned local source. Optional props, native inherited types, union branches and never exclusions are preserved. A forwardRef implementation's ref is a React reference, not an additional business prop.

Grid(_props)

export type GridStylesNames = 'root' | 'col' | 'inner' | 'container';

export type GridCssVariables = {
  root: '--grid-justify' | '--grid-align' | '--grid-overflow';
};

export interface GridProps extends BoxProps, StylesApiProps<GridFactory>, ElementProps<'div'> {
  /** Gap between columns and rows, key of `theme.spacing` or any valid CSS value @default 'md' */
  gap?: StyleProp<MantineSpacing>;

  /** Row gap, overrides `gap` for vertical spacing */
  rowGap?: StyleProp<MantineSpacing>;

  /** Column gap, overrides `gap` for horizontal spacing */
  columnGap?: StyleProp<MantineSpacing>;

  /** If set, columns in the last row expand to fill all available space @default false */
  grow?: boolean;

  /** Sets `justify-content` @default flex-start */
  justify?: React.CSSProperties['justifyContent'];

  /** Sets `align-items` @default stretch */
  align?: React.CSSProperties['alignItems'];

  /** Number of columns in each row @default 12 */
  columns?: number;

  /** Sets `overflow` CSS property on the root element @default 'visible' */
  overflow?: React.CSSProperties['overflow'];

  /** Type of queries used for responsive styles @default 'media' */
  type?: 'media' | 'container';

  /** Breakpoints values, only used with `type="container"` */
  breakpoints?: GridBreakpoints;
}

export type GridFactory = Factory<{
  props: GridProps;
  ref: HTMLDivElement;
  stylesNames: GridStylesNames;
  vars: GridCssVariables;
  staticComponents: {
    Col: typeof GridCol;
  };
}>;

export type Mod = Record<string, any> | string;

export type BoxMod = Mod | Mod[] | BoxMod[];

export interface BoxProps extends MantineStyleProps {
  /** Class added to the root element, if applicable */
  className?: string | undefined;

  /** Inline style added to root component element, can subscribe to theme defined on MantineProvider */
  style?: MantineStyleProp;

  /** CSS variables defined on root component element */
  __vars?: CssVarsProp;

  /** `size` property passed down the HTML element */
  __size?: string;

  /** Breakpoint above which the component is hidden with `display: none` */
  hiddenFrom?: MantineBreakpoint;

  /** Breakpoint below which the component is hidden with `display: none` */
  visibleFrom?: MantineBreakpoint;

  /** Determines whether component should be hidden in light color scheme with `display: none` */
  lightHidden?: boolean;

  /** Determines whether component should be hidden in dark color scheme with `display: none` */
  darkHidden?: boolean;

  /** Element modifiers transformed into `data-` attributes, for example, `{ 'data-size': 'xl' }`, falsy values are removed */
  mod?: BoxMod;
}

export type ElementProps<
  ElementType extends React.ElementType,
  PropsToOmit extends string = never,
> = Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>;

export interface CSSProperties extends React.CSSProperties {
  [key: string]: any;
}

type MantineStyle = CSSProperties | ((theme: MantineTheme) => CSSProperties);

export type MantineStyleProp = MantineStyle | MantineStyle[] | MantineStyleProp[] | undefined;

export type CssVariable = `--${string}`;

export type CssVariables<Variable extends string = CssVariable> = Partial<Record<Variable, string>>;

export type CssVars<Variable extends string = CssVariable> =
  | CssVariables<Variable>
  | ((theme: MantineTheme) => CssVariables<Variable>)
  | CssVars<Variable>[];

export type CssVarsProp<Variable extends string = CssVariable> =
  | CssVars<Variable>
  | CssVars<Variable>[];

Native and external types

External types remain defined by React or native dependencies, not manually expanded into guessed props. The installed version's TypeScript definitions are authoritative.

Factory<{
  props: GridProps;
  ref: HTMLDivElement;
  stylesNames: GridStylesNames;
  vars: GridCssVariables;
  staticComponents: {
    Col: typeof GridCol;
  };
}>
MantineStyleProps
React.CSSProperties
MantineTheme
Partial<Record<Variable, string>>
Record<Variable, string>
Variable
MantineBreakpoint
Record<string, any>
StylesApiProps<GridFactory>
React.ElementType
Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>
React.ComponentProps<ElementType>
ElementType
PropsToOmit
StyleProp<MantineSpacing>
MantineSpacing
GridBreakpoints
HTMLDivElement