Stack

Stack is a 1-dimensional layout system with options to control the direction, spacing, distribution and relative sizing of its children elements.

Usage

import { Stack } from 'nr1'

Examples

Basic

<div className="nr1-Example--stack">
  <div className="nr1-Example--stack--directionHorizontal">
    <span className="nr1-Example--stack--title">Horizontal (default)</span>
    <Stack preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>
</div>

Direction

<div className="nr1-Example--stack">
  <div className="nr1-Example--stack--directionHorizontal">
    <span className="nr1-Example--stack--title">Horizontal (default)</span>
    <Stack directionType={Stack.DIRECTION_TYPE.HORIZONTAL} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--directionVertical">
    <span className="nr1-Example--stack--title">Vertical</span>
    <Stack directionType={Stack.DIRECTION_TYPE.VERTICAL} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>
</div>

Gap

<div className="nr1-Example--stack">
  <div className="nr1-Example--stack--gapNone">
    <span className="nr1-Example--stack--title">None</span>
    <Stack gapType={Stack.GAP_TYPE.NONE} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--gapSmall">
    <span className="nr1-Example--stack--title">Small</span>
    <Stack gapType={Stack.GAP_TYPE.SMALL} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--gapMedium">
    <span className="nr1-Example--stack--title">Medium (default)</span>
    <Stack gapType={Stack.GAP_TYPE.MEDIUM} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--gapLarge">
    <span className="nr1-Example--stack--title">Large</span>
    <Stack gapType={Stack.GAP_TYPE.LARGE} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--gapExtraLarge">
    <span className="nr1-Example--stack--title">Extra large</span>
    <Stack gapType={Stack.GAP_TYPE.EXTRA_LARGE} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>
</div>

Horizontal alignment

<div className="nr1-Example--stack">
  <div className="nr1-Example--stack--horizontalAlignmentLeft">
    <span className="nr1-Example--stack--title">Left (default)</span>
    <Stack horizontalType={Stack.HORIZONTAL_TYPE.LEFT} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--horizontalAlignmentCenter">
    <span className="nr1-Example--stack--title">Center</span>
    <Stack horizontalType={Stack.HORIZONTAL_TYPE.CENTER} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--horizontalAlignmentRight">
    <span className="nr1-Example--stack--title">Right</span>
    <Stack horizontalType={Stack.HORIZONTAL_TYPE.RIGHT} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--horizontalAlignmentFill">
    <span className="nr1-Example--stack--title">Fill</span>
    <Stack horizontalType={Stack.HORIZONTAL_TYPE.FILL} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--horizontalAlignmentFillEvenly">
    <span className="nr1-Example--stack--title">Fill evenly</span>
    <Stack horizontalType={Stack.HORIZONTAL_TYPE.FILL_EVENLY} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>
</div>

Vertical alignment

<div className="nr1-Example--stack">
  <div className="nr1-Example--stack--verticalAlignmentTop">
    <span className="nr1-Example--stack--title">Top (default)</span>
    <Stack verticalType={Stack.VERTICAL_TYPE.TOP} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--verticalAlignmentCenter">
    <span className="nr1-Example--stack--title">Center</span>
    <Stack verticalType={Stack.VERTICAL_TYPE.CENTER} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--verticalAlignmentBottom">
    <span className="nr1-Example--stack--title">Bottom</span>
    <Stack verticalType={Stack.VERTICAL_TYPE.BOTTOM} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--verticalAlignmentFill">
    <span className="nr1-Example--stack--title">Fill</span>
    <Stack verticalType={Stack.VERTICAL_TYPE.FILL} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>


  <div className="nr1-Example--stack--verticalAlignmentFillEvenly">
    <span className="nr1-Example--stack--title">Fill evenly</span>
    <Stack verticalType={Stack.VERTICAL_TYPE.FILL_EVENLY} preview>
      <StackItem>
        <div className="nr1-Box--a">1</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--b">2</div>
      </StackItem>
      <StackItem>
        <div className="nr1-Box--c">3</div>
      </StackItem>
    </Stack>
  </div>
</div>

Props

children

REQUIRED

node

Stack items to display.

className

string

Appends class names to the component.Should be used only for positioning and spacing purposes.

directionType

enum

Direction of the stack items.

<One ofStack.DIRECTION_TYPE.HORIZONTAL,
Stack.DIRECTION_TYPE.VERTICAL,
>

fullHeight

boolean

Expands the stack to occupy all available height.

fullWidth

boolean

Expands the stack to occupy all available width.

gapType

enum

Space between each stack item.

<One ofStack.GAP_TYPE.EXTRA_LARGE,
Stack.GAP_TYPE.LARGE,
Stack.GAP_TYPE.MEDIUM,
Stack.GAP_TYPE.NONE,
Stack.GAP_TYPE.SMALL,
>

horizontalType

enum

Sets the horizontal alignment and distribution of the stack items.

<One ofStack.HORIZONTAL_TYPE.CENTER,
Stack.HORIZONTAL_TYPE.FILL,
Stack.HORIZONTAL_TYPE.FILL_EVENLY,
Stack.HORIZONTAL_TYPE.LEFT,
Stack.HORIZONTAL_TYPE.RIGHT,
>

preview

boolean

Visually draws the boxes of the Stack and its StackItems.

spacingType

enum[]

Spacing property. Spacing is defined as a tuple of zero to four values, which follow the same conventions as CSS properties like margin or padding. To omit a value, use SPACING_TYPE.OMIT.

<Array of<One ofStack.SPACING_TYPE.EXTRA_LARGE,
Stack.SPACING_TYPE.LARGE,
Stack.SPACING_TYPE.MEDIUM,
Stack.SPACING_TYPE.NONE,
Stack.SPACING_TYPE.OMIT,
Stack.SPACING_TYPE.SMALL,
>
>

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.

verticalType

enum

Sets the vertical alignment and distribution of the stack items.

<One ofStack.VERTICAL_TYPE.BOTTOM,
Stack.VERTICAL_TYPE.CENTER,
Stack.VERTICAL_TYPE.FILL,
Stack.VERTICAL_TYPE.FILL_EVENLY,
Stack.VERTICAL_TYPE.TOP
>

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

Examples

Basic

Direction

Gap

Horizontal alignment

Vertical alignment

Props

REQUIRED

node

string

enum

boolean

boolean

enum

enum

boolean

enum[]

object

string

enum

Usage