-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add panel component and confirmation pages pattern #2032
Draft
davidhunter08
wants to merge
11
commits into
main
Choose a base branch
from
panel-and-confirmation-page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+227
−4
Draft
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
fde7c4a
add placeholder guidance for panel and confirmation pages guidance
davidhunter08 4979e1b
Add content to confirmation page
sarawilcox 9c25f64
Merge remote-tracking branch 'origin/main' into panel-and-confirmatio…
anandamaryon1 e36e0bc
update pattern title for new pattern sidenav
anandamaryon1 7de35a6
attempt to add examples, not working yet
anandamaryon1 d05e31c
fix panel component example
anandamaryon1 99edac4
panel macro options tweaks
anandamaryon1 9661718
adds confirmation page exmaple
anandamaryon1 ee808f2
Tweak content in panel and confirmation page
sarawilcox 05a10be
update confirmation page example
anandamaryon1 bbef2a9
add link to panel component in confirmation page guidance and update …
davidhunter08 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
{% set pageTitle = "Panel" %} | ||
{% set pageSection = "Design system" %} | ||
{% set subSection = "Components" %} | ||
{% set pageDescription = "The panel component is a visible container used on confirmation or results pages to highlight important content." %} | ||
{% set theme = "Navigation" %} | ||
{% set dateUpdated = "February 2025" %} | ||
{% set backlog_issue_id = "537" %} | ||
|
||
{% extends "includes/app-layout.njk" %} | ||
|
||
{% block breadcrumb %} | ||
{% include "design-system/components/_breadcrumb.njk" %} | ||
{% endblock %} | ||
|
||
{% block bodyContent %} | ||
|
||
[add example here] | ||
|
||
<h2 id="when-to-use">When to use a panel</h2> | ||
<p>Use the panel component to display important information when a transaction has been completed. | ||
<p>In most cases, the panel component is used on <a href="/design-system/patterns/confirmation-pages">confirmation pages</a>, to tell the user they have successfully completed the transaction.</p> | ||
|
||
<h2 id="when-not-to-use">When not to use a panel</h2> | ||
<p>Never use the panel component to highlight important information within body content.</p> | ||
|
||
<h2 id="how-to-use">How to use a panel</h2> | ||
<p>(Some info about heading and descriptive text?)</p> | ||
|
||
<h3 id="how-to-write-panel-text">How to write panel text</h3> | ||
<p>Keep your panel text brief, as it's only meant for a high-level explanation of what has happened. For example, "Application complete".</p> | ||
<p>Use short words and phrases to make sure highlighted information is easy to read at different screen sizes. A shorter amount of information is less likely to wrap around the panel, which can happen when using the zoom function on mobiles.</p> | ||
<p>If you need to give detailed information, or more context, use the description text under the heading text.</p> | ||
|
||
{% endblock %} |
Empty file.
1 change: 1 addition & 0 deletions
1
app/views/design-system/patterns/confirmation-pages/default/index.njk
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{% extends "includes/design-example-wrapper-full-layout.njk" %} |
60 changes: 60 additions & 0 deletions
60
app/views/design-system/patterns/confirmation-pages/index.njk
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
{% set pageTitle = "Confirmation pages" %} | ||
{% set pageDescription = "Use a confirmation page to show users they have completed a task." %} | ||
{% set pageSection = "Design system" %} | ||
{% set subSection = "Patterns" %} | ||
{% set theme = "Page types" %} | ||
{% set dateUpdated = "February 2025" %} | ||
{% set backlog_issue_id = "144" %} | ||
|
||
{% extends "includes/app-layout.njk" %} | ||
|
||
{% block breadcrumb %} | ||
{% include "design-system/patterns/_breadcrumb.njk" %} | ||
{% endblock %} | ||
|
||
{% block bodyContent %} | ||
|
||
[add example here] | ||
|
||
<h2 id="when-to-use">When to use a confirmation page</h2> | ||
<p>You should use a confirmation page at the end of a transactional journey.</p> | ||
|
||
<h2 id="how-to-use">How to use a confirmation page</h2> | ||
<p>Confirmation pages must include:</p> | ||
<ul> | ||
<li>a green confirmation panel, with a heading that confirms what the user has done</li> | ||
<li>an application or reference number, if there is one</li> | ||
<li>details about what will happen next and when</li> | ||
</ul> | ||
<p>You may also find a need to include:</p> | ||
<ul> | ||
<li>instructions about other steps the user needs to take</li> | ||
<li>a summary of the details they have submitted</li> | ||
<li>a way to give feedback about the service</li> | ||
<li>links to more information or related services that may be helpful</li> | ||
</ul> | ||
|
||
<h2>How not to use a confirmation page</h2> | ||
<p>Avoid including too many different components on a confirmation page. Research suggests they can overwhelm people.</p> | ||
|
||
<h2>Accessibility</h2> | ||
<p>If you add any interactive elements, make sure the panel or focus state are still accessible.</p> | ||
|
||
<h2 id="research">Research</h2> | ||
<p>In our research, people found the green panel at the top of the confirmation page to be reassuring. They quickly understood the key message. The left-aligned heading text tested well with people who had visual impairments and used screen readers.</p> | ||
<p>We have also tested the green panel with participants who had colour blindness. They were able to read the text clearly. They understood what the colour is intended to signal.</p> | ||
<p>Some people became confused about the next step when presented with several different components on a confirmation page. This was especially the case for people who used screen readers.</p> | ||
|
||
<h3>Known gaps</h3> | ||
<p>We need more evidence to understand whether people:</p> | ||
<ul> | ||
<li>find it helpful to save the information on confirmation pages</li> | ||
<li>try to return to confirmation pages after completing their transaction</li> | ||
</ul> | ||
<p>In our testing, some participants said they would take a screenshot of the confirmation page on their phone. GOV.UK have found that some users bookmark and return to error pages.</p> | ||
<p>We are also looking for more evidence about the green confirmation panel at the top of confirmation pages. Particularly:</p> | ||
<ul> | ||
<li>any issues with colour contrast</li> | ||
<li>suitability for people who use reverse colours or are sensitive to light</li> | ||
</ul> | ||
{% endblock %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'A shorter amount of information' feels a bit awkwardly phrased.