|
|
--- |
|
|
title: Flex and Grid |
|
|
description: JSX style props to control flex and grid layouts |
|
|
--- |
|
|
|
|
|
|
|
|
|
|
|
Use the `flexBasis` prop to set the initial main size of a flex item. |
|
|
|
|
|
```jsx |
|
|
<Flex> |
|
|
<Box flexBasis="25%" /> |
|
|
<Box flexBasis="25%" /> |
|
|
<Box flexBasis="50%" /> |
|
|
</Flex> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ----------- | ------------ | -------------- | |
|
|
| `flexBasis` | `flex-basis` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `flexDir` or `flexDirection` prop to set the direction of the main axis |
|
|
in a flex container. |
|
|
|
|
|
```jsx |
|
|
<Box display="flex" flexDirection="column"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
When using `Flex` component, the `direction` prop is aliased to `flexDirection`. |
|
|
|
|
|
```jsx |
|
|
<Flex direction="column"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Flex> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| -------------------------- | ---------------- | -------------- | |
|
|
| `flexDir`, `flexDirection` | `flex-direction` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `flexWrap` prop to set whether flex items are forced onto one line or |
|
|
can wrap onto multiple lines. |
|
|
|
|
|
```jsx |
|
|
<Box display="flex" flexWrap="wrap"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
When using `Flex` component, the `wrap` prop is aliased to `flexWrap`. |
|
|
|
|
|
```jsx |
|
|
<Flex wrap="wrap"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Flex> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ---------- | ------------ | -------------- | |
|
|
| `flexWrap` | `flex-wrap` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `flex` prop to define the flexibility of a flex container or item. |
|
|
|
|
|
```jsx |
|
|
<Flex> |
|
|
<Box flex="1" /> |
|
|
<Box /> |
|
|
</Flex> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ------ | ------------ | -------------- | |
|
|
| `flex` | `flex` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `flexGrow` prop to set the flex grow factor of a flex item. |
|
|
|
|
|
```jsx |
|
|
<Flex> |
|
|
<Box flexGrow="0" /> |
|
|
<Box flexGrow="1" /> |
|
|
</Flex> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ---------- | ------------ | -------------- | |
|
|
| `flexGrow` | `flex-grow` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `flexShrink` prop to set the flex shrink factor of a flex item. |
|
|
|
|
|
```jsx |
|
|
<Flex> |
|
|
<Box flexShrink="0" /> |
|
|
<Box flexShrink="1" /> |
|
|
</Flex> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ------------ | ------------- | -------------- | |
|
|
| `flexShrink` | `flex-shrink` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `order` prop to set the order of a flex item. |
|
|
|
|
|
```jsx |
|
|
<Flex> |
|
|
<Box order="0" /> |
|
|
<Box order="1" /> |
|
|
</Flex> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ------- | ------------ | -------------- | |
|
|
| `order` | `order` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `gap` prop to set the gap between items in a flex or grid container. |
|
|
|
|
|
```jsx |
|
|
<Flex gap="4"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Flex> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ----- | ------------ | -------------- | |
|
|
| `gap` | `gap` | `spacing` | |
|
|
|
|
|
|
|
|
|
|
|
Use the `gridTemplateColumns` prop to define the columns of a grid container. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid" gridTemplateColumns="repeat(3, minmax(0, 1fr))"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
When using `Grid` component, the `templateColumns` prop is aliased to |
|
|
`gridTemplateColumns`. |
|
|
|
|
|
```jsx |
|
|
<Grid templateColumns="repeat(3, minmax(0, 1fr))"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Grid> |
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
Use the `gridTemplateStart` and `gridTemplateEnd` props to define the start and |
|
|
end of a grid container. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid" gridTemplateColumns="repeat(3, minmax(0, 1fr))"> |
|
|
<Box>Item 1</Box> |
|
|
<Box gridColumn="span 2 / span 2">Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ------------------- | --------------------- | -------------- | |
|
|
| `gridTemplateStart` | `grid-template-start` | - | |
|
|
| `gridTemplateEnd` | `grid-template-end` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `gridTemplateRows` prop to define the rows of a grid container. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid" gap="4" gridTemplateRows="repeat(3, minmax(0, 1fr))"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ------------------ | -------------------- | -------------- | |
|
|
| `gridTemplateRows` | `grid-template-rows` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `gridRowStart` and `gridRowEnd` props to define the start and end of a |
|
|
grid item. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid" gap="4" gridTemplateRows="repeat(3, minmax(0, 1fr))"> |
|
|
<Box gridRowStart="1" gridRowEnd="3"> |
|
|
Item 1 |
|
|
</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| -------------- | ---------------- | -------------- | |
|
|
| `gridRowStart` | `grid-row-start` | - | |
|
|
| `gridRowEnd` | `grid-row-end` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `gridAutoFlow` prop to define how auto-placed items get flowed into the |
|
|
grid. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid" gridAutoFlow="row"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| -------------- | ---------------- | -------------- | |
|
|
| `gridAutoFlow` | `grid-auto-flow` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `gridAutoColumns` prop to specify the size of the grid columns that were |
|
|
created without an explicit size. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid" gridAutoColumns="120px"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ----------------- | ------------------- | -------------- | |
|
|
| `gridAutoColumns` | `grid-auto-columns` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `gridAutoRows` prop to specify the size of the grid rows that were |
|
|
created without an explicit size. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid" gridTemplateRows="200px" gridAutoRows="120px"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| -------------- | ---------------- | -------------- | |
|
|
| `gridAutoRows` | `grid-auto-rows` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `justifyContent` prop to align items along the main axis of a flex |
|
|
container. |
|
|
|
|
|
```jsx |
|
|
<Box display="flex" justifyContent="center"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
When using the `Flex` component, the `justify` prop is aliased to |
|
|
`justifyContent`. |
|
|
|
|
|
```jsx |
|
|
<Flex justify="center"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Flex> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ---------------- | ----------------- | -------------- | |
|
|
| `justifyContent` | `justify-content` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `justifyItems` prop to control the alignment of grid items within their |
|
|
scope. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid" justifyItems="center"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| -------------- | --------------- | -------------- | |
|
|
| `justifyItems` | `justify-items` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `alignContent` prop to align rows of content along the cross axis of a |
|
|
flex container when there's extra space. |
|
|
|
|
|
```jsx |
|
|
<Box display="flex" alignContent="center"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
When using the `Flex` component, the `align` prop is aliased to `alignContent`. |
|
|
|
|
|
```jsx |
|
|
<Flex align="center"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Flex> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| -------------- | --------------- | -------------- | |
|
|
| `alignContent` | `align-content` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `alignItems` prop to control the alignment of grid items within their |
|
|
scope. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid" alignItems="center"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
Use the `alignSelf` prop to control the alignment of a grid item within its |
|
|
scope. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid"> |
|
|
<Box alignSelf="center">Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ----------- | ------------ | -------------- | |
|
|
| `alignSelf` | `align-self` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `placeContent` prop to align content along both the block and inline |
|
|
directions at once. It works like `justifyContent` and `alignContent` combined, |
|
|
and can be used in flex and grid containers. |
|
|
|
|
|
```jsx |
|
|
<Flex placeContent="center"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Flex> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| -------------- | --------------- | -------------- | |
|
|
| `placeContent` | `place-content` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `placeItems` prop to align items along both the block and inline |
|
|
directions at once. It works like `justifyItems` and `alignItems` combined, and |
|
|
can be used in flex and grid containers. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid" placeItems="center"> |
|
|
<Box>Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ------------ | ------------- | -------------- | |
|
|
| `placeItems` | `place-items` | - | |
|
|
|
|
|
|
|
|
|
|
|
Use the `placeSelf` prop to align a grid item along both the block and inline |
|
|
directions at once. |
|
|
|
|
|
```jsx |
|
|
<Box display="grid"> |
|
|
<Box placeSelf="center">Item 1</Box> |
|
|
<Box>Item 2</Box> |
|
|
<Box>Item 3</Box> |
|
|
</Box> |
|
|
``` |
|
|
|
|
|
| Prop | CSS Property | Token Category | |
|
|
| ----------- | ------------ | -------------- | |
|
|
| `placeSelf` | `place-self` | - | |
|
|
|