From 6e5f15f30b6b28646914a1fe45bd267ab1aaa9c0 Mon Sep 17 00:00:00 2001 From: Calvin Lau Date: Wed, 20 Nov 2024 17:12:01 +0000 Subject: [PATCH] Add remaining component and pattern edits from worksheet --- src/components/checkboxes/index.md | 2 +- src/components/date-input/index.md | 4 ++-- src/components/fieldset/index.md | 6 +++--- src/components/password-input/index.md | 4 ++-- src/components/phase-banner/index.md | 2 +- src/components/radios/index.md | 2 +- src/components/summary-list/index.md | 6 +++--- src/components/text-input/index.md | 2 +- src/patterns/dates/index.md | 2 +- src/patterns/equality-information/index.md | 6 +++--- src/patterns/exit-a-page-quickly/index.md | 2 +- src/patterns/navigate-a-service/index.md | 2 +- src/patterns/phone-numbers/index.md | 2 +- src/patterns/problem-with-the-service-pages/index.md | 2 +- src/patterns/validation/index.md | 2 +- 15 files changed, 23 insertions(+), 23 deletions(-) diff --git a/src/components/checkboxes/index.md b/src/components/checkboxes/index.md index 58defbddaf..4f8eb846eb 100644 --- a/src/components/checkboxes/index.md +++ b/src/components/checkboxes/index.md @@ -73,7 +73,7 @@ Do not use links in hint text. While screen readers will read out the link text When 'none' would be a valid answer, give users the option to check a box to say none of the other options apply to them – without this option, users would have to leave all of the boxes unchecked. Giving users this option also makes sure they do not skip the question by accident. -Remember to [start by asking one question per page](/patterns/question-pages/#start-by-asking-one-question-per-page). You might be able to remove the need for a 'none' option by asking the user a better question or filtering them out with a ‘filter question’ beforehand. The GOV.UK Service Manual has guidance on [designing good questions](https://www.gov.uk/service-manual/design/designing-good-questions). +Remember to [start by asking one question per page in your service](/patterns/question-pages/#start-by-asking-one-question-per-page). You might be able to remove the need for a 'none' option by asking the user a better question or filtering them out with a ‘filter question’ beforehand. The GOV.UK Service Manual has guidance on [designing good questions](https://www.gov.uk/service-manual/design/designing-good-questions). Show the ‘none’ option last. Separate it from the other options using a divider. The text is usually the word ‘or’. diff --git a/src/components/date-input/index.md b/src/components/date-input/index.md index 2542cedb08..ab03bef3c0 100644 --- a/src/components/date-input/index.md +++ b/src/components/date-input/index.md @@ -21,7 +21,7 @@ Use the date input component when you’re asking users for a date they’ll alr Do not use the date input component if users are unlikely to know the exact date of the event you’re asking about. -Read more about how to [ask users for dates](/patterns/dates/). +Read more in the [Ask users for dates pattern](/patterns/dates/). ## How it works @@ -29,7 +29,7 @@ The date input component consists of 3 fields to let users enter a day, month an The 3 date fields are grouped together in a `
` with a `` that describes them, as shown in the examples on this page. This is usually a question, like ‘What is your date of birth?’. -If you’re asking [one question per page](/patterns/question-pages/#start-by-asking-one-question-per-page), you can set the contents of the `` as the page heading. This is good practice as it means that users of screen readers will only hear the contents once. +If you’re asking [one question per page in your service](/patterns/question-pages/#start-by-asking-one-question-per-page), you can set the contents of the `` as the page heading. This is good practice as it means that users of screen readers will only hear the contents once. Read more about [why and how to set legends as headings](/get-started/labels-legends-headings/). diff --git a/src/components/fieldset/index.md b/src/components/fieldset/index.md index f05e03d10d..184d366351 100644 --- a/src/components/fieldset/index.md +++ b/src/components/fieldset/index.md @@ -13,7 +13,7 @@ Use the fieldset component to group related form inputs. ## When to use this component -Use the fieldset component when you need to show a relationship between multiple form inputs. For example, you may need to group a set of text inputs into a single fieldset when [asking for an address](/patterns/addresses/). +Use the fieldset component when you need to show a relationship between multiple form inputs. For example, you may need to group a set of text inputs into a single fieldset when [asking for an address in your service](/patterns/addresses/). {{ example({ group: "components", item: "fieldset", example: "address-group", html: true, nunjucks: true, open: false, size: "xl", loading: "eager" }) }} @@ -23,7 +23,7 @@ If you’re using the examples or macros for a [Radios component](/components/ra The first element inside a fieldset must be a `legend` which describes the group of inputs. This could be a question, such as ‘What is your current address?’ or a statement like ‘Personal details’. -If you’re asking just [one question per page](/patterns/question-pages/#start-by-asking-one-question-per-page) as recommended, you can set the contents of the `` as the page heading, as shown in the example below. This is good practice as it means that users of screen readers will only hear the contents once. +If you’re asking just [one question per page in your service](/patterns/question-pages/#start-by-asking-one-question-per-page) as recommended, you can set the contents of the `` as the page heading, as shown in the example below. This is good practice as it means that users of screen readers will only hear the contents once. Read more about [why and how to set legends as headings](/get-started/labels-legends-headings/). @@ -31,4 +31,4 @@ Read more about [why and how to set legends as headings](/get-started/labels-leg On [Question pages in your service](/patterns/question-pages/) containing a group of inputs, including the question as the legend helps users of screen readers to understand that the inputs are all related to that question. -Include general help text in the legend if it would help the user fill in the form, and you cannot write it as [hint text](/components/text-input/#hint-text). However, try to keep it as short as possible. +Include general help text in the legend if it would help the user fill in the form, and you [cannot write it as hint text](/components/text-input/#hint-text). However, try to keep it as short as possible. diff --git a/src/components/password-input/index.md b/src/components/password-input/index.md index 2ab15b7ec2..cd8147eaac 100644 --- a/src/components/password-input/index.md +++ b/src/components/password-input/index.md @@ -149,7 +149,7 @@ Some browsers might automatically change what the user is typing when the input You can tell browsers not to correct spellings by setting the `spellcheck` attribute to `false`. -Doing this can also prevent ['spell-jacking'](https://www.otto-js.com/news/article/chrome-and-edge-enhanced-spellcheck-features-expose-pii-even-your-passwords), where security researchers have found some spell checking tools gathering personal identifiable information, even user’s passwords, from password input fields to send to third party services. +Doing this can [avoid making your service vulnerable to ‘spell-jacking’](https://www.itpro.com/security/vulnerability/370010/what-is-spell-jacking), where security researchers have found some spell checking tools gathering personal identifiable information, even user’s passwords, from password input fields to send to third party services. You can tell browsers not to autocapitalise values by setting the `autocapitalize` attribute to `off`. @@ -167,7 +167,7 @@ We’ve tried to minimise duplicate functionality by hiding other types of ‘sh There’s also other instances where a password could be ‘shown’ or ‘hidden’ without the use of a button – causing a mismatch with the button label (in other words, the user would see a button to ‘show’ a password that’s already visible). -We found [this happens in some browsers](https://github.com/alphagov/govuk-design-system/issues/3552#issuecomment-1976660248) when: +[We found this mismatch happens in some browsers](https://github.com/alphagov/govuk-design-system/issues/3552#issuecomment-1976660248) when: - a keyboard shortcut is pressed - a suggested password is created diff --git a/src/components/phase-banner/index.md b/src/components/phase-banner/index.md index 474c955f95..f8970c20f9 100644 --- a/src/components/phase-banner/index.md +++ b/src/components/phase-banner/index.md @@ -61,4 +61,4 @@ Use a ‘feedback’ link to collect on-page feedback about your service. This c Whatever option you use, make sure that users do not lose their place in the service and can return to the page they were on. -Find out what [feedback you need to collect at each phase](https://www.gov.uk/service-manual/measuring-success/measuring-user-satisfaction#user-satisfaction-through-each-service-phase) in the GOV.UK Service Manual. +[Find out what feedback you need to collect at each phase](https://www.gov.uk/service-manual/measuring-success/measuring-user-satisfaction#user-satisfaction-through-each-service-phase) in the GOV.UK Service Manual. diff --git a/src/components/radios/index.md b/src/components/radios/index.md index 280c672fd7..4d5089e197 100644 --- a/src/components/radios/index.md +++ b/src/components/radios/index.md @@ -44,7 +44,7 @@ Group radios together in a `
` with a `` that describes them, a ### If you’re asking one question on the page -If you are asking just [one question per page](/patterns/question-pages/#start-by-asking-one-question-per-page) as recommended, you can set the contents of the `` as the page heading. This is good practice as it means that users of screen readers will only hear the contents once. +If you are asking just [one question per page in your service](/patterns/question-pages/#start-by-asking-one-question-per-page) as recommended, you can set the contents of the `` as the page heading. This is good practice as it means that users of screen readers will only hear the contents once. Read more about [why and how to set legends as headings](/get-started/labels-legends-headings/). diff --git a/src/components/summary-list/index.md b/src/components/summary-list/index.md index 97ca83f690..1f140ad395 100644 --- a/src/components/summary-list/index.md +++ b/src/components/summary-list/index.md @@ -37,7 +37,7 @@ Use a summary list to show information as a list of key facts. You can use it to display metadata like ‘Last updated’ with a date like ‘22 June 2018’, or to summarise a user’s responses at the end of a form like the [Check answers pattern](/patterns/check-answers/). -[Summary cards](#summary-cards) are a variant within this component. You can use summary cards to show multiple summary lists that describe the same type of thing, such as people. You can also add card actions that apply to the entire summary list. +[Summary cards are a variant within this component](#summary-cards). You can use summary cards to show multiple summary lists that describe the same type of thing, such as people. You can also add card actions that apply to the entire summary list. ## When not to use this component @@ -167,8 +167,8 @@ This component was developed and tested by the Government Digital Service as par The Department for Education contributed the summary card. It’s being used in some of their services, such as: -- [apply for teacher training](https://www.gov.uk/apply-for-teacher-training), used by the general public -- [register trainee teachers](https://www.register-trainee-teachers.service.gov.uk/), used by people that work for training providers +- [Apply for teacher training](https://www.gov.uk/apply-for-teacher-training), used by the general public +- [Register trainee teachers](https://www.register-trainee-teachers.service.gov.uk/), used by people that work for training providers The summary card is also used in services run by other departments, such us: diff --git a/src/components/text-input/index.md b/src/components/text-input/index.md index 55c48c496c..c795af3d4e 100644 --- a/src/components/text-input/index.md +++ b/src/components/text-input/index.md @@ -35,7 +35,7 @@ Do not use placeholder text in place of a label, or for hints or examples, as: ### If you're asking one question on the page -If you’re asking just [one question per page](/patterns/question-pages/#start-by-asking-one-question-per-page) as recommended, you can set the contents of the `