Grid

Equal columns or a grid that fits its available width.

Production

All services operational

Preview

Latest changes ready for review
import { Grid } from "@/components/ui/grid"
import { Heading } from "@/components/ui/heading"
import { Text } from "@/components/ui/text"
import { VStack } from "@/components/ui/stack"

export default function GridDemo() {
  return (
    <Grid columns={2} gap={6}>
      <VStack gap={1}>
        <Heading>Production</Heading>
        <Text tone="muted">All services operational</Text>
      </VStack>
      <VStack gap={1}>
        <Heading>Preview</Heading>
        <Text tone="muted">Latest changes ready for review</Text>
      </VStack>
    </Grid>
  )
}

Installation

pnpm dlx shadcn@latest add @arene/grid

Needs the arene setup first.

Usage

import { Grid } from "@/components/ui/grid"
<Grid columns={2} gap={4}>
  <div>Name</div>
  <div>Email</div>
</Grid>

Use columns for fixed equal columns. Use minWidth instead for auto-fit columns with a minimum width in rem. A track never exceeds the available width, so a narrow container does not overflow. The two modes are mutually exclusive.

gap uses the Stack spacing scale. gridStyles exports base, columns, autoFit and gap.

Columns

Choose one, two or three equal columns. With neither mode set, the grid has one column.

Name
Email
Role
Name
Email
Role
Name
Email
Role
import { Grid } from "@/components/ui/grid"
import { VStack } from "@/components/ui/stack"

export default function GridColumns() {
  return (
    <VStack gap={3}>
      <Grid columns={1} gap={2}>
        <div>Name</div>
        <div>Email</div>
        <div>Role</div>
      </Grid>
      <Grid columns={2} gap={2}>
        <div>Name</div>
        <div>Email</div>
        <div>Role</div>
      </Grid>
      <Grid columns={3} gap={2}>
        <div>Name</div>
        <div>Email</div>
        <div>Role</div>
      </Grid>
    </VStack>
  )
}

Minimum width

Use narrow (12rem) or xs (20rem) for tracks that fit the available width.

narrow: Project settings
Team members
xs: Project settings
Team members
import { Grid } from "@/components/ui/grid"
import { VStack } from "@/components/ui/stack"

export default function GridMinWidth() {
  return (
    <VStack gap={3}>
      <Grid minWidth="narrow" gap={4}>
        <div>narrow: Project settings</div>
        <div>Team members</div>
      </Grid>
      <Grid minWidth="xs" gap={4}>
        <div>xs: Project settings</div>
        <div>Team members</div>
      </Grid>
    </VStack>
  )
}

Gap

Gap is unset by default and uses the shared spacing scale.

Gap 0
Preview
Gap 0.5
Preview
Gap 1
Preview
Gap 1.5
Preview
Gap 2
Preview
Gap 2.5
Preview
Gap 3
Preview
Gap 3.5
Preview
Gap 4
Preview
Gap 5
Preview
Gap 6
Preview
Gap 8
Preview
Gap 10
Preview
Gap 12
Preview
Gap 16
Preview
Gap 24
Preview
import { Grid } from "@/components/ui/grid"
import { VStack } from "@/components/ui/stack"

export default function GridGap() {
  return (
    <VStack gap={3}>
      <Grid columns={2} gap={0}>
        <div>Gap 0</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={0.5}>
        <div>Gap 0.5</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={1}>
        <div>Gap 1</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={1.5}>
        <div>Gap 1.5</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={2}>
        <div>Gap 2</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={2.5}>
        <div>Gap 2.5</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={3}>
        <div>Gap 3</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={3.5}>
        <div>Gap 3.5</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={4}>
        <div>Gap 4</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={5}>
        <div>Gap 5</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={6}>
        <div>Gap 6</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={8}>
        <div>Gap 8</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={10}>
        <div>Gap 10</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={12}>
        <div>Gap 12</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={16}>
        <div>Gap 16</div>
        <div>Preview</div>
      </Grid>
      <Grid columns={2} gap={24}>
        <div>Gap 24</div>
        <div>Preview</div>
      </Grid>
    </VStack>
  )
}

Composition

Pass render to choose a semantic element. Put its props on that element.

Name: arene
Status: active
import { Grid } from "@/components/ui/grid"

export default function GridRender() {
  return (
    <Grid render={<section aria-label="Project details" />} columns={2} gap={4}>
      <div>Name: arene</div>
      <div>Status: active</div>
    </Grid>
  )
}

API reference

See Base UI's useRender reference for composition props. Native element props are forwarded.

PropTypeDefault
columns1 | 2 | 3None
minWidth"narrow" | "xs"None
gapSpacingStepNone
renderuseRender.RenderPropNative element
xstyleStyleXStylesNone
classNamestringNone
styleCSSPropertiesNone

Data attributes

AttributeOnEffect
data-slot="grid"rootIdentifies the component