SimpleGrid

SimpleGrid provides a friendly interface to create responsive grid layouts with ease.

View source@chakra-ui/layout

Import

import { SimpleGrid } from "@chakra-ui/react";

Usage

Specifying the number of columns for the grid layout.

<SimpleGrid columns={2} spacing={10}> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> </SimpleGrid>

<SimpleGrid columns={2} spacing={10}>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
</SimpleGrid>

You can also make it responsive by passing array or object values into the columns prop.

// Passing `columns={[2, null, 3]}` and `columns={{sm: 2, md: 3}}` // will have the same effect. <SimpleGrid columns={[2, null, 3]} spacing="40px"> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> </SimpleGrid>

// Passing `columns={[2, null, 3]}` and `columns={{sm: 2, md: 3}}`
// will have the same effect.

<SimpleGrid columns={[2, null, 3]} spacing="40px">
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
</SimpleGrid>

Auto-responsive grid

To make the grid responsive and adjust automatically without passing columns, simply pass the minChildWidth prop to specify the min-width a child should have before adjusting the layout.

This uses css grid auto-fit and minmax() internally.

<SimpleGrid minChildWidth="120px" spacing="40px"> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> </SimpleGrid>

<SimpleGrid minChildWidth="120px" spacing="40px">
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
</SimpleGrid>

Changing the spacing for columns and rows

Simply pass the spacing prop to change the row and column spacing between the grid items. SimpleGrid also allows you pass spacingX and spacingY to define the space between columns and rows respectively.

<SimpleGrid columns={2} spacingX="40px" spacingY="20px"> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> <Box bg="tomato" height="80px"></Box> </SimpleGrid>

<SimpleGrid columns={2} spacingX="40px" spacingY="20px">
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
  <Box bg="tomato" height="80px"></Box>
</SimpleGrid>

Props

SimpleGrid composes Box so you can pass all the Box props and css grid props with addition of these:

autoColumns

Description

Shorthand prop for gridAutoColumns

Type

SystemProps["gridAutoColumns"]

autoFlow

Description

Shorthand prop for gridAutoFlow

Type

SystemProps["gridAutoFlow"]

autoRows

Description

Shorthand prop for gridAutoRows

Type

SystemProps["gridAutoRows"]

column

Description

Shorthand prop for gridColumn

Type

SystemProps["gridColumn"]

columns

Description

The number of columns

Type

ResponsiveValue<number>

minChildWidth

Description

The width at which child elements will break into columns. Pass a number for pixel values or a string for any other valid CSS length.

Type

ResponsiveValue<Union<string | number | (string & {})>>

row

Description

Shorthand prop for gridRow

Type

SystemProps["gridRow"]

spacing

Description

The gap between the grid items

Type

ResponsiveValue<Union<string | number | (string & {})>>

spacingX

Description

The column gap between the grid items

Type

ResponsiveValue<Union<string | number | (string & {})>>

spacingY

Description

The row gap between the grid items

Type

ResponsiveValue<Union<string | number | (string & {})>>

templateAreas

Description

Shorthand prop for gridTemplateAreas

Type

SystemProps["gridTemplateAreas"]

templateColumns

Description

Shorthand prop for gridTemplateColumns

Type

SystemProps["gridTemplateColumns"]

templateRows

Description

Shorthand prop for gridTemplateRows

Type

SystemProps["gridTemplateRows"]