Box

A low-level utility component that accepts styled system props to enable custom theme-aware styling

Beta
Not reviewed for accessibility

Source

On this page

import {Box} from '@primer/react'

Examples

Border on all sides

<Box borderColor="border.default" borderWidth={1} borderStyle="solid" p={3}>
  Hello
</Box>

<Box borderColor="border.default" borderWidth={1} borderStyle="solid" p={3}>
  Hello
</Box>

Border on one side

<Box borderColor="border.default" borderBottomWidth={1} borderBottomStyle="solid" pb={3}>
  Hello
</Box>

<Box borderColor="border.default" borderBottomWidth={1} borderBottomStyle="solid" pb={3}>
  Hello
</Box>

Flexbox

Use Box to create flexbox layouts.

<Box display="flex">
  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    1
  </Box>
  <Box flexGrow={1} p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    2
  </Box>
  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    3
  </Box>
</Box>

<Box display="flex">
  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    1
  </Box>
  <Box flexGrow={1} p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    2
  </Box>
  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    3
  </Box>
</Box>

Grid

Use Box to create grid layouts.

<Box display="grid" gridTemplateColumns="1fr 1fr" gridGap={3}>
  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    1
  </Box>
  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    2
  </Box>
  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    3
  </Box>
</Box>

<Box display="grid" gridTemplateColumns="1fr 1fr" gridGap={3}>
  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    1
  </Box>
  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    2
  </Box>
  <Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
    3
  </Box>
</Box>

Props

Box

Name	Type	Default	Description
sx	SystemStyleObject		Style overrides to apply to the component. See also overriding styles.
as	React.ElementType	"div"	The underlying element to render — either a HTML element name or a React component.
ref	React.RefObject<HTMLDivElement>		A ref to the element rendered by this component. Because this component is polymorphic, the type will vary based on the value of the `as` prop.
Additional props are passed to the `<div>` element. See for a list of props accepted by the `<div>` element. If an `as` prop is specified, the accepted props will change accordingly.

Box also accepts all styled system props.

Status

Alpha

Component props are documented on primer.style/react.
Component does not have any unnecessary third-party dependencies.
Component can adapt to different themes.
Component can adapt to different screen sizes.
Component has 100% test coverage.

Beta

Component is used in a production application.
Common usage examples are documented on primer.style/react.
Common usage examples are documented in storybook stories.
N/A: Component has been reviewed by a systems designer and any resulting issues have been addressed.
N/A: Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Stable

Component API has been stable with no breaking changes for at least one month.
Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.
N/A: Component has corresponding design guidelines documented in the interface guidelines.
N/A: Component has corresponding Figma component in the Primer Web library.

Edit this page on GitHub

1 contributor

Last edited by colebemis on December 16, 2021