Skip to content

Commit fc6b81c

Browse files
bekah-stephensedonehooandrew-ronaldson
authored
docs(empty state): Updates images for v6. (#4603)
* docs(empty state): Updates images for v6. * docs(empty-state): Content edits to support new images. * Update packages/documentation-site/patternfly-docs/content/design-guidelines/components/empty-state/empty-state.md * Fixing sizing on Elements image. --------- Co-authored-by: Erin Donehoo <edonehoo@redhat.com> Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> Co-authored-by: Andrew Ronaldson <aronalds@redhat.com>
1 parent ed78b16 commit fc6b81c

22 files changed

Lines changed: 1889 additions & 23 deletions

packages/documentation-site/patternfly-docs/content/design-guidelines/components/empty-state/empty-state.md

Lines changed: 67 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@ id: Empty state
33
section: components
44
---
55

6+
import '../components.css';
7+
68
## Elements
79
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.
810

9-
<img src="./img/empty-state.png" alt="large empty state example with all elements" width="1500px"/>
11+
<div class="ws-docs-content-img">
12+
![Example of a large empty state with all elements.](./img/elements.svg)
13+
</div>
1014

1115
1. **Icon**: The icon presents a visual component for easier recognition of the empty state’s message.
1216
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
2327

2428
Use the [extra large empty state](#extra-large-empty-state) variation for getting started empty states.
2529

26-
<img src="./img/xl-getstarted.png" alt="extra large empty state with welcome message" width="1500px"/>
30+
<div class="ws-docs-content-img">
31+
![Example of an extra large Getting Started empty state.](./img/es-getting-started.svg)
32+
</div>
2733

2834
**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.
2935

@@ -62,7 +68,9 @@ In your empty state, explain that nothing was found and give the user a next ste
6268

6369
Use the [small empty state](#small-empty-state) variation for no results empty states.
6470

65-
<img src="./img/no-data.png" alt="empty state showing no search results" width="1500px"/>
71+
<div class="ws-docs-content-img">
72+
![Example of an empty state with no search results.](./img/es-no-results.svg)
73+
</div>
6674

6775
**Heading**: Briefly state that no results were found.
6876

@@ -89,7 +97,9 @@ Required configuration empty states appear when the user needs to configure, con
8997

9098
Use the [large empty state](#large-empty-state) variation for required configuration empty states.
9199

92-
<img src="./img/configuration.png" alt="empty state with system configuration information" width="1500px"/>
100+
<div class="ws-docs-content-img">
101+
![Example of an empty state with system configuration information.](./img/es-required-config.svg)
102+
</div>
93103

94104
**Heading**: State what needs to be done instead of what hasn’t been done yet.
95105

@@ -126,7 +136,9 @@ No access empty states appear when the user doesn’t have the entitlements or a
126136

127137
Use the [large empty state](#large-empty-state) variation for no access empty states.
128138

129-
<img src="./img/access-denied.png" alt="empty state with information about access permissions" width="1500px"/>
139+
<div class="ws-docs-content-img">
140+
![Example of an empty state with information about access permissions.](./img/es-no-access.svg)
141+
</div>
130142

131143
**Heading**: State what the user needs to access the page instead of what they don’t have or can’t do.
132144

@@ -163,7 +175,9 @@ Back-end failure empty states appear when an error occurs that prevents the syst
163175

164176
Use the [large empty state](#large-empty-state) variation for back-end failure empty states.
165177

166-
<img src="./img/back-end-failure.png" alt="empty state with information about a connection error" width="1500px"/>
178+
<div class="ws-docs-content-img">
179+
![Example of an empty state with information about a connection error.](./img/es-failure.svg)
180+
</div>
167181

168182
**Heading**: State what the error is in plain language so that the user can easily understand what the error means.
169183

@@ -190,11 +204,15 @@ Success empty states appear when the user successfully completes a process, such
190204

191205
Use the standard empty state variation for success empty states in a table or wizard.
192206

193-
<img src="./img/success-wizard.png" alt="empty state confirming that a project was created" width="1500px"/>
207+
<div class="ws-docs-content-img">
208+
![Example of a success empty state in a wizard.](./img/es-success-wizard.svg)
209+
</div>
194210

195211
Use the [extra large empty state](#extra-large-empty-state) variation for success empty states in a full page.
196212

197-
<img src="./img/xl-success.png" alt="empty state confirming registration" width="1500px"/>
213+
<div class="ws-docs-content-img">
214+
![Example of a full page success empty state.](./img/es-success-page.svg)
215+
</div>
198216

199217
**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.”
200218

@@ -231,7 +249,9 @@ Creation empty states appear when the user needs to add or create something to v
231249

232250
Use the [large empty state](#large-empty-state) variation for creation empty states.
233251

234-
<img src="./img/add-or-create.png" alt="empty state with no accounts yet" width="1500px"/>
252+
<div class="ws-docs-content-img">
253+
![Example of an empty state with no accounts yet.](./img/es-creation.svg)
254+
</div>
235255

236256
**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.
237257

@@ -265,9 +285,13 @@ Use the [large empty state](#large-empty-state) variation for creation empty sta
265285

266286
**Secondary button**: Give the user the ability to access additional resources that can help them through the creation process, such as a tour.
267287

288+
### Card
289+
268290
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.
269291

270-
<img src="./img/add-card-empty-state.png" alt="empty state inside of a card" width="1500px"/>
292+
<div class="ws-docs-content-img">
293+
![Example of an empty state in a card.](./img/es-card.svg)
294+
</div>
271295

272296
## Variations
273297

@@ -312,14 +336,18 @@ Regardless of empty state variation and type, all empty states should have a spe
312336
### Level of detail
313337
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.
314338

315-
<img src="./img/level-of-detail.png" alt="do and don’t examples for level of detail" width="771px"/>
339+
<div class="ws-docs-content-img">
340+
![Do and don't examples for level of detail in an empty state.](./img/es-details.svg)
341+
</div>
316342

317343
### Capitalization and punctuation
318344
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.
319345

320346
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.
321347

322-
<img src="./img/sentence-case.png" alt="do and don’t examples for capitalization" width="771px"/>
348+
<div class="ws-docs-content-img">
349+
![Do and don't examples for capitalization in an empty state.](./img/es-capitalization.svg)
350+
</div>
323351

324352
### Voice and tone
325353
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
334362

335363
**Example: Call to action as a primary button**
336364

337-
<img src="./img/one-cta-primary.png" alt="empty state with one primary button" width="600px"/>
365+
<div class="ws-docs-content-img">
366+
![Example of an empty state with one primary button.](./img/es-button-action.svg)
367+
</div>
338368

339369
**Example: Call to action as a link in the body text**
340370

341-
<img src="./img/one-cta-body.png" alt="empty state with one hyperlink" width="600px"/>
371+
<div class="ws-docs-content-img">
372+
![Example of an empty state with a hyperlink.](./img/es-link-action.svg)
373+
</div>
342374

343375
### Multiple calls to action
344376
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.
345377

346378
**Example: Secondary call to action as a secondary button beneath the primary button**
347-
<img src="./img/two-ctas-primary.png" alt="empty state with two buttons" width="600px"/>
379+
<div class="ws-docs-content-img">
380+
![Example of an empty state with two action buttons.](./img/es-multi-action.svg)
381+
</div>
348382

349383
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.
350384

351385
**Example: Secondary call to action as a secondary button beneath the body text**
352-
<img src="./img/two-ctas-body.png" alt="empty state with two hyperlinks" width="600px"/>
386+
<div class="ws-docs-content-img">
387+
![Example of an empty state with a hyperlink and secondary action button.](./img/es-secondary-action-multi.svg)
388+
</div>
353389

354390
### One secondary call to action
355391
For a filtering or search situation, you can use a stand-alone secondary button (with nothing linked in the body).
356392

357-
<img src="./img/solo-link.png" alt="empty state with one hyperlink" width="393px"/>
393+
<div class="ws-docs-content-img">
394+
![Example of an empty state with a secondary action button.](./img/es-secondary-action.svg)
395+
</div>
358396

359397
### Alignment
360398
Empty states can be a full page, or they can be included inside of other components on the page.
361399

362400
### 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.
364402

365-
<img src="./img/desktop-page-es.png" alt="full-page empty state with padding on desktop" width="1500px"/>
403+
<div class="ws-docs-content-img">
404+
![Example of the spacing tokens used on a full-page empty state.](./img/es-full-page-spacing.svg)
405+
</div>
366406

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.
368408

369-
<img src="./img/mobile-page-es.png" alt="full-page empty state with padding on mobile" width="375px"/>
409+
<div class="ws-docs-content-img">
410+
![Example of the spacing tokens used on a mobile empty state.](./img/es-mobile-spacing.svg)
411+
</div>
370412

371413
### 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.
373415

374-
<img src="./img/table-es.png" alt="empty state inside card with padding" width="1500px"/>
416+
<div class="ws-docs-content-img">
417+
![Example of the spacing tokens used on a table.](./img/es-table-spacing.svg)
418+
</div>

0 commit comments

Comments
 (0)