Grid | New Relic Developers

Grid is a 2-dimensional layout system, meaning that it can handle both columns and rows, that helps you design grid-based user interfaces, unlike <Stack> which is largely a 1-dimensional system.

Usage

import { Grid } from 'nr1'

Examples

Basic

<>
  <Grid>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={1}>
      <div className="nr1-RedBox">1</div>
    </GridItem>
    <GridItem columnSpan={2}>
      <div className="nr1-RedBox">2</div>
    </GridItem>
    <GridItem columnSpan={2}>
      <div className="nr1-RedBox">2</div>
    </GridItem>
    <GridItem columnSpan={2}>
      <div className="nr1-RedBox">2</div>
    </GridItem>
    <GridItem columnSpan={2}>
      <div className="nr1-RedBox">2</div>
    </GridItem>
    <GridItem columnSpan={2}>
      <div className="nr1-RedBox">2</div>
    </GridItem>
    <GridItem columnSpan={2}>
      <div className="nr1-RedBox">2</div>
    </GridItem>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={6}>
      <div className="nr1-RedBox">6</div>
    </GridItem>
    <GridItem columnSpan={6}>
      <div className="nr1-RedBox">6</div>
    </GridItem>
    <GridItem columnSpan={12}>
      <div className="nr1-RedBox">12</div>
    </GridItem>
  </Grid>
</>;

1
<>
2
  <Grid>
3
    <GridItem columnSpan={1}>
4
      <div className="nr1-RedBox">1</div>
5
    </GridItem>
6
    <GridItem columnSpan={1}>
7
      <div className="nr1-RedBox">1</div>
8
    </GridItem>
9
    <GridItem columnSpan={1}>
10
      <div className="nr1-RedBox">1</div>
11
    </GridItem>
12
    <GridItem columnSpan={1}>
13
      <div className="nr1-RedBox">1</div>
14
    </GridItem>
15
    <GridItem columnSpan={1}>
16
      <div className="nr1-RedBox">1</div>
17
    </GridItem>
18
    <GridItem columnSpan={1}>
19
      <div className="nr1-RedBox">1</div>
20
    </GridItem>
21
    <GridItem columnSpan={1}>
22
      <div className="nr1-RedBox">1</div>
23
    </GridItem>
24
    <GridItem columnSpan={1}>
25
      <div className="nr1-RedBox">1</div>
26
    </GridItem>
27
    <GridItem columnSpan={1}>
28
      <div className="nr1-RedBox">1</div>
29
    </GridItem>
30
    <GridItem columnSpan={1}>
31
      <div className="nr1-RedBox">1</div>
32
    </GridItem>
33
    <GridItem columnSpan={1}>
34
      <div className="nr1-RedBox">1</div>
35
    </GridItem>
36
    <GridItem columnSpan={1}>
37
      <div className="nr1-RedBox">1</div>
38
    </GridItem>
39
    <GridItem columnSpan={2}>
40
      <div className="nr1-RedBox">2</div>
41
    </GridItem>
42
    <GridItem columnSpan={2}>
43
      <div className="nr1-RedBox">2</div>
44
    </GridItem>
45
    <GridItem columnSpan={2}>
46
      <div className="nr1-RedBox">2</div>
47
    </GridItem>
48
    <GridItem columnSpan={2}>
49
      <div className="nr1-RedBox">2</div>
50
    </GridItem>
51
    <GridItem columnSpan={2}>
52
      <div className="nr1-RedBox">2</div>
53
    </GridItem>
54
    <GridItem columnSpan={2}>
55
      <div className="nr1-RedBox">2</div>
56
    </GridItem>
57
    <GridItem columnSpan={3}>
58
      <div className="nr1-RedBox">3</div>
59
    </GridItem>
60
    <GridItem columnSpan={3}>
61
      <div className="nr1-RedBox">3</div>
62
    </GridItem>
63
    <GridItem columnSpan={3}>
64
      <div className="nr1-RedBox">3</div>
65
    </GridItem>
66
    <GridItem columnSpan={3}>
67
      <div className="nr1-RedBox">3</div>
68
    </GridItem>
69
    <GridItem columnSpan={4}>
70
      <div className="nr1-RedBox">4</div>
71
    </GridItem>
72
    <GridItem columnSpan={4}>
73
      <div className="nr1-RedBox">4</div>
74
    </GridItem>
75
    <GridItem columnSpan={4}>
76
      <div className="nr1-RedBox">4</div>
77
    </GridItem>
78
    <GridItem columnSpan={6}>
79
      <div className="nr1-RedBox">6</div>
80
    </GridItem>
81
    <GridItem columnSpan={6}>
82
      <div className="nr1-RedBox">6</div>
83
    </GridItem>
84
    <GridItem columnSpan={12}>
85
      <div className="nr1-RedBox">12</div>
86
    </GridItem>
87
  </Grid>
88
</>;

ReferenceError: Grid is not defined

Medium gap type

<>
  <Grid gapType={Grid.GAP_TYPE.MEDIUM}>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
  </Grid>
</>;

1
<>
2
  <Grid gapType={Grid.GAP_TYPE.MEDIUM}>
3
    <GridItem columnSpan={3}>
4
      <div className="nr1-RedBox">3</div>
5
    </GridItem>
6
    <GridItem columnSpan={3}>
7
      <div className="nr1-RedBox">3</div>
8
    </GridItem>
9
    <GridItem columnSpan={3}>
10
      <div className="nr1-RedBox">3</div>
11
    </GridItem>
12
    <GridItem columnSpan={3}>
13
      <div className="nr1-RedBox">3</div>
14
    </GridItem>
15
    <GridItem columnSpan={4}>
16
      <div className="nr1-RedBox">4</div>
17
    </GridItem>
18
    <GridItem columnSpan={4}>
19
      <div className="nr1-RedBox">4</div>
20
    </GridItem>
21
    <GridItem columnSpan={4}>
22
      <div className="nr1-RedBox">4</div>
23
    </GridItem>
24
  </Grid>
25
</>;

ReferenceError: Grid is not defined

Small gap type

<>
  <Grid gapType={Grid.GAP_TYPE.SMALL}>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={3}>
      <div className="nr1-RedBox">3</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
  </Grid>
</>;

1
<>
2
  <Grid gapType={Grid.GAP_TYPE.SMALL}>
3
    <GridItem columnSpan={3}>
4
      <div className="nr1-RedBox">3</div>
5
    </GridItem>
6
    <GridItem columnSpan={3}>
7
      <div className="nr1-RedBox">3</div>
8
    </GridItem>
9
    <GridItem columnSpan={3}>
10
      <div className="nr1-RedBox">3</div>
11
    </GridItem>
12
    <GridItem columnSpan={3}>
13
      <div className="nr1-RedBox">3</div>
14
    </GridItem>
15
    <GridItem columnSpan={4}>
16
      <div className="nr1-RedBox">4</div>
17
    </GridItem>
18
    <GridItem columnSpan={4}>
19
      <div className="nr1-RedBox">4</div>
20
    </GridItem>
21
    <GridItem columnSpan={4}>
22
      <div className="nr1-RedBox">4</div>
23
    </GridItem>
24
  </Grid>
25
</>;

ReferenceError: Grid is not defined

Columns

<Grid>
  <GridItem columnStart={1} columnEnd={6}>
    <div className="nr1-RedBox">6</div>
  </GridItem>
  <GridItem columnStart={2} columnEnd={7}>
    <div className="nr1-RedBox">6</div>
  </GridItem>
  <GridItem columnStart={3} columnEnd={8}>
    <div className="nr1-RedBox">6</div>
  </GridItem>
  <GridItem columnStart={4} columnEnd={9}>
    <div className="nr1-RedBox">6</div>
  </GridItem>
  <GridItem columnStart={5} columnEnd={10}>
    <div className="nr1-RedBox">6</div>
  </GridItem>
  <GridItem columnStart={6} columnEnd={11}>
    <div className="nr1-RedBox">6</div>
  </GridItem>
  <GridItem columnStart={7} columnEnd={12}>
    <div className="nr1-RedBox">6</div>
  </GridItem>
</Grid>;

1
<Grid>
2
  <GridItem columnStart={1} columnEnd={6}>
3
    <div className="nr1-RedBox">6</div>
4
  </GridItem>
5
  <GridItem columnStart={2} columnEnd={7}>
6
    <div className="nr1-RedBox">6</div>
7
  </GridItem>
8
  <GridItem columnStart={3} columnEnd={8}>
9
    <div className="nr1-RedBox">6</div>
10
  </GridItem>
11
  <GridItem columnStart={4} columnEnd={9}>
12
    <div className="nr1-RedBox">6</div>
13
  </GridItem>
14
  <GridItem columnStart={5} columnEnd={10}>
15
    <div className="nr1-RedBox">6</div>
16
  </GridItem>
17
  <GridItem columnStart={6} columnEnd={11}>
18
    <div className="nr1-RedBox">6</div>
19
  </GridItem>
20
  <GridItem columnStart={7} columnEnd={12}>
21
    <div className="nr1-RedBox">6</div>
22
  </GridItem>
23
</Grid>;

ReferenceError: Grid is not defined

Collapse gap

<>
  <Grid>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4} collapseGapBefore>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4} collapseGapBefore collapseGapAfter>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4} collapseGapAfter>
      <div className="nr1-RedBox">4</div>
    </GridItem>
    <GridItem columnSpan={4}>
      <div className="nr1-RedBox">4</div>
    </GridItem>
  </Grid>
</>;

1
<>
2
  <Grid>
3
    <GridItem columnSpan={4}>
4
      <div className="nr1-RedBox">4</div>
5
    </GridItem>
6
    <GridItem columnSpan={4} collapseGapBefore>
7
      <div className="nr1-RedBox">4</div>
8
    </GridItem>
9
    <GridItem columnSpan={4}>
10
      <div className="nr1-RedBox">4</div>
11
    </GridItem>
12
    <GridItem columnSpan={4}>
13
      <div className="nr1-RedBox">4</div>
14
    </GridItem>
15
    <GridItem columnSpan={4} collapseGapBefore collapseGapAfter>
16
      <div className="nr1-RedBox">4</div>
17
    </GridItem>
18
    <GridItem columnSpan={4}>
19
      <div className="nr1-RedBox">4</div>
20
    </GridItem>
21
    <GridItem columnSpan={4}>
22
      <div className="nr1-RedBox">4</div>
23
    </GridItem>
24
    <GridItem columnSpan={4} collapseGapAfter>
25
      <div className="nr1-RedBox">4</div>
26
    </GridItem>
27
    <GridItem columnSpan={4}>
28
      <div className="nr1-RedBox">4</div>
29
    </GridItem>
30
  </Grid>
31
</>;

ReferenceError: Grid is not defined

Props

childrenrequirednode

Grid items to display.

Up to 12 items are allowed.

classNamestring

Appends class names to the component.

Should be used only for positioning and spacing purposes.

gapTypeenum

DEFAULT

Grid.GAP_TYPE.MEDIUM

Size of the gap between columns and rows.

<One ofGrid.GAP_TYPE.MEDIUM,
Grid.GAP_TYPE.SMALL,
>

spacingTypeenum[]

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 ofGrid.SPACING_TYPE.EXTRA_LARGE,
Grid.SPACING_TYPE.LARGE,
Grid.SPACING_TYPE.MEDIUM,
Grid.SPACING_TYPE.NONE,
Grid.SPACING_TYPE.OMIT,
Grid.SPACING_TYPE.SMALL,
>
>

styleobject

Inline style for custom styling.

Should be used only for positioning and spacing purposes.

testIdstring

Adds a data-test-id.

Used to target the component in unit and e2e testing.

Methods

`Grid.render`

function () => undefined