@polym/generic-layout v1.1.3

@polym/generic-layout

Collection of React generic layout components inspired by Every-Layout

Demo & Document

Click here to visit the playground site where you can operate and play props.

Concept

as props

The container that realizes the layout is rendered in div by default, but this can be changed by as props.

The as can be

• HTML tag name
• React component
• styled component

Depending on the as, the ref and props that can be specified for the component will change.

If as is rendered as an HTML element, then all of the HTML attributes of that element can be specified as props.

If as is a component, the functions and styles that the component has are merged.

AspectFrame

Responsive images with preserved aspect ratio

<AspectFrame as={YourWrapper} {...moreProps}>
  <img src={yourImage} />
</AspectFrame>

Grid

Responsive grid layout without explicit media queries

<Grid as={YourWrapper} {...moreProps}>
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
</Grid>

HorizontalCenter

Horizontal Centering Layout

<HorizontalCenter as={YourWrapper} {...moreProps}>
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
</HorizontalCenter>

VerticalCenter

Layout that vertically centers any of several vertically aligned elements

<VerticalCenter as={YourWrapper} {...moreProps}>
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
</VerticalCenter>

HorizontalStack

Horizontal alignment layout that wraps nicely on small screens

<HorizontalStack as={YourWrapper} {...moreProps}>
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
</HorizontalStack>

VerticalStack

Layout with elements evenly spaced vertically

<VerticalStack {...args} as={NeedScrollContainer}>
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent>
    <YourComponent />
    <YourComponent />
    <YourComponent />
  </YourComponent>
  <YourComponent />
</VerticalStack>

SwitchStack

Layout switches from horizontal to vertical depending on screen width and number of elements

<SwitchStack as={YourWrapper} {...moreProps}>
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
</SwitchStack>

TwoColumn

Responsive two-column layout with side content and main content

<TwoColumn as={YourWrapper} {...moreProps}>
  <YourColumn1 />
  <YourColumn2 />
</TwoColumn>

OverlapLayer

Layout with layers on top of layers

Usage: Modal Dialog, Fixed Header, etc.

<OverlapLayer.Origin>
  <OverlapLayer.Upper as={YourWrapper} {...moreProps}>
    <YourOverlayInnerComponent />
  </OverlapLayer.Upper>
  <YourBackGroundComponent />
</OverlapLayer.Origin>

SliderAlign

Scrollable horizontal alignment layout

Usage: Carousel, etc.

<SliderAlign as={YourWrapper} {...moreProps}>
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
  <YourComponent />
</SliderAlign>