File: EmptyState.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 (332 lines) | stat: -rw-r--r-- 13,445 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
325
326
327
328
329
330
331
332
---
id: Empty state
section: components
cssPrefix: pf-v6-c-empty-state
---## Examples

### Basic

```html
<div class="pf-v6-c-empty-state">
  <div class="pf-v6-c-empty-state__content">
    <div class="pf-v6-c-empty-state__header">
      <div class="pf-v6-c-empty-state__icon">
        <i class="fas fa-cubes" aria-hidden="true"></i>
      </div>
      <div class="pf-v6-c-empty-state__title">
        <h4 class="pf-v6-c-empty-state__title-text">Empty state</h4>
      </div>
    </div>

    <div
      class="pf-v6-c-empty-state__body"
    >This represents an the empty state pattern in PatternFly. Hopefully it's simple enough to use but flexible enough to meet a variety of needs.</div>

    <div class="pf-v6-c-empty-state__footer">
      <div class="pf-v6-c-empty-state__actions">
        <button class="pf-v6-c-button pf-m-primary" type="button">
          <span class="pf-v6-c-button__text">Primary action</span>
        </button>
      </div>
      <div class="pf-v6-c-empty-state__actions">
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Multiple</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action buttons</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Can</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Go here</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">In the second</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action area</span>
        </button>
      </div>
    </div>
  </div>
</div>

```

### Extra small

```html
<div class="pf-v6-c-empty-state pf-m-xs">
  <div class="pf-v6-c-empty-state__content">
    <div class="pf-v6-c-empty-state__header">
      <div class="pf-v6-c-empty-state__icon">
        <i class="fas fa-cubes" aria-hidden="true"></i>
      </div>
      <div class="pf-v6-c-empty-state__title">
        <h4 class="pf-v6-c-empty-state__title-text">Empty state</h4>
      </div>
    </div>

    <div
      class="pf-v6-c-empty-state__body"
    >This represents an the empty state pattern in PatternFly. The icon is optional.</div>

    <div class="pf-v6-c-empty-state__footer">
      <div class="pf-v6-c-empty-state__actions">
        <button class="pf-v6-c-button pf-m-small pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Multiple</span>
        </button>
        <button class="pf-v6-c-button pf-m-small pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action buttons</span>
        </button>
        <button class="pf-v6-c-button pf-m-small pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Can</span>
        </button>
        <button class="pf-v6-c-button pf-m-small pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Go here</span>
        </button>
        <button class="pf-v6-c-button pf-m-small pf-m-link" type="button">
          <span class="pf-v6-c-button__text">In the</span>
        </button>
        <button class="pf-v6-c-button pf-m-small pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action area</span>
        </button>
      </div>
    </div>
  </div>
</div>

```

### Small

```html
<div class="pf-v6-c-empty-state pf-m-sm">
  <div class="pf-v6-c-empty-state__content">
    <div class="pf-v6-c-empty-state__header">
      <div class="pf-v6-c-empty-state__icon">
        <i class="fas fa-cubes" aria-hidden="true"></i>
      </div>
      <div class="pf-v6-c-empty-state__title">
        <h4 class="pf-v6-c-empty-state__title-text">Empty state</h4>
      </div>
    </div>

    <div
      class="pf-v6-c-empty-state__body"
    >This represents an the empty state pattern in PatternFly. Hopefully it's simple enough to use but flexible enough to meet a variety of needs.</div>

    <div class="pf-v6-c-empty-state__footer">
      <div class="pf-v6-c-empty-state__actions">
        <button class="pf-v6-c-button pf-m-primary" type="button">
          <span class="pf-v6-c-button__text">Primary action</span>
        </button>
      </div>

      <div class="pf-v6-c-empty-state__actions">
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Multiple</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action buttons</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Can</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Go here</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">In the second</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action area</span>
        </button>
      </div>
    </div>
  </div>
</div>

```

### Large

```html
<div class="pf-v6-c-empty-state pf-m-lg">
  <div class="pf-v6-c-empty-state__content">
    <div class="pf-v6-c-empty-state__header">
      <div class="pf-v6-c-empty-state__icon">
        <i class="fas fa-cubes" aria-hidden="true"></i>
      </div>
      <div class="pf-v6-c-empty-state__title">
        <h4 class="pf-v6-c-empty-state__title-text">Empty state</h4>
      </div>
    </div>

    <div
      class="pf-v6-c-empty-state__body"
    >This represents an the empty state pattern in PatternFly. Hopefully it's simple enough to use but flexible enough to meet a variety of needs.</div>

    <div class="pf-v6-c-empty-state__footer">
      <div class="pf-v6-c-empty-state__actions">
        <button class="pf-v6-c-button pf-m-primary" type="button">
          <span class="pf-v6-c-button__text">Primary action</span>
        </button>
      </div>
      <div class="pf-v6-c-empty-state__actions">
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Multiple</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action buttons</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Can</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Go here</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">In the second</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action area</span>
        </button>
      </div>
    </div>
  </div>
</div>

```

### Extra large

```html
<div class="pf-v6-c-empty-state pf-m-xl">
  <div class="pf-v6-c-empty-state__content">
    <div class="pf-v6-c-empty-state__header">
      <div class="pf-v6-c-empty-state__icon">
        <i class="fas fa-cubes" aria-hidden="true"></i>
      </div>
      <div class="pf-v6-c-empty-state__title">
        <h4 class="pf-v6-c-empty-state__title-text">Empty state</h4>
      </div>
    </div>

    <div
      class="pf-v6-c-empty-state__body"
    >This represents an the empty state pattern in PatternFly. Hopefully it's simple enough to use but flexible enough to meet a variety of needs.</div>
    <div class="pf-v6-c-empty-state__footer">
      <div class="pf-v6-c-empty-state__actions">
        <button class="pf-v6-c-button pf-m-primary" type="button">
          <span class="pf-v6-c-button__text">Primary action</span>
        </button>
      </div>
      <div class="pf-v6-c-empty-state__actions">
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Multiple</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action buttons</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Can</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Go here</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">In the second</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action area</span>
        </button>
      </div>
    </div>
  </div>
</div>

```

### With status

```html
<div class="pf-v6-c-empty-state pf-m-success">
  <div class="pf-v6-c-empty-state__content">
    <div class="pf-v6-c-empty-state__header">
      <div class="pf-v6-c-empty-state__icon">
        <i class="fas fa- fa-check-circle" aria-hidden="true"></i>
      </div>
      <div class="pf-v6-c-empty-state__title">
        <h4 class="pf-v6-c-empty-state__title-text">You're all set</h4>
      </div>
    </div>

    <div
      class="pf-v6-c-empty-state__body"
    >This represents an the empty state pattern in PatternFly. Hopefully it's simple enough to use but flexible enough to meet a variety of needs.</div>

    <div class="pf-v6-c-empty-state__footer">
      <div class="pf-v6-c-empty-state__actions">
        <button class="pf-v6-c-button pf-m-primary" type="button">
          <span class="pf-v6-c-button__text">Primary action</span>
        </button>
      </div>
      <div class="pf-v6-c-empty-state__actions">
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Multiple</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action buttons</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Can</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Go here</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">In the second</span>
        </button>
        <button class="pf-v6-c-button pf-m-link" type="button">
          <span class="pf-v6-c-button__text">Action area</span>
        </button>
      </div>
    </div>
  </div>
</div>

```

## Documentation

### Accessibility

| Attribute | Applied to | Outcome |
| -- | -- | -- |
| `aria-hidden="true"` | `.pf-v6-c-empty-state__icon` |  Hides icon for assistive technologies. **Required** |

### Usage

| Class | Applied to | Outcome |
| -- | -- | -- |
| `.pf-v6-c-empty-state` | `<div>` |  Initiates an empty state component. The empty state centers its content (`.pf-v6-c-empty-state__content`) vertically and horizontally. **Required** |
| `.pf-v6-c-empty-state__content` | `<div>` |  Creates the content container. **Required** |
| `.pf-v6-c-empty-state__header` | `<div>` |  Creates the header container. **Required** |
| `.pf-v6-c-empty-state__title` | `<div>` |  Creates the empty state title container. **Required** |
| `.pf-v6-c-empty-state__title-text` | `<h1>`, `<h2>`, `<h3>`, `<h4>`, `<h5>`, `<h6>`, `<div>` |  Creates the empty state title text container. |
| `.pf-v6-c-empty-state__icon` | `<div>` |  Creates the empty state icon container. |
| `.pf-v6-c-empty-state__body` | `<div>` |  Creates the empty state body content. There can be more than one `.pf-v6-c-empty-state__body` elements. |
| `.pf-v6-c-empty-state__footer` | `<div>` |  Creates the footer container. **Required** |
| `.pf-v6-c-empty-state__actions` | `<div>` |  Container for actions. **Required** |
| `.pf-m-xs` | `.pf-v6-c-empty-state` | Modifies the empty state for an extra small variation and max-width. |
| `.pf-m-sm` | `.pf-v6-c-empty-state` | Modifies the empty state for a small max-width. |
| `.pf-m-lg` | `.pf-v6-c-empty-state` | Modifies the empty state for a large max-width. |
| `.pf-m-xl` | `.pf-v6-c-empty-state` | Modifies the empty state for an extra large variation and max-width. |
| `.pf-m-full-height` | `.pf-v6-c-empty-state` | Modifies the empty state to be `height: 100%`. If you need the empty state content to be centered vertically, you can use this modifier to make the empty state fill the height of its container, and center `.pf-v6-c-empty-state__content`. **Note:** this modifier requires the parent of `.pf-v6-c-empty-state` have an implicit or explicit `height` defined.  |
| `.pf-m-danger` | `.pf-v6-c-empty-state` | Modifies the empty state for danger status. |
| `.pf-m-warning` | `.pf-v6-c-empty-state` | Modifies the empty state for warning status. |
| `.pf-m-success` | `.pf-v6-c-empty-state` | Modifies the empty state for success status. |
| `.pf-m-info` | `.pf-v6-c-empty-state` | Modifies the empty state for info status. |
| `.pf-m-custom` | `.pf-v6-c-empty-state` | Modifies the empty state for custom status. |