Grid

A layout container using CSS grid. Supports Spectrum dimensions as values to ensure consistent and adaptive sizing and spacing.

install	`yarn add @react-spectrum/layout`
version	3.0.0-alpha.1
usage	`import {Grid} from '@react-spectrum/layout'`

View repository

GitHub

View package

NPM

Introduction#

The Grid component can be used to layout its children in two dimensions with CSS grid. Any React Spectrum component can be used as a child, and Spectrum dimension variables can be used to define sizing and spacing, which ensures consistency across applications, and allows the layout to adapt to different devices automatically. In addition, these values can be autocompleted in many IDEs for convenience.

Examples#

Explicit grids#

This example shows how to build a common application layout with a header, sidebar, content area, and footer. It uses the areas prop to define the grid areas, along with columns and rows to define the sizes. Each child uses the gridArea prop to declare which area it should be placed in.

<Grid
  areas={[
    'header  header',
    'sidebar content',
    'footer  footer'
  ]}
  columns={['size-3000', 'auto']}
  rows={['size-1000', 'auto', 'size-1000']}
  height="size-6000"
  gap="size-100">
  <View backgroundColor="celery-600" gridArea="header" />
  <View backgroundColor="blue-600" gridArea="sidebar" />
  <View backgroundColor="purple-600" gridArea="content" />
  <View backgroundColor="magenta-600" gridArea="footer" />
</Grid>

<Grid
  areas={[
    'header  header',
    'sidebar content',
    'footer  footer'
  ]}
  columns={['size-3000', 'auto']}
  rows={['size-1000', 'auto', 'size-1000']}
  height="size-6000"
  gap="size-100">
  <View backgroundColor="celery-600" gridArea="header" />
  <View backgroundColor="blue-600" gridArea="sidebar" />
  <View backgroundColor="purple-600" gridArea="content" />
  <View backgroundColor="magenta-600" gridArea="footer" />
</Grid>

<Grid
  areas={[
    'header  header',
    'sidebar content',
    'footer  footer'
  ]}
  columns={[
    'size-3000',
    'auto'
  ]}
  rows={[
    'size-1000',
    'auto',
    'size-1000'
  ]}
  height="size-6000"
  gap="size-100">
  <View
    backgroundColor="celery-600"
    gridArea="header"
  />
  <View
    backgroundColor="blue-600"
    gridArea="sidebar"
  />
  <View
    backgroundColor="purple-600"
    gridArea="content"
  />
  <View
    backgroundColor="magenta-600"
    gridArea="footer"
  />
</Grid>

Implicit grids#

This example creates an implicit grid. It declares the columns using the repeat function to automatically generate as many columns as fit, and uses the autoRows prop to set the size of the implicitly created rows. The items are centered horizontally within the container, and have a gap between them defined using a Spectrum dimension variable. Resize your browser to see how items reflow.

<Grid
  columns={repeat('auto-fit', 'size-800')}
  autoRows="size-800"
  justifyContent="center"
  gap="size-100">
  {colors.map(color =>
    <View key={color} backgroundColor={color} />
  )}
</Grid>

<Grid
  columns={repeat('auto-fit', 'size-800')}
  autoRows="size-800"
  justifyContent="center"
  gap="size-100">
  {colors.map(color =>
    <View key={color} backgroundColor={color} />
  )}
</Grid>

<Grid
  columns={repeat(
    'auto-fit',
    'size-800'
  )}
  autoRows="size-800"
  justifyContent="center"
  gap="size-100">
  {colors.map(
    (color) => (
      <View
        key={color}
        backgroundColor={
          color
        }
      />
    )
  )}
</Grid>

Props#

Name	Type	Default	Description
`children`	`ReactNode`	—	Children of the grid container.
`areas`	`string[]`	—	Defines named grid areas. See MDN.
`rows`	`string \| DimensionValue[]`	—	Defines the sizes of each row in the grid. See MDN.
`columns`	`string \| DimensionValue[]`	—	Defines the sizes of each column in the grid. See MDN.
`autoColumns`	`DimensionValue`	—	Defines the size of implicitly generated columns. See MDN.
`autoRows`	`DimensionValue`	—	Defines the size of implicitly generated rows. See MDN.
`autoFlow`	`'row' \| 'column' \| 'row dense' \| 'column dense'`	—	Controls how auto-placed items are flowed into the grid. See MDN.
`justifyItems`	`'auto' \| 'normal' \| 'start' \| 'end' \| 'center' \| 'left' \| 'right' \| 'stretch' \| 'self-start' \| 'self-end' \| 'baseline' \| 'first baseline' \| 'last baseline' \| 'safe center' \| 'unsafe center' \| 'legacy right' \| 'legacy left' \| 'legacy center'`	—	Defines the default `justifySelf` for all items in the grid. See MDN.
`justifyContent`	`'start' \| 'end' \| 'center' \| 'left' \| 'right' \| 'space-between' \| 'space-around' \| 'space-evenly' \| 'stretch' \| 'baseline' \| 'first baseline' \| 'last baseline' \| 'safe center' \| 'unsafe center'`	`'stretch'`	The distribution of space around items along the main axis. See MDN.
`alignContent`	`'start' \| 'end' \| 'center' \| 'space-between' \| 'space-around' \| 'space-evenly' \| 'stretch' \| 'baseline' \| 'first baseline' \| 'last baseline' \| 'safe center' \| 'unsafe center'`	`'start'`	The distribution of space around child items along the cross axis. See MDN.
`alignItems`	`'start' \| 'end' \| 'center' \| 'stretch' \| 'self-start' \| 'self-end' \| 'baseline' \| 'first baseline' \| 'last baseline' \| 'safe center' \| 'unsafe center'`	`'stretch'`	The alignment of children within their container. See MDN.
`gap`	`DimensionValue`	—	The space to display between both rows and columns. See MDN.
`columnGap`	`DimensionValue`	—	The space to display between columns. See MDN.
`rowGap`	`DimensionValue`	—	The space to display between rows. See MDN.

Layout

Name	Type	Default	Description
`flex`	`string \| number \| boolean`	—	When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
`flexGrow`	`number`	—	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`number`	—	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`number \| string`	—	When used in a flex layout, specifies the initial main size of the element. See MDN.
`alignSelf`	`'auto' \| 'normal' \| 'start' \| 'end' \| 'center' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'stretch'`	—	Overrides the `alignItems` property of a flex or grid container. See MDN.
`justifySelf`	`'auto' \| 'normal' \| 'start' \| 'end' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'center' \| 'left' \| 'right' \| 'stretch'`	—	Specifies how the element is justified inside a flex or grid container. See MDN.
`order`	`number`	—	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`string`	—	When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
`gridColumn`	`string`	—	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`string`	—	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`string`	—	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`string`	—	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`string`	—	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`string`	—	When used in a grid layout, specifies the ending row to span within the grid. See MDN.

Spacing

Name	Type	Default	Description
`margin`	`DimensionValue`	—	The margin for all four sides of the element. See MDN.
`marginTop`	`DimensionValue`	—	The margin for the top side of the element. See MDN.
`marginBottom`	`DimensionValue`	—	The margin for the bottom side of the element. See MDN.
`marginStart`	`DimensionValue`	—	The margin for the logical start side of the element, depending on layout direction. See MDN.
`marginEnd`	`DimensionValue`	—	The margin for the logical end side of an element, depending on layout direction. See MDN.
`marginX`	`DimensionValue`	—	The margin for both the left and right sides of the element. See MDN.
`marginY`	`DimensionValue`	—	The margin for both the top and bottom sides of the element. See MDN.

Sizing

Name	Type	Default	Description
`width`	`DimensionValue`	—	The width of the element. See MDN.
`minWidth`	`DimensionValue`	—	The minimum width of the element. See MDN.
`maxWidth`	`DimensionValue`	—	The maximum width of the element. See MDN.
`height`	`DimensionValue`	—	The height of the element. See MDN.
`minHeight`	`DimensionValue`	—	The minimum height of the element. See MDN.
`maxHeight`	`DimensionValue`	—	The maximum height of the element. See MDN.

Positioning

Name	Type	Default	Description
`position`	`'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky'`	—	Specifies how the element is positioned. See MDN.
`top`	`DimensionValue`	—	The top position for the element. See MDN.
`bottom`	`DimensionValue`	—	The bottom position for the element. See MDN.
`left`	`DimensionValue`	—	The left position for the element. See MDN. Consider using `start` instead for RTL support.
`right`	`DimensionValue`	—	The right position for the element. See MDN. Consider using `start` instead for RTL support.
`start`	`DimensionValue`	—	The logical start position for the element, depending on layout direction. See MDN.
`end`	`DimensionValue`	—	The logical end position for the element, depending on layout direction. See MDN.
`zIndex`	`number`	—	The stacking order for the element. See MDN.
`isHidden`	`boolean`	—	Hides the element.

Accessibility

Name	Type	Default	Description
`id`	`string`	—

Advanced

Name	Type	Default	Description
`UNSAFE_className`	`string`	—	Sets the CSS className for the element. Only use as a last resort. Use style props instead.
`UNSAFE_style`	`CSSProperties`	—	Sets inline style for the element. Only use as a last resort. Use style props instead.

Helper functions#

React Spectrum offers JavaScript versions of the CSS functions that are often used with CSS grid. These allow using Spectrum variables to define dimensions, and are typed to allow IDE autocomplete.

repeat#

The repeat function can be used to make a repeating fragment of the columns or rows list.

repeat(
  (count: number | 'auto-fill' | 'auto-fit',
  , repeat: DimensionValue | DimensionValue[]
)): string

minmax#

The minmax function defines a size range greater than or equal to min and less than or equal to max.

minmax(
  (min: DimensionValue,
  , max: DimensionValue
)): string

fitContent#

The fitContent function clamps a given size to an available size.

fitContent(
  (dimension: DimensionValue
)): string

See the Styling docs for a visualization of these values.

'size-0'
  | 'size-10'
  | 'size-25'
  | 'size-40'
  | 'size-50'
  | 'size-65'
  | 'size-75'
  | 'size-85'
  | 'size-100'
  | 'size-115'
  | 'size-125'
  | 'size-130'
  | 'size-150'
  | 'size-160'
  | 'size-175'
  | 'size-200'
  | 'size-225'
  | 'size-250'
  | 'size-300'
  | 'size-350'
  | 'size-400'
  | 'size-450'
  | 'size-500'
  | 'size-550'
  | 'size-600'
  | 'size-675'
  | 'size-700'
  | 'size-800'
  | 'size-900'
  | 'size-1000'
  | 'size-1200'
  | 'size-1250'
  | 'size-1600'
  | 'size-1700'
  | 'size-2000'
  | 'size-2400'
  | 'size-3000'
  | 'size-3400'
  | 'size-3600'
  | 'size-4600'
  | 'size-5000'
  | 'size-6000'
  | 'static-size-0'
  | 'static-size-10'
  | 'static-size-25'
  | 'static-size-50'
  | 'static-size-40'
  | 'static-size-65'
  | 'static-size-100'
  | 'static-size-115'
  | 'static-size-125'
  | 'static-size-150'
  | 'static-size-175'
  | 'static-size-200'
  | 'static-size-225'
  | 'static-size-250'
  | 'static-size-300'
  | 'static-size-400'
  | 'static-size-450'
  | 'static-size-500'
  | 'static-size-550'
  | 'static-size-600'
  | 'static-size-700'
  | 'static-size-800'
  | 'static-size-900'
  | 'static-size-1000'
  | 'static-size-1200'
  | 'static-size-1700'
  | 'static-size-2400'
  | 'static-size-2600'
  | 'static-size-3400'
  | 'static-size-3600'
  | 'static-size-4600'
  | 'static-size-5000'
  | 'static-size-6000'
  | 'single-line-height'
  | 'single-line-width'
  | string & {}
  | number