Skip to content

Latest commit

 

History

History
107 lines (78 loc) · 3.98 KB

readme.md

File metadata and controls

107 lines (78 loc) · 3.98 KB
Raw

React Layout

  • Drop-in. No config, Provider or other setup required. Use them where you need them.
  • Responsive. Each layout is built to adapt to smaller screen sizes. Instead of fixed @media breakpoints, our components work more like Container Queries and adapt their layout based on their own width.
  • Extremely small. Components are very small in size, so they don’t add bundle overhead. Plus, React Layout has no dependencies.
  • Customize and abstract however you want. You control the style and behavior of everything. React Layout does not contain any styles beside necessary layout CSS.
  • Zero config. Tweak style parameters and spacing rhythm via CSS Variables (a.k.a. CSS Custom Properties). No complicated setup.

React Layout focuses on providing simple layout primitives which make it possible to build all kinds of layouts, without writing much JS or CSS (or at all). This way you rarely have to manually write CSS Flex rules or fiddle with margin or @media breakpoints.

Layout components manage the layout and spacing for their direct children.

Install

npm install @quantargo/react-layout

Storybook

You can preview all layout components with Storybook, by running npm run storybook.

Usage

React Layout doesn’t need any configuration out-of-the-box.

To use e.g. a vertical stack for consistent spacing, import the LayoutVStack component and place children inside it:

function MySection () {
  return (
    <LayoutVStack
      gap={1.5}
      className='my-section'
    >
      <h4>Heading</h4>
      <p>
        Some text
      </p>
    </LayoutVStack>
  )
}

Use the gap prop to customize the amount of space between children. This, together with nesting multipe Layout*Stacks is a very powerful technique to create good looking and consistent components.

Similar to the vertical (|) LayoutVStack, there is a LayoutHStack for horizontal (—) layouts. LayoutHStack additionally provides a collapseAt prop, which ensures the layout collapses to a vertical one on narrow screens:

function MySection () {
  return (
    <LayoutHStack
      collapseAt='46em' // Children will collapse into a vertical layout when they reach 46em
      gap={5}
    >
      <LayoutVStack>
        <h4>Heading 1</h4>
        <p>
          Some text
        </p>
      </LayoutVStack>

      <LayoutVStack>
        <h4>Heading 2</h4>
        <p>
          Some text
        </p>
      </LayoutVStack>

      <LayoutVStack>
        <h4>Heading 3</h4>
        <p>
          Some text
        </p>
      </LayoutVStack>
    </LayoutHStack>
  )
}

Available Components

LayoutFlex → Direct CSS Flexbox abstraction. Supports most common flex attributes as props such as alignItems, justifyContent and direction (shorthand for flex-direction)

LayoutAuto → Based on LayoutFlex, but implements gap prop via the negative-margin-technique.

LayoutHStack → Horizontal stack; Adds collapseAt prop, via the Holy Albatross technique. Equally spaces its children.

LayoutVStack → Vertical stack

Configuration

React Layout doesn’t need any configuration out-of-the-box. The components should Just Work™.

Some components accept spacing or gap props to control the flow of the layout. These are defined as a number (not only integers, so 1.25 is also valid) and the default value assigned to 1 is 1rem. You can customize this relationship via the --rl-gap-size CSS variable. You can change it globally (e.g. on the html element) or locally by setting it on any HTML element:

.smaller-spacings {
  /* For all child elements `gap={1}` will be 0.5em, `gap={2}` will be 1em and so on */
  --rl-gap-size: 0.5em
}

—-rl-gap-size → Baseline multiplication unit for spacing/gap props; Defaults to 1em