Layout

Layout is a 1-dimensional layout system with options to control the relative sizing of its children's elements. Layout spans the full width of the viewport area.

Usage

import { Layout } from 'nr1'

Examples

Basic

<Layout preview>
  <LayoutItem>
    <div className="nr1-Box">Main content</div>
  </LayoutItem>
</Layout>;

Split left small

<Layout preview>
  <LayoutItem
    type={LayoutItem.TYPE.SPLIT_LEFT}
    sizeType={LayoutItem.SIZE_TYPE.SMALL}
  >
    <div className="nr1-Box">Navigation</div>
  </LayoutItem>
  <LayoutItem>
    <div className="nr1-Box">Main content</div>
  </LayoutItem>
</Layout>;

Split right medium

<Layout preview>
  <LayoutItem>
    <div className="nr1-Box">Main content</div>
  </LayoutItem>
  <LayoutItem type={LayoutItem.TYPE.SPLIT_RIGHT}>
    <div className="nr1-Box">Activity stream</div>
  </LayoutItem>
</Layout>;

Split left small and split right medium

<Layout preview>
  <LayoutItem
    type={LayoutItem.TYPE.SPLIT_LEFT}
    sizeType={LayoutItem.SIZE_TYPE.SMALL}
  >
    <div className="nr1-Box">Navigation</div>
  </LayoutItem>
  <LayoutItem>
    <div className="nr1-Box">Main content</div>
  </LayoutItem>
  <LayoutItem type={LayoutItem.TYPE.SPLIT_RIGHT}>
    <div className="nr1-Box">Activity stream</div>
  </LayoutItem>
</Layout>;

Split left and right collapsible

<Layout preview fullHeight>
  <CollapsibleLayoutItem
    triggerType={CollapsibleLayoutItem.TRIGGER_TYPE.INBUILT}
    type={LayoutItem.TYPE.SPLIT_LEFT}
    sizeType={LayoutItem.SIZE_TYPE.SMALL}
  >
    <div className="nr1-Box">Navigation</div>
  </CollapsibleLayoutItem>

  <LayoutItem>
    <div className="nr1-Box">Main content</div>
  </LayoutItem>

  <CollapsibleLayoutItem
    triggerType={CollapsibleLayoutItem.TRIGGER_TYPE.INBUILT}
    type={LayoutItem.TYPE.SPLIT_RIGHT}
  >
    <div className="nr1-Box">Activity stream</div>
  </CollapsibleLayoutItem>
</Layout>;

Collapsible in controlled mode

class Example extends React.Component {
  constructor(props) {
    super(props);

    this.state = {
      collapsedLeft: false,
      collapsedRight: false,
    };
  }

  render() {
    return (
      <>
        <Stack>
          <StackItem>
            <label>
              Collapsed on the left side?
              <input
                type="checkbox"
                onChange={(e) =>
                  this.setState({ collapsedLeft: e.currentTarget.checked })
                }
              />
            </label>
          </StackItem>

          <StackItem>
            <label>
              Collapsed on the right side?
              <input
                type="checkbox"
                onChange={(e) =>
                  this.setState({ collapsedRight: e.currentTarget.checked })
                }
              />
            </label>
          </StackItem>
        </Stack>

        <Layout preview fullHeight>
          <CollapsibleLayoutItem
            collapsed={this.state.collapsedLeft}
            triggerType={CollapsibleLayoutItem.TRIGGER_TYPE.CUSTOM}
            type={LayoutItem.TYPE.SPLIT_LEFT}
            sizeType={LayoutItem.SIZE_TYPE.SMALL}
          >
            <div className="nr1-Box">Navigation</div>
          </CollapsibleLayoutItem>

          <LayoutItem>
            <div className="nr1-Box">Main content</div>
          </LayoutItem>

          <CollapsibleLayoutItem
            collapsed={this.state.collapsedRight}
            triggerType={CollapsibleLayoutItem.TRIGGER_TYPE.CUSTOM}
            type={LayoutItem.TYPE.SPLIT_RIGHT}
          >
            <div className="nr1-Box">Activity stream</div>
          </CollapsibleLayoutItem>
        </Layout>
      </>
    );
  }
}

Stacked layout

<>
  <Layout preview>
    <LayoutItem>
      <div className="nr1-Box">Chart</div>
    </LayoutItem>
  </Layout>
  <Layout preview>
    <LayoutItem
      type={LayoutItem.TYPE.SPLIT_LEFT}
      sizeType={LayoutItem.SIZE_TYPE.SMALL}
    >
      <div className="nr1-Box">Navigation</div>
    </LayoutItem>
    <LayoutItem>
      <div className="nr1-Box">Main Content</div>
    </LayoutItem>
  </Layout>
</>;

Props

children

REQUIRED

node

Layout items to display.

className

string

Appends class names to the component.

fullHeight

boolean

Expands the layout to occupy all available height.

preview

boolean

Visually draws the boxes of the layout and its layout items.

style

object

Inline style for custom styling.

testId

string

Adds a data-test-id attribute. Use it to target the component in unit and E2E tests.For a test id to be valid, prefix it with your nerdpack id, followed up by a dot.For example, my-nerdpack.some-element.

Note: You might not see data-test-id attributes as they are removed from the DOM, to debug them pass a e2e-test query parameter to the URL.

Usage.css-21sua1{background:none;border:none;width:0;padding:0;}

Examples

Basic

Split left small

Split right medium

Split left small and split right medium

Split left and right collapsible

Collapsible in controlled mode

Stacked layout

Props

REQUIRED

node

string

boolean

boolean

object

string

Usage