Skip to content

Commit 794fd35

Browse files
Edits and reworked use cases based on team input
Edits from code review Revise 'do not use' mentions
1 parent f475112 commit 794fd35

2 files changed

Lines changed: 39 additions & 30 deletions

File tree

src/components/panel/index.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Panel
3-
description: The Panel component is a visible container used on confirmation or results pages
3+
description: Use the Panel component to display important information in within confirmation and interruption pages
44
section: Components
55
aliases: confirmation box, results box, reference number, application complete, application number
66
backlogIssueId: 55
@@ -16,10 +16,8 @@ The Panel component is a visible container used to highlight important content.
1616

1717
Use the Panel component to display important information within:
1818

19-
- Confirmation pages, which tell the user they’ve successfully completed the transaction
20-
- Interruption pages, which pause the user journey to give important information
21-
22-
See guidance on [Confirmation pages](/patterns/confirmation-pages/) and [Interruption pages](/patterns/interruption-pages/).
19+
- [Confirmation pages](/patterns/confirmation-pages/), which tell the user they’ve successfully completed the transaction
20+
- [Interruption pages](/patterns/interruption-pages/), which pause the user journey to give important information
2321

2422
## When not to use this component
2523

@@ -37,16 +35,16 @@ The confirmation panel is part of a [Confirmation page](/patterns/confirmation-p
3735

3836
### How to write confirmation panel text
3937

40-
Keep your panel text brief, as it's only meant for a high-level explanation of what has happened. For example, 'Application complete'.
41-
42-
Aim to use short words and phrases to make sure highlighted information is easy to read at different screen sizes. For example, shorter amounts of information is less likely to wrap around the panel, which can happen when using the zoom function on mobiles.
38+
Keep your panel text brief, as it's only meant for a high-level explanation of what has happened.
4339

44-
If you need to give detailed information, or more context, use the description text under the heading text.
40+
Aim to use short words and phrases to make sure highlighted information is easy to read at different screen sizes. For example, shorter amounts of information are less likely to wrap around the panel, which can happen when using the zoom function on mobiles.
4541

4642
## Interruption panel
4743

4844
The interruption panel is part of an [Interruption page](/patterns/interruption-pages/) and shows the user important information that they’d miss if shown any other way.
4945

5046
Within the panel is a ‘continue’ button that the user must interact with to resume their journey.
5147

52-
The information itself is usually shown as heading with some description text, possibly a bullet or numbered list.
48+
The information itself is usually shown as heading with some description text, possibly with bullet points and numbered steps
49+
50+
[EXAMPLE]

src/patterns/interruption-pages/index.md

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,48 +12,59 @@ layout: layout-pane.njk
1212

1313
Use Interruption pages to pause the user’s journey to give them important information that they’d miss if shown any other way.
1414

15-
The NHS Design System and Ministry of Justice (MOJ) Design System both include interruption pages or cards. The guidance on this page is based on their work.
16-
17-
See [Interruption page on NHS Design System](https://service-manual.nhs.uk/design-system/patterns/interruption-page) and [Interruption card on MOJ Design System](https://design-patterns.service.justice.gov.uk/components/interruption-card/)
15+
{{ example({ group: "components", item: "panel", example: "default", html: true, nunjucks: true, open: false, size: "m", loading: "eager" }) }}
1816

1917
## When to use this pattern
2018

21-
Think carefully before you choose to use an Interruption page, doing this might get in the way of the user completing their task.
22-
23-
Both of the NHS Design System and MOJ Design System provide use cases for using Interruption pages to:
19+
Think carefully before you choose to use an Interruption page, as doing this might get in the way of the user completing their task.
2420

25-
- warn the user when they’re doing something unusual that's likely to be a mistake
26-
- confirm something that cannot be undone (asking the user if they’re sure about doing something)
21+
Use Interruption pages to warn the user before they:
2722

28-
The MOJ Design System also provide use cases to:
23+
- do something unusual that’s probably a mistake
24+
- do something that cannot be undone (asking the user “Are you sure?”)
25+
- give an answer that conflicts with existing information
2926

30-
- warn the user when their answer conflicts with existing information the service knows about
31-
- end a journey when a confirmation page is not appropriate
32-
- show important information ahead of a task
27+
You can also use Interruption pages:
3328

34-
We’ve also seen that many services in government use Interruption pages to show other types of important information that might otherwise get missed. See our [‘Interruption card’ discussion on GitHub](https://github.com/alphagov/govuk-design-system-backlog/issues/27) to see these examples.
29+
- instead of Confirmation pages to show a more varied journey outcomes (that are different to a straightforward success, rejection or completion)
30+
- to show the user important information ahead of a task
3531

3632
## When not to use this pattern
3733

38-
Do not use Interruption pages unless you’re confident that both:
34+
Only use Interruption pages if you’re confident that:
3935

40-
- there's evidence of a clear need to interrupt the user journey
41-
- this is the only way to give the user information that they’d otherwise miss
36+
1. There’s evidence of a clear need to interrupt the user journey.
37+
2. This is the only way to give the user information and that they’d otherwise miss it.
4238

4339
Read guidance in the Service Manual, particularly to [Map and understand a user's whole problem](https://www.gov.uk/service-manual/design/map-a-users-whole-problem), to find ways to improve the user journey and the organisational processes behind them.
4440

4541
## How it works
4642

47-
Interruption pages pause the user journey to show important information that they might otherwise miss.
43+
Interruption pages pause the user journey to show important information.
4844

4945
On the page, the important information is shown within an Interruption panel, to help ensure the user does not miss it.
5046

51-
The panel includes a ‘continue’ button that the user must interact with to resume their journey. Information within the panel is usually shown as heading with some description text, possibly a bullet or numbered list.
47+
The panel includes a ‘continue’ button that the user must interact with to resume their journey. Information within the panel is usually shown as heading with some description text, possibly with bullet points and numbered steps.
5248

53-
To ensure the interruption is useful, keep information within the panel short. Do not place any other components or form elements inside the panel.
49+
Keep information within the panel short. Do not place any other components or form elements inside the panel.
5450

5551
## Research on this pattern
5652

53+
This pattern was originally contributed by the NHS Design System. We thank the team for working with us to publish the [Interruption panel variant of the Panel component](/components/panel/) and this pattern.
54+
55+
Guidance in this pattern is based on:
56+
57+
- [Interruption page on NHS Design System](https://service-manual.nhs.uk/design-system/patterns/interruption-page)
58+
- [Interruption card on Ministry of Justice (MOJ) Design System](https://design-patterns.service.justice.gov.uk/components/interruption-card/)
59+
60+
### Other uses of Interruption pages
61+
62+
We’ve seen that many services in government use Interruption pages to show other types of important information that might otherwise get missed.
63+
64+
See our [‘Interruption card’ discussion on GitHub](https://github.com/alphagov/govuk-design-system-backlog/issues/27) to see these examples.
65+
66+
### Next steps
67+
5768
We’d like to get more feedback from service teams to help us improve this pattern.
5869

59-
We'd particularly like to better understand the ways services use Interruption pages, so that we can provide better guidance to ensure they're used effectively and consistently across government.
70+
We'd particularly like to better understand the ways services use Interruption pages, so that we can provide better guidance on ‘When to use this pattern’ and ‘When not to use this pattern’ to ensure they're used effectively and consistently across government.

0 commit comments

Comments
 (0)