You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/documentation-site/patternfly-docs/content/design-guidelines/components/empty-state/empty-state.md
+67-23Lines changed: 67 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,14 @@ id: Empty state
3
3
section: components
4
4
---
5
5
6
+
import '../components.css';
7
+
6
8
## Elements
7
9
This is an example of a large, full-page empty state with all empty state elements. Other empty state variations contain the same elements and differ only in spacing and text sizes.
8
10
9
-
<imgsrc="./img/empty-state.png"alt="large empty state example with all elements"width="1500px"/>
11
+
<divclass="ws-docs-content-img">
12
+

13
+
</div>
10
14
11
15
1.**Icon**: The icon presents a visual component for easier recognition of the empty state’s message.
12
16
2.**Heading**: The title provides a concise description of the empty state’s purpose.
@@ -23,7 +27,9 @@ Getting started empty states appear when features haven’t been used yet. In yo
23
27
24
28
Use the [extra large empty state](#extra-large-empty-state) variation for getting started empty states.
25
29
26
-
<imgsrc="./img/xl-getstarted.png"alt="extra large empty state with welcome message"width="1500px"/>
30
+
<divclass="ws-docs-content-img">
31
+

32
+
</div>
27
33
28
34
**Heading**: Welcome the user to the product. Keep in mind that the user might be a bit nervous, so avoid exclamation points or other writing mechanics that make your tone sound excited.
29
35
@@ -62,7 +68,9 @@ In your empty state, explain that nothing was found and give the user a next ste
62
68
63
69
Use the [small empty state](#small-empty-state) variation for no results empty states.
64
70
65
-
<imgsrc="./img/no-data.png"alt="empty state showing no search results"width="1500px"/>
71
+
<divclass="ws-docs-content-img">
72
+

73
+
</div>
66
74
67
75
**Heading**: Briefly state that no results were found.
68
76
@@ -89,7 +97,9 @@ Required configuration empty states appear when the user needs to configure, con
89
97
90
98
Use the [large empty state](#large-empty-state) variation for required configuration empty states.
91
99
92
-
<imgsrc="./img/configuration.png"alt="empty state with system configuration information"width="1500px"/>
100
+
<divclass="ws-docs-content-img">
101
+

102
+
</div>
93
103
94
104
**Heading**: State what needs to be done instead of what hasn’t been done yet.
95
105
@@ -126,7 +136,9 @@ No access empty states appear when the user doesn’t have the entitlements or a
126
136
127
137
Use the [large empty state](#large-empty-state) variation for no access empty states.
128
138
129
-
<imgsrc="./img/access-denied.png"alt="empty state with information about access permissions"width="1500px"/>
139
+
<divclass="ws-docs-content-img">
140
+

141
+
</div>
130
142
131
143
**Heading**: State what the user needs to access the page instead of what they don’t have or can’t do.
132
144
@@ -163,7 +175,9 @@ Back-end failure empty states appear when an error occurs that prevents the syst
163
175
164
176
Use the [large empty state](#large-empty-state) variation for back-end failure empty states.
165
177
166
-
<imgsrc="./img/back-end-failure.png"alt="empty state with information about a connection error"width="1500px"/>
178
+
<divclass="ws-docs-content-img">
179
+

180
+
</div>
167
181
168
182
**Heading**: State what the error is in plain language so that the user can easily understand what the error means.
169
183
@@ -190,11 +204,15 @@ Success empty states appear when the user successfully completes a process, such
190
204
191
205
Use the standard empty state variation for success empty states in a table or wizard.
192
206
193
-
<imgsrc="./img/success-wizard.png"alt="empty state confirming that a project was created"width="1500px"/>
207
+
<divclass="ws-docs-content-img">
208
+

209
+
</div>
194
210
195
211
Use the [extra large empty state](#extra-large-empty-state) variation for success empty states in a full page.
196
212
197
-
<imgsrc="./img/xl-success.png"alt="empty state confirming registration"width="1500px"/>
213
+
<divclass="ws-docs-content-img">
214
+

215
+
</div>
198
216
199
217
**Heading**: Confirm the action is completed. Because this is a success message, it’s OK to congratulate the user and show some excitement. Avoid extraneous terms like “success” and “successfully.”
200
218
@@ -231,7 +249,9 @@ Creation empty states appear when the user needs to add or create something to v
231
249
232
250
Use the [large empty state](#large-empty-state) variation for creation empty states.
233
251
234
-
<imgsrc="./img/add-or-create.png"alt="empty state with no accounts yet"width="1500px"/>
252
+
<divclass="ws-docs-content-img">
253
+

254
+
</div>
235
255
236
256
**Heading**: State what hasn’t been created or added yet. Avoid saying that something hasn’t been found because the user might interpret that as a system error.
237
257
@@ -265,9 +285,13 @@ Use the [large empty state](#large-empty-state) variation for creation empty sta
265
285
266
286
**Secondary button**: Give the user the ability to access additional resources that can help them through the creation process, such as a tour.
267
287
288
+
### Card
289
+
268
290
You can also use the extra small empty state variation inside of a card to present the user with another way to add a new card to their view. Place the empty state card where a new card would be added, such as the first (or last) card in the view. Be sure to also include a primary button in the toolbar so that the user can still perform the action even if the empty state is out of view.
269
291
270
-
<imgsrc="./img/add-card-empty-state.png"alt="empty state inside of a card"width="1500px"/>
292
+
<divclass="ws-docs-content-img">
293
+

294
+
</div>
271
295
272
296
## Variations
273
297
@@ -312,14 +336,18 @@ Regardless of empty state variation and type, all empty states should have a spe
312
336
### Level of detail
313
337
State what isn't there, and then give the user a next step. Empty states should not describe in detail how to use the page—the design should be intuitive enough without extensive written explanation.
314
338
315
-
<imgsrc="./img/level-of-detail.png"alt="do and don’t examples for level of detail"width="771px"/>
339
+
<divclass="ws-docs-content-img">
340
+

341
+
</div>
316
342
317
343
### Capitalization and punctuation
318
344
Use [sentence case](/ux-writing/capitalization) in your empty states: Capitalize only the first letter of the first word in the heading, body, buttons, or links. However, be sure to capitalize the first letter in all proper nouns, product names, acronyms, and initialisms, regardless of where they appear in the heading, body, buttons, or links.
319
345
320
346
Add a period at the end of full sentences in the body, but do not add a period at the end of headings or buttons.
321
347
322
-
<imgsrc="./img/sentence-case.png"alt="do and don’t examples for capitalization"width="771px"/>
348
+
<divclass="ws-docs-content-img">
349
+

350
+
</div>
323
351
324
352
### Voice and tone
325
353
Pay close attention to the [voice and tone](/ux-writing/brand-voice-and-tone) in your empty state. Your voice should align with your company’s unique brand voice. Your tone, on the other hand, should adjust depending on the context—consider the user’s emotions and adjust your approach accordingly.
@@ -334,41 +362,57 @@ If you have one primary call to action, you can present it as a primary button o
334
362
335
363
**Example: Call to action as a primary button**
336
364
337
-
<imgsrc="./img/one-cta-primary.png"alt="empty state with one primary button"width="600px"/>
365
+
<divclass="ws-docs-content-img">
366
+

367
+
</div>
338
368
339
369
**Example: Call to action as a link in the body text**
340
370
341
-
<imgsrc="./img/one-cta-body.png"alt="empty state with one hyperlink"width="600px"/>
371
+
<divclass="ws-docs-content-img">
372
+

373
+
</div>
342
374
343
375
### Multiple calls to action
344
376
If your primary call to action is presented as a primary button, your secondary call to action can be presented as a secondary button beneath the primary button.
345
377
346
378
**Example: Secondary call to action as a secondary button beneath the primary button**
347
-
<imgsrc="./img/two-ctas-primary.png"alt="empty state with two buttons"width="600px"/>
379
+
<divclass="ws-docs-content-img">
380
+

381
+
</div>
348
382
349
383
If your primary call to action is presented as a link in the body text, your secondary call to action can be presented as a secondary button beneath the body text.
350
384
351
385
**Example: Secondary call to action as a secondary button beneath the body text**
352
-
<imgsrc="./img/two-ctas-body.png"alt="empty state with two hyperlinks"width="600px"/>
386
+
<divclass="ws-docs-content-img">
387
+

388
+
</div>
353
389
354
390
### One secondary call to action
355
391
For a filtering or search situation, you can use a stand-alone secondary button (with nothing linked in the body).
356
392
357
-
<imgsrc="./img/solo-link.png"alt="empty state with one hyperlink"width="393px"/>
393
+
<divclass="ws-docs-content-img">
394
+

395
+
</div>
358
396
359
397
### Alignment
360
398
Empty states can be a full page, or they can be included inside of other components on the page.
361
399
362
400
### Full-page empty states
363
-
On a desktop, a full-page empty state should be 64px away from the top and horizontally centered with a minimum padding of 24px on all remaining sides.
401
+
On a desktop, a full-page empty state should contain a 3xl spacer at the top and should be horizontally centered, with a lg spacer (or larger) on all remaining sides.
364
402
365
-
<imgsrc="./img/desktop-page-es.png"alt="full-page empty state with padding on desktop"width="1500px"/>
403
+
<divclass="ws-docs-content-img">
404
+

405
+
</div>
366
406
367
-
On a mobile device, a full-page empty state should be 48px away from the top with a minimum of 16px padding on all remaining sides.
407
+
On a mobile device, a full-page empty state should contain a 2xl spacer at the top, with a md spacer (or larger) on all remaining sides.
368
408
369
-
<imgsrc="./img/mobile-page-es.png"alt="full-page empty state with padding on mobile"width="375px"/>
409
+
<divclass="ws-docs-content-img">
410
+

411
+
</div>
370
412
371
413
### Empty states inside tables, cards, or wizards
372
-
Empty states inside a table, card, or wizard should always be horizontally and vertically centered on their background. Outside padding on all remaining sides should be 24px.
414
+
Empty states inside a table, card, or wizard should always be horizontally and vertically centered on their background. There should be a lg spacer of outside padding on all remaining sides.
373
415
374
-
<imgsrc="./img/table-es.png"alt="empty state inside card with padding"width="1500px"/>
416
+
<divclass="ws-docs-content-img">
417
+

0 commit comments