Skip to content
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

Updated tag guidance #233

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 29 additions & 14 deletions docs/components/tag.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: layouts/component.njk
title: Tag
description: Use tags to show a status. Tags only display information and are not interactive.
description: Use tags to show the status of a task or a process.
backlogID: 11
tags:
- component
Expand All @@ -13,34 +13,47 @@ tags:

Use tags to help users:

- understand the status of an activity or a process
- keep track of progress
- understand when they need to take an action

For example, tags can help users to:
## How to use

- track prescription requests
- understand when they need to take an action regarding a hospital referral
You can place tags inside or outside a card.

## When not to use
### Choosing colours

Too many tags, and lots of variation in tag colours, may clutter a page and overwhelm users. Tags can also affect the visual hierarchy of a page. This means tags should be used sparingly.
You should use colours that fit with the mental models of your users. Try to find this out through user research. You might find it works to use:

## How to use
- green to signify confirmation or a positive status
- red for a status that needs to stand out or be actioned
- grey for a status that doesn't need to stand out

Within the same NHS App service, you should always be consistent and match the same colour with the same tag text.

You should also try to align the colours and text with other areas of the NHS App. There may be some variation between services because they need different statuses to fit with their contexts. For example, a red status tag might be labelled "Cancelled" in one service but "Action needed" in another. We want to do more research into how users percieve these variations.

Tags can be placed within a card or outside of one. Inside a card, tags should always be left-aligned. Outside a card, tags can be aligned to the left or the right.
### Writing tag text

Tag text should:

- be in sentence case
- describe status in as few words as possible
- describe the status in as few words as possible

For example:

- Requested
- In progress
- Ready for delivery
- Done
- Cancelled

## How not to use

Do not use tags:
Do not:

- as a header or grouping-class for elements or information
- as a selectable element
- use lots of tags or lots of colour variation – it can clutter pages and overwhelm users
- use tags as a header or grouping-class for elements or information
- use tags as a selectable element

Tag text should not:

Expand All @@ -53,4 +66,6 @@ Tag colours meet [WCAG 2.2 Success Criterion 1.4.3 Contrast (Minimum)](https://w

## Research

In our research, we found that red tags could cause some participants to feel concerned. Red was associated with something having gone wrong.
In our research, we found that red tags were associated with something having gone wrong.

We want to do more research to understand how variations in tag colours and text across different NHS App services might affect users.
Loading