File: Grid.md

package info (click to toggle)
cockpit 354-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 308,956 kB
  • sloc: javascript: 775,606; python: 40,351; ansic: 35,655; cpp: 11,117; sh: 3,511; makefile: 580; xml: 261
file content (324 lines) | stat: -rw-r--r-- 10,978 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
---
id: Grid
section: layouts
cssPrefix: pf-v6-l-grid
---import './Grid.css'

## Examples

### Smart (responsive)

```html
<div
  class="pf-v6-l-grid pf-m-all-6-col-on-sm pf-m-all-4-col-on-md pf-m-all-2-col-on-lg pf-m-all-1-col-on-xl"
>
  <div class="pf-v6-l-grid__item">item 1</div>
  <div class="pf-v6-l-grid__item">item 2</div>
  <div class="pf-v6-l-grid__item">item 3</div>
  <div class="pf-v6-l-grid__item">item 4</div>
  <div class="pf-v6-l-grid__item">item 5</div>
  <div class="pf-v6-l-grid__item">item 6</div>
  <div class="pf-v6-l-grid__item">item 7</div>
  <div class="pf-v6-l-grid__item">item 8</div>
  <div class="pf-v6-l-grid__item">item 9</div>
  <div class="pf-v6-l-grid__item">item 10</div>
  <div class="pf-v6-l-grid__item">item 11</div>
  <div class="pf-v6-l-grid__item">item 12</div>
</div>

```

### Smart with overrides (responsive)

```html
<div
  class="pf-v6-l-grid pf-m-all-6-col-on-sm pf-m-all-4-col-on-md pf-m-all-2-col-on-lg pf-m-all-1-col-on-xl"
>
  <div
    class="pf-v6-l-grid__item pf-m-8-col-on-sm pf-m-4-col-on-lg pf-m-6-col-on-xl"
  >item 1</div>
  <div
    class="pf-v6-l-grid__item pf-m-4-col-on-sm pf-m-8-col-on-lg pf-m-6-col-on-xl"
  >item 2</div>
  <div class="pf-v6-l-grid__item">item 3</div>
  <div class="pf-v6-l-grid__item">item 4</div>
  <div class="pf-v6-l-grid__item">item 5</div>
  <div class="pf-v6-l-grid__item">item 6</div>
  <div class="pf-v6-l-grid__item">item 7</div>
  <div class="pf-v6-l-grid__item">item 8</div>
  <div class="pf-v6-l-grid__item">item 9</div>
  <div class="pf-v6-l-grid__item">item 10</div>
  <div class="pf-v6-l-grid__item">item 11</div>
  <div class="pf-v6-l-grid__item">item 12</div>
  <div class="pf-v6-l-grid__item">item 13</div>
  <div class="pf-v6-l-grid__item">item 14</div>
</div>

```

### Base

```html
<div class="pf-v6-l-grid">
  <div class="pf-v6-l-grid__item pf-m-12-col">12 col</div>
  <div class="pf-v6-l-grid__item pf-m-11-col">11 col</div>
  <div class="pf-v6-l-grid__item pf-m-1-col">1 col</div>
  <div class="pf-v6-l-grid__item pf-m-10-col">10 col</div>
  <div class="pf-v6-l-grid__item pf-m-2-col">2 col</div>
  <div class="pf-v6-l-grid__item pf-m-9-col">9 col</div>
  <div class="pf-v6-l-grid__item pf-m-3-col">3 col</div>
  <div class="pf-v6-l-grid__item pf-m-8-col">8 col</div>
  <div class="pf-v6-l-grid__item pf-m-4-col">4 col</div>
  <div class="pf-v6-l-grid__item pf-m-7-col">7 col</div>
  <div class="pf-v6-l-grid__item pf-m-5-col">5 col</div>
</div>

```

### Gutter

```html
<div class="pf-v6-l-grid pf-m-gutter">
  <div class="pf-v6-l-grid__item pf-m-12-col">12 col</div>
  <div class="pf-v6-l-grid__item pf-m-11-col">11 col</div>
  <div class="pf-v6-l-grid__item pf-m-1-col">1 col</div>
  <div class="pf-v6-l-grid__item pf-m-10-col">10 col</div>
  <div class="pf-v6-l-grid__item pf-m-2-col">2 col</div>
  <div class="pf-v6-l-grid__item pf-m-9-col">9 col</div>
  <div class="pf-v6-l-grid__item pf-m-3-col">3 col</div>
</div>

```

### Responsive

```html
<div class="pf-v6-l-grid">
  <div
    class="pf-v6-l-grid__item pf-m-1-col pf-m-6-col-on-md pf-m-11-col-on-xl"
  >1 / 6 / 11 col</div>
  <div
    class="pf-v6-l-grid__item pf-m-11-col pf-m-6-col-on-md pf-m-1-col-on-xl"
  >11 / 6 / 1 col</div>
  <div
    class="pf-v6-l-grid__item pf-m-2-col pf-m-6-col-on-md pf-m-10-col-on-xl"
  >2 / 6 / 10 col</div>
  <div
    class="pf-v6-l-grid__item pf-m-10-col pf-m-6-col-on-md pf-m-2-col-on-xl"
  >10 / 6 / 2 col</div>
  <div
    class="pf-v6-l-grid__item pf-m-3-col pf-m-6-col-on-md pf-m-9-col-on-xl"
  >3 / 6 / 9 col</div>
  <div
    class="pf-v6-l-grid__item pf-m-9-col pf-m-6-col-on-md pf-m-3-col-on-xl"
  >9 / 6 / 3 col</div>
  <div
    class="pf-v6-l-grid__item pf-m-4-col pf-m-6-col-on-md pf-m-8-col-on-xl"
  >4 / 6 / 8 col</div>
  <div
    class="pf-v6-l-grid__item pf-m-8-col pf-m-6-col-on-md pf-m-4-col-on-xl"
  >8 / 6 / 4 col</div>
  <div
    class="pf-v6-l-grid__item pf-m-5-col pf-m-6-col-on-md pf-m-7-col-on-xl"
  >5 / 6 / 7 col</div>
  <div
    class="pf-v6-l-grid__item pf-m-7-col pf-m-6-col-on-md pf-m-5-col-on-xl"
  >7 / 6 / 5 col</div>
</div>

```

### Nested

```html
<div class="pf-v6-l-grid">
  <div class="pf-v6-l-grid__item pf-m-12-col">12 col</div>
  <div class="pf-v6-l-grid__item pf-m-10-col">
    10 col
    <div class="pf-v6-l-grid pf-m-gutter">
      <div class="pf-v6-l-grid__item pf-m-6-col">6 col</div>
      <div class="pf-v6-l-grid__item pf-m-6-col">6 col</div>
      <div class="pf-v6-l-grid__item pf-m-4-col">4 col</div>
      <div class="pf-v6-l-grid__item pf-m-8-col">8 col</div>
    </div>
  </div>
  <div class="pf-v6-l-grid__item pf-m-2-col">2 col</div>
</div>

```

### Offsets

```html
<div class="pf-v6-l-grid pf-m-gutter">
  <div class="pf-v6-l-grid__item pf-m-11-col pf-m-offset-1-col">11 col, offset 1</div>
  <div class="pf-v6-l-grid__item pf-m-10-col pf-m-offset-2-col">10 col, offset 2</div>
  <div class="pf-v6-l-grid__item pf-m-9-col pf-m-offset-3-col">9 col, offset 3</div>
  <div class="pf-v6-l-grid__item pf-m-8-col pf-m-offset-4-col">8 col, offset 4</div>
</div>

```

### Row spans

```html
<div class="pf-v6-l-grid pf-m-gutter">
  <div class="pf-v6-l-grid__item pf-m-8-col">8 col</div>
  <div class="pf-v6-l-grid__item pf-m-4-col pf-m-2-row">4 col, 2 row</div>
  <div class="pf-v6-l-grid__item pf-m-2-col pf-m-3-row">2 col, 3 row</div>
  <div class="pf-v6-l-grid__item pf-m-2-col">2 col</div>
  <div class="pf-v6-l-grid__item pf-m-4-col">4 col</div>
  <div class="pf-v6-l-grid__item pf-m-2-col">2 col</div>
  <div class="pf-v6-l-grid__item pf-m-2-col">2 col</div>
  <div class="pf-v6-l-grid__item pf-m-2-col">2 col</div>
  <div class="pf-v6-l-grid__item pf-m-4-col">4 col</div>
  <div class="pf-v6-l-grid__item pf-m-2-col">2 col</div>
  <div class="pf-v6-l-grid__item pf-m-4-col">4 col</div>
  <div class="pf-v6-l-grid__item pf-m-4-col">4 col</div>
</div>

```

### As a list

```html
<ul class="pf-v6-l-grid pf-m-all-6-col-on-sm">
  <li class="pf-v6-l-grid__item">item 1</li>
  <li class="pf-v6-l-grid__item">item 2</li>
  <li class="pf-v6-l-grid__item">item 3</li>
  <li class="pf-v6-l-grid__item">item 4</li>
</ul>

```

## Ordering

Ordering - Ordering can be applied to nested <code>.pf-v6-l-grid</code> and <code>.pf-v6-l-grid\_\_item</code>s. Spacing may need to be managed based on how items are ordered. Because order could apply to an innumerable number of elements, order is set inline as `--pf-v6-l-grid--item--Order{-on-[breakpoint]}: {order}`.

### Ordering example

```html
<div class="pf-v6-l-grid pf-m-all-4-col pf-m-gutter">
  <div class="pf-v6-l-grid__item" style="--pf-v6-l-grid--item--Order: 2;">Item A</div>
  <div class="pf-v6-l-grid__item">Item B</div>
  <div
    class="pf-v6-l-grid__item"
    style="--pf-v6-l-grid--item--Order: -1;"
  >Item C</div>
</div>

```

### Responsive ordering

```html
<div class="pf-v6-l-grid pf-m-all-4-col pf-m-gutter">
  <div
    class="pf-v6-l-grid__item"
    style="--pf-v6-l-grid--item--Order-on-lg: 2;"
  >Item A</div>
  <div class="pf-v6-l-grid__item">Item B</div>
  <div
    class="pf-v6-l-grid__item"
    style="--pf-v6-l-grid--item--Order: -1; --pf-v6-l-grid--item--Order-on-md: 1;"
  >Item C</div>
</div>

```

### Grouped ordering

```html
<div class="pf-v6-l-grid pf-m-all-6-col-on-md pf-m-gutter">
  <div class="pf-v6-l-grid pf-m-gutter" style="--pf-v6-l-grid--item--Order: 2;">
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order: 3;"
    >Set 1, Item A</div>
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order: 1;"
    >Set 1, Item B</div>
    <div class="pf-v6-l-grid__item">Set 1, Item C</div>
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order: 2;"
    >Set 1, Item D</div>
  </div>
  <div class="pf-v6-l-grid pf-m-gutter">
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order: 3;"
    >Set 2, Item A</div>
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order: 1;"
    >Set 2, Item B</div>
    <div class="pf-v6-l-grid__item">Set 2, Item C</div>
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order: 2;"
    >Set 2, Item D</div>
  </div>
</div>

```

### Grouped, responsive ordering

```html
<div class="pf-v6-l-grid pf-m-all-6-col-on-md pf-m-gutter">
  <div
    class="pf-v6-l-grid pf-m-gutter"
    style="--pf-v6-l-grid--item--Order-on-lg: 2;"
  >
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order-on-md: 3;"
    >Set 1, Item A</div>
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order-on-md: 1;"
    >Set 1, Item B</div>
    <div class="pf-v6-l-grid__item">Set 1, Item C</div>
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order-on-xl: 2;"
    >Set 1, Item D</div>
  </div>
  <div class="pf-v6-l-grid pf-m-gutter">
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order: 3;"
    >Set 2, Item A</div>
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order: 1;"
    >Set 2, Item B</div>
    <div class="pf-v6-l-grid__item">Set 2, Item C</div>
    <div
      class="pf-v6-l-grid__item"
      style="--pf-v6-l-grid--item--Order: 2;"
    >Set 2, Item D</div>
  </div>
</div>

```

## Documentation

### Overview

The grid layout is based on CSS Grid’s two-dimensional system of columns and rows. This layout styles the parent element and its children to achieve responsive column and row spans as well as gutters.

### Usage

| Class | Applied to | Outcome |
| -- | -- | -- |
| `.pf-v6-l-grid` | `<div>` | Initializes the grid layout. |
| `.pf-v6-l-grid__item` | `<div>` | Explicitly sets a child of the grid. This class isn't necessary, but it is included to keep inline with BEM convention, and to provide an entity that will later be used for applying modifiers. |
| `.pf-m-gutter` | `.pf-v6-l-grid` | Adds space between children by using the globally defined gutter value. |
| `.pf-m-all-{1-12}-col{-on-[breakpoint]}` | `.pf-v6-l-grid` | Defines grid item size on grid container at optional [breakpoint](/tokens/all-patternfly-tokens). |
| `.pf-m-{1-12}-col{-on-[breakpoint]}` | `.pf-v6-l-grid__item` | Defines grid item size at optional [breakpoint](/tokens/all-patternfly-tokens).  Although not required, they are strongly suggested. If not used, grid item will default to 12 col. |
| `.pf-m-{2-x}-row{-on-[breakpoint]}` | `.pf-v6-l-grid__item` | Defines grid item row span at optional [breakpoint](/tokens/all-patternfly-tokens).  For row spans to function correctly, the value of of the current row plus the grid items to span must be equal to or less than 12. Example: `.pf-m-8-col.pf-m-2-row` + `.pf-m-4-col` + `.pf-m-4-col`. There is no limit to number of spanned rows. |
| `--pf-v6-l-grid--item--Order{-on-[breakpoint]}: {order}` | `.pf-v6-l-grid > .pf-v6-l-grid`, `.pf-v6-l-grid__item` | Modifies the order of the grid layout element at optional [breakpoint](/tokens/all-patternfly-tokens). |