Back to Radix Ui

Layout

data/themes/docs/overview/layout.mdx

latest5.1 KB
Original Source

Layout

<Description>Get the layout concerns right.</Description>

Layout components

Layout components are used to separate layout responsibilities from content and interactivity. This is the separation of concerns that makes your app maintainable and easy to reason about, and understanding these principles is key to building your interfaces effectively.

Box

<ThemesBoxExample />

Box is the most fundamental layout component. Box is used to:

  • Provide spacing to child elements.
  • Impose sizing constraints on content.
  • Control layout behaviour within flex and grid containers.
  • Hide content based on screen size using its responsive display prop.

Flex

<ThemesFlexExample />

Flex component does everything that Box can do, but comes with an additional set of props to organize items along an axis. It provides convenient access to the CSS flexbox properties

Grid

<ThemesGridExample />

Grid is used to organize the content in columns and rows. Like Box and Flex, it’s made to provide convenient access to the underlying CSS grid properties without any magic of its own.

Section

<ThemesSectionExample />

Section provides a consistent vertical spacing between the larger parts of your page content, creating a sense of hierarchy and separation. There’s just a few pre-defined sizes for different spacing levels to keep things simple and consistent.

Container

<ThemesContainerExample />

Container’s sole responsibility is to provide a consistent max-width to the content it wraps. Like Section, it comes just with a couple of pre-defined sizes that work well with common breakpoints and typical content widths for comfortable reading.


Common layout props

Each layout component has a set of it’s own specialized props and also a shared set of common layout props. All layout props support responsive object values.

Padding

Padding props can access the space scale steps or accept any valid CSS padding value.

jsx
<Box p="4" />
<Box p="100px">
<Box p={{ sm: '6', lg: '9' }}>
<ThemesPropsTable defs="paddingPropDefs" />

Width

Width props accept any valid CSS width value.

jsx
<Box width="100px" />
<Box width={{ md: '100vw', xl: '1400px' }} />
<ThemesPropsTable defs="widthPropDefs" />

Height

Height props accept any valid CSS height value.

jsx
<Box height="100px" />
<Box height={{ md: '100vh', xl: '600px' }} />
<ThemesPropsTable defs="heightPropDefs" />

Positioning

Positioning props can change how the element is placed relative to the normal flow of the document. As usual, the corresponding CSS values are accepted for each property, and the space scale steps can be used for the offset values.

jsx
<Box position="relative" />
<Box position={{ initial: "relative", lg: "sticky" }} />

<Box inset="4" />
<Box inset={{ initial: "0", xl: "auto" }} />

<Box left="4" />
<Box left={{ initial: "0", xl: "auto" }} />
<ThemesPropsTable defs="positionPropDefs" />

Flex children

Each layout component has props used to control the style when it is a child of a flex container.

jsx
<Box flexBasis="100%" />
<Box flexShrink="0">
<Box flexGrow={{ initial: "0", lg: "1" }} />
<ThemesPropsTable defs="flexChildrenPropDefs" />

Grid children

Each layout component has props used to control the style when it is a child of a grid container.

jsx
<Box gridArea="header" />

<Box gridColumn="1 / 3" />
<Box gridColumnStart="2">
<Box gridColumnEnd={{ initial: "-1", md: "3", lg: "auto" }} />

<Box gridRow="1 / 3" />
<Box gridRowStart="2">
<Box gridRowEnd={{ initial: "-1", md: "3", lg: "auto" }} />
<ThemesPropsTable defs="gridChildrenPropDefs" />

Margin props

Margin props are available on most components in order to provide spacing around the elements. They are not exclusive to layout components.

Margin props can access the space scale steps or accept any valid CSS margin value

jsx
<Button m="4" />
<Button m="100px">
<Button m={{ sm: '6', lg: '9' }}>
<ThemesPropsTable defs="marginPropDefs" />

The margin props may be unavailable on components that don’t render a HTML node or rely on their Root part for layout.


Standalone usage

If needed, it’s possible to use just the layout component from Radix Themes. Just make sure that JavaScript tree-shaking works on your side, and import the CSS that powers the layout styles:

jsx
import "@radix-ui/themes/layout.css";

You’ll still have to wrap your app with Theme to provide the space scale and scaling factor settings.