Box is a component primitive that can be used to build the foundation of pretty much any other component. It keeps details like spacing, borders and colors consistent with the rest of Gestalt, while allowing the developer to focus on the content.
Props
Best practices
Use Box as a building block when creating other components or layouts that do not rely on flexbox. The included properties should cover any variations needed to create a diverse range of options.
If you find yourself using Box for flexbox layouts, consider Flex instead.
Don’t use the onClick
, className
and style
properties.
Box is a pass-through component, meaning that any other properties you provide to it will be directly applied to the underlying <div>
. The above properties are exceptions, however. We don’t allow onClick
for accessibility reasons, so consider a Button or TapArea instead. We remove className
and style
to ensure style encapsulation. If necessary, dangerouslySetInlineStyle
can be used to supply a style not supported by Box props.
If you need to use these features for animation purposes, use a <div>
instead.
When addressing the spacing of the Box, use padding before you use margins, as padding will compose better and won't collapse. Padding is applied in 4px increments and is always symmetric. Learn more about margin collapsing.
Avoid using arbitrary <div>
elements. Instead, when building a component, prioritize using Box. If you need to set a custom style, you can do so using the dangerouslySetInlineStyle
prop. However, this should be avoided whenever possible by utilizing the other props provided in Box. We provide a lint rule to prevent this from happening.
Accessibility
The visuallyHidden
option of the display
property can be used to prevent content from being visible while ensuring that screen readers still have access to the content. This can be useful when adding context for screen reader users, such as adding a pause to the labels of Checkboxes.
Setting display="visuallyHidden"
on Box allows for an element to be visually hidden but still be read by screen readers.
import {} from 'react'; import { Text, Box, Flex } from 'gestalt'; export default function Example() { return ( <Flex height="100%" width="100%" justifyContent="center" alignItems="center" > <Text>Enable your screen reader to hear the following text:</Text> <Box display="visuallyHidden">Hi there.</Box> </Flex> ); }
Using 'as' property
By default, the Box component renders a div
element, which is a non-semantic element that doesn't provide much meaning to the user or assistive technology. Use the as
prop to inform which semantic HTML element should be rendered by the Box component instead of a div
to ensure a more meaningful experience for both the user and the browser.
When using a Box component as a custom element, it is your responsibility to address all the accessibility implications. Both the role
and as
properties semantically classify the Box; however, the as
prop defines a more concise way to describe the HTML element by modifying the underlying DOM element directly, which helps support both accessibility and SEO. Use the as
prop whenever possible, making sure that the prop type is semantically associated with the Box content.
Review the available options for the as prop. For some of the options, like nav
, you will also need to specify a title
to ensure unique landmarks on the page. Learn more about semantics in HTML.
import {} from 'react'; import { Text, Box, Flex, Heading } from 'gestalt'; export default function Example() { return ( <Flex direction="column" flex="grow" alignItems="center" height="100%" width="100%" > <Flex height="100%" width="100%"> <Box as="nav" title="as prop example nav" column={6} color="successBase" width="100%" padding={2} borderStyle="sm" > <Text color="light" weight="bold"> Top Nav Menu: as="nav" </Text> </Box> <Box column={6} display="inlineBlock" borderStyle="sm"> <Box width="100%" padding={2}> <Text>HTML output:</Text> <Text>{'<nav>Menu</nav>'}</Text> </Box> </Box> </Flex> <Flex height="100%" width="100%"> <Box as="article" column={6} color="successBase" width="100%" padding={2} borderStyle="sm" > <Heading color="light" size="500"> Article 1 </Heading> <Text color="light" weight="bold"> Article: as="article" </Text> </Box> <Box column={6} display="inlineBlock" borderStyle="sm"> <Box width="100%" padding={2}> <Text>HTML output:</Text> <Text>{'<article>'}</Text> <Text>{'<h2>Article 1</h2>'}</Text> <Text>{'</article>'}</Text> </Box> </Box> </Flex> </Flex> ); }
Using 'role' property
Setting the role
property on Box classifies the Box as the semantically appropriate HTML element through the use of an ARIA role while leaving the underlying element as a div
. For example, setting role="banner"
will designate that Box to be the equivalent of a <header>
within the page hierarchy, allowing assistive technology to classify the Box appropriately.
Using the role
property creates more specific element classification and gives the user better context on the layout of the page, especially when the ability to specify the 'as' property is not available. Learn more about ARIA roles.
import {} from 'react'; import { Text, Box, Flex } from 'gestalt'; export default function Example() { return ( <Flex alignItems="center" height="100%" width="100%"> <Box column={12}> <Box role="feed" color="infoBase" width="100%" padding={2}> <Text color="light" weight="bold"> Container: role="feed" </Text> <Box column={8} display="inlineBlock"> <Box role="article" title="Article 1" color="successBase" height={50} width="100%" padding={2} > <Text color="light" weight="bold"> Content: role="article" </Text> </Box> </Box> <Box column={4} display="inlineBlock"> <Box role="form" color="warningBase" height={50} width="100%" padding={2} > <Text color="light" weight="bold"> Contact Form: role="form" </Text> </Box> </Box> </Box> <Box role="navigation" title="Site Map" color="successBase" height={50} width="100%" padding={2} > <Text color="light" weight="bold"> Site Map: role="navigation" </Text> </Box> <Text>{'Everything above will render as a <div>'}</Text> </Box> </Flex> ); }
Localization
Utilizing the marginStart
and marginEnd
properties will account for right-to-left languages and maintain proper spacing.
Page direction
Some languages (ex. Arabic, Hebrew) read from right to left (RTL) instead of from left to right. For this reason, we use marginStart
and marginEnd
(as opposed to left and right options) to support RTL. If specific left and right options are needed, use dangerouslySetInlineStyle
.
marginStart
is a left margin that flips to a right margin in a RTL layout.
marginEnd
is a right margin that flips to a left margin in a RTL layout.
You can toggle the page direction using the button below to see this behavior.
import {} from 'react'; import { Text, Box, Flex, Button } from 'gestalt'; function BoxWithMargins({ marginEnd = 0, marginStart = 0 }) { return ( <Box dangerouslySetInlineStyle={{ __style: { backgroundColor: 'rgba(110, 15, 60, 0.2)' }, }} > <Box width={200} padding={2} marginEnd={marginEnd} marginStart={marginStart} dangerouslySetInlineStyle={{ __style: { backgroundColor: 'rgba(19, 58, 94, 0.2)' }, }} > <Text> {JSON.stringify( `marginEnd: ${marginEnd}, marginStart: ${marginStart}` )} </Text> </Box> </Box> ); } export default function Example() { return ( <Flex direction="column" gap={2} height="100%" alignItems="center" justifyContent="center" > <Button size="sm" onClick={() => { if (document.documentElement) { const isRTL = document.documentElement.dir === 'rtl'; document.documentElement.dir = isRTL ? 'ltr' : 'rtl'; } }} text="Toggle Page Direction" /> <BoxWithMargins marginStart={8} /> <BoxWithMargins marginEnd={8} /> <BoxWithMargins marginStart={-8} /> <BoxWithMargins marginEnd={-8} /> </Flex> ); }
Variants
Borders
Borders are controlled by the borderStyle
property. Specifying a size (sm
or lg
) enables a solid, light gray color in that width. Specifying shadow
adds an even box-shadow around the entire container, while raisedTopShadow
and raisedBottomShadow
add shadows to indicate an elevated header or footer. See the elevation foundations page for more details.
Colors
The following values can be used to change the background color of Box. Be sure to use the value that semantically matches your use case. For full details on how to use our colors, visit our Color usage page.
Colors should be used semantically whenever possible (i.e. using "errorBase" for error scenarios). If a color is needed for a branded moment in product, Box color can be set using our color palette design tokens, but it is considered a hack and should be avoided.
Elevation
Colors and shadows can elevate elements within the UI. In light mode, elevationAccent
can be used when shadows or borders are not an option. elevationFloating
and elevationRaised
are only applicable in dark mode, while shadow
is only applicable in light mode. For full details, visit our Elevation foundations page.
Rounding
The rounding
property sets a border radius for the Box. Options are circle
or pill
for fully rounded corners or 0-8 representing the radius in 4px increments.
Opacity
Column layout
The column
property allows for automatic widths based on a 12-column grid. To create responsive layouts, specify different values for smColumn
, mdColumn
, and lgColumn
.
Sizing
Box can also be sized using a mixture of width
, height
, max/min width
, max/min height
, and fit
.
When setting the size of a Box, the overflow
property may need to be set in order to hide or scroll content that is outside the bounds of the Box.
import {} from 'react'; import { Text, Box, Flex } from 'gestalt'; export default function Example() { return ( <Flex height="100%" alignItems="center"> <Box column={12}> <Box width="25%" minHeight={25} maxHeight={100} overflow="hidden" padding={2} borderStyle="lg" color="warningBase" > <Text color="light"> Add or remove text in the editor to see the min and max heights take affect. </Text> </Box> <Box width="50%" height={100} padding={2} borderStyle="lg" color="successBase" > <Text color="light"> Width and Height can be specified with numbers for "px" values or percentages </Text> </Box> <Box width="75%" minWidth={100} maxWidth={500} padding={2} borderStyle="lg" color="infoBase" > <Text color="light"> Change the screen width to see the min and max widths take affect{' '} </Text> </Box> <Box fit padding={2} borderStyle="lg" color="errorBase"> <Text color="light">"fit" sets width to 100% </Text> </Box> </Box> </Flex> ); }
Overflow
When content overflows the bounds of Box, there are multiple options to control the overflow behavior. The default is overflow="visible"
, but the most common use case is supplying overflow="auto"
to ensure overflow content can be accessed. Learn more about CSS overflow.
import {} from 'react'; import { Text, Box, Flex } from 'gestalt'; export default function Example() { const text = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed vitae nisl nec turpis vehicula ultrices. Duis pretium ut ipsum nec interdum. Vestibulum arcu dolor, consectetur ac eros a, varius commodo justo. Maecenas tincidunt neque elit, eu pretium arcu dictum ac. Donec vehicula mauris ut erat dictum, eget tempus elit luctus. In volutpat felis justo, et venenatis arcu viverra in. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin enim lorem, vulputate eget imperdiet nec, dapibus sed diam. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse rhoncus ut leo non gravida. Nulla tincidunt tellus sit amet ornare venenatis. Sed quis lorem cursus, porttitor tellus sed, commodo ex. Praesent blandit pretium faucibus. Aenean orci tellus, vulputate id sapien sit amet, porta fermentum quam. Praesent sem risus, tristique sit amet pulvinar in, scelerisque sit amet massa.'; return ( <Flex gap={4} wrap width="100%" height="100%" justifyContent="center" alignItems="center" > <Flex gap={{ column: 8, row: 0 }} direction="column" wrap> <Box> <Text>Overflow Hidden</Text> <Box overflow="hidden" width={300} maxHeight={100} padding={2} borderStyle="lg" > <Text>{text}</Text> </Box> </Box> <Box> <Text>Overflow Scroll</Text> <Box overflow="scroll" width={300} maxHeight={100} padding={2} borderStyle="lg" tabIndex={0} > <Text>{text}</Text> </Box> </Box> <Box marginBottom={4}> <Text>Overflow Visible</Text> <Box overflow="visible" width={300} maxHeight={100} padding={2} borderStyle="lg" > <Text>{text.substring(0, 180)}</Text> </Box> </Box> <Box> <Text>Overflow Auto</Text> <Box overflow="auto" width={300} maxHeight={100} padding={2} color="selected" > <Box width={350} padding={2} color="default" tabIndex={0}> <Text>{text}</Text> </Box> </Box> </Box> <Box> <Text>Overflow scrollX</Text> <Box overflow="scrollX" width={300} maxHeight={100} padding={2} color="selected" > <Box width={350} padding={2} color="default" tabIndex={0}> <Text>{text}</Text> </Box> </Box> </Box> <Box> <Text>Overflow scrollY</Text> <Box overflow="scrollY" width={300} maxHeight={100} padding={2} color="selected" > <Box width={350} padding={2} color="default" tabIndex={0}> <Text>{text}</Text> </Box> </Box> </Box> </Flex> </Flex> ); }
Responsive padding
Control the padding on different screen sizes by setting the smPadding
, mdPadding
or lgPadding
properties. In the example, we increase the padding for every breakpoint in either all directions, the x-axis only or the y-axis only.
import {} from 'react'; import { Box, Flex } from 'gestalt'; export default function Example() { return ( <Flex gap={{ column: 0, row: 3 }} height="100%" width="100%" alignItems="center" justifyContent="center" > <Box padding={0} smPadding={1} mdPadding={4} lgPadding={8} color="darkWash" > <Box width={40} height={40} color="successBase" /> </Box> <Box paddingX={0} smPaddingX={1} mdPaddingX={4} lgPaddingX={8} color="darkWash" > <Box width={40} height={40} color="infoBase" /> </Box> <Box paddingY={0} smPaddingY={1} mdPaddingY={4} lgPaddingY={8} color="darkWash" > <Box width={40} height={40} color="warningBase" /> </Box> </Flex> ); }
Auto margins
Auto margin is a useful tool when positioning items without using flexbox layouts. By setting any of the margin properties to "auto", the margin will extend to fill the extra space.
This can be seen below, where the 5-column width Box is centered using margin="auto"
and the 3-column width Box uses marginStart="auto"
to automatically adjust the Box to the far edge.
import {} from 'react'; import { Box, Flex } from 'gestalt'; export default function Example() { return ( <Flex justifyContent="center" height="100%" width="100%"> <Box color="infoBase" marginStart={12} marginEnd={12} column={12}> <Box borderStyle="sm" color="successBase" margin="auto" column={5} height={100} /> <Box borderStyle="sm" color="warningBase" marginStart="auto" column={3} height={100} /> </Box> </Flex> ); }
Absolute positioning
Position is static by default but can be made absolute. Box has helpers to help align to absolute edges (top, bottom, left, right). These can be used in combination with padding to achieve desired offsets from edges.
import {} from 'react'; import { Text, Box } from 'gestalt'; export default function Example() { return ( <Box height="100%" width="100%"> <Box position="absolute" top left padding={2} color="infoBase"> <Text color="light">Top Left</Text> </Box> <Box position="absolute" top right padding={2} color="infoBase"> <Text color="light">Top Right</Text> </Box> <Box position="absolute" bottom left padding={2} color="infoBase"> <Text color="light">Bottom Left</Text> </Box> <Box position="absolute" bottom right padding={2} color="infoBase"> <Text color="light">Bottom Right</Text> </Box> </Box> ); }
Using as a ref
The ref
property can be used to anchor a Popover to a Box.
import { Fragment, useState, useRef } from 'react'; import { Text, Box, Flex, Button, Popover } from 'gestalt'; export default function Example() { const [open, setOpen] = useState(false); const anchorRef = useRef(null); return ( <Fragment> <Flex direction="column" gap={6} height="100%" width="100%" justifyContent="center" alignItems="center" > <Button color="red" onClick={() => setOpen((prevVal) => !prevVal)} text={open ? 'Close Popover' : 'Anchor a Popover to Box'} /> <Box borderStyle="sm" padding={3} ref={anchorRef} rounding={1}> <Text>I'm a Box</Text> </Box> </Flex> {open && ( <Popover anchor={anchorRef.current} idealDirection="down" onDismiss={() => {}} shouldFocus={false} > <Box padding={3}> <Text weight="bold">I'm a Popover anchored to a Box</Text> </Box> </Popover> )} </Fragment> ); }
Z-Index
It's possible to use Box with external elements using the CSS z-index
property by capturing those values in controlled objects. The example below shows using a FixedZIndex
for a value that comes from somewhere else, and a CompositeZIndex
to layer the Box on top of it. Visit our Z-Index documentation for more details on how to use these utility classes.
import {} from 'react'; import { Text, Box, CompositeZIndex, FixedZIndex, Sticky } from 'gestalt'; export default function Example() { const HEADER_ZINDEX = new FixedZIndex(100); const zIndex = new CompositeZIndex([HEADER_ZINDEX]); return ( <Box column={12} dangerouslySetInlineStyle={{ __style: { isolation: 'isolate' } }} height={150} overflow="scroll" tabIndex={0} > <Sticky top={0} zIndex={HEADER_ZINDEX}> <Box color="errorBase" width="80%" height={60} padding={2}> <Text color="light"> This is sticky and won't move when scrolling </Text> </Box> </Sticky> <Box color="infoBase" width="50%" height={100} zIndex={zIndex} position="relative" padding={2} > <Text color="light"> This will float above the sticky Box when scrolling </Text> </Box> <Box color="successBase" width="30%" height={120} padding={2}> <Text color="light"> This will go behind the sticky Box when scrolling </Text> </Box> </Box> ); }
Component quality checklist
Quality item | Status | Status description |
---|---|---|
Figma Library | Component is not currently available in Figma. | |
Responsive Web | Ready | Component is available in code for web and mobile web. |
iOS | Component is not currently available in code for iOS. | |
Android | Component is not currently available in code for Android. |
Related
Flex
Use Flex for flexbox layouts, especially when even spacing between elements is desired, by using the gap
property.
Container
Use Container to responsively layout content with a max-width on large screens.
ScrollBoundaryContainer
For proper positioning when using anchored components (Popover, Tooltip, etc.) within a container that could scroll, use ScrollBoundaryContainer.
TapArea
If a tap target is needed in order to click on a portion of the page, use TapArea, since onClick
is not supported on Box.
Sticky
Use Sticky if a portion of the page should stick to either the top or bottom when scrolling.