Skip to content

Commit

Permalink
Merge pull request #4278 from alphagov/component-and-pattern-link-text
Browse files Browse the repository at this point in the history
Make link text for components and patterns consistent
  • Loading branch information
owenatgov authored Nov 8, 2024
2 parents 5db4aa6 + 590b1ab commit 9b26345
Show file tree
Hide file tree
Showing 64 changed files with 219 additions and 217 deletions.
68 changes: 34 additions & 34 deletions src/accessibility/wcag-2.2/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,103 +55,103 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA
rows: [
[
{
html: '<a href="/components/back-link/">Back link</a>'
html: '<a href="/components/back-link/">Back link component</a>'
},
{
html: 'Redundant entry<br>Target size (minimum)'
}
],
[
{
html: '<a href="/components/breadcrumbs/">Breadcrumbs</a>'
html: '<a href="/components/breadcrumbs/">Breadcrumbs component</a>'
},
{
html: 'Target size (minimum)'
}
],
[
{
html: '<a href="/components/button/">Button</a>'
html: '<a href="/components/button/">Button component</a>'
},
{
html: 'Target size (minimum)'
}
],
[
{
html: '<a href="/components/cookie-banner/">Cookie banner</a>'
html: '<a href="/components/cookie-banner/">Cookie banner component</a>'
},
{
html: 'Focus not obscured (minimum)<br>Target size (minimum)'
}
],
[
{
html: '<a href="/components/error-message/">Error message</a>'
html: '<a href="/components/error-message/">Error message component</a>'
},
{
html: 'Redundant entry'
}
],
[
{
html: '<a href="/components/file-upload/">File upload</a>'
html: '<a href="/components/file-upload/">File upload component</a>'
},
{
html: 'Dragging movements<br>Redundant entry'
}
],
[
{
html: '<a href="/components/footer/">GOV.UK footer</a>'
html: '<a href="/components/footer/">GOV.UK footer component</a>'
},
{
html: 'Consistent help'
}
],
[
{
html: '<a href="/components/header/">GOV.UK header</a>'
html: '<a href="/components/header/">GOV.UK header component</a>'
},
{
html: 'Focus not obscured (Minimum)<br>Consistent help'
}
],
[
{
html: '<a href="/components/phase-banner/">Phase banner</a>'
html: '<a href="/components/phase-banner/">Phase banner component</a>'
},
{
html: 'Focus not obscured (minimum)'
}
],
[
{
html: '<a href="/components/select/">Select</a>'
html: '<a href="/components/select/">Select component</a>'
},
{
html: 'Dragging movements'
}
],
[
{
html: '<a href="/components/service-navigation/">Service navigation</a>'
html: '<a href="/components/service-navigation/">Service navigation component</a>'
},
{
html: 'Focus not obscured (Minimum)<br>Consistent help'
}
],
[
{
html: '<a href="/components/summary-list/">Summary list</a>'
html: '<a href="/components/summary-list/">Summary list component</a>'
},
{
html: 'Redundant entry<br>Target size (minimum)'
}
],
[
{
html: '<a href="/components/tag/">Tag</a>'
html: '<a href="/components/tag/">Tag component</a>'
},
{
html: 'Dragging movements'
Expand All @@ -176,63 +176,63 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA
rows: [
[
{
html: '<a href="/patterns/addresses/">Addresses</a>'
html: '<a href="/patterns/addresses/">Addresses pattern</a>'
},
{
html: 'Redundant entry'
}
],
[
{
html: '<a href="/patterns/bank-details/">Bank details</a>'
html: '<a href="/patterns/bank-details/">Bank details pattern</a>'
},
{
html: 'Redundant entry'
}
],
[
{
html: '<a href="/patterns/email-addresses/">Email addresses</a>'
html: '<a href="/patterns/email-addresses/">Email addresses pattern</a>'
},
{
html: 'Redundant entry'
}
],
[
{
html: '<a href="/patterns/equality-information/">Equality information</a>'
html: '<a href="/patterns/equality-information/">Equality information pattern</a>'
},
{
html: 'Redundant entry'
}
],
[
{
html: '<a href="/patterns/names/">Names</a>'
html: '<a href="/patterns/names/">Names pattern</a>'
},
{
html: 'Redundant entry'
}
],
[
{
html: '<a href="/patterns/national-insurance-numbers/">National Insurance Numbers</a>'
html: '<a href="/patterns/national-insurance-numbers/">National Insurance Numbers pattern</a>'
},
{
html: 'Redundant entry'
}
],
[
{
html: '<a href="/patterns/passwords/">Passwords</a>'
html: '<a href="/patterns/passwords/">Passwords pattern</a>'
},
{
html: 'Accessible authentication<br>Consistent help<br>Target size (minimum)'
}
],
[
{
html: '<a href="/patterns/payment-card-details/">Payment card details</a>'
html: '<a href="/patterns/payment-card-details/">Payment card details pattern</a>'
},
{
html: 'Target size (minimum)'
Expand All @@ -257,71 +257,71 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA
rows: [
[
{
html: '<a href="/patterns/check-a-service-is-suitable/">Check a service is suitable</a>'
html: '<a href="/patterns/check-a-service-is-suitable/">Check a service is suitable pattern</a>'
},
{
html: 'Redundant entry'
}
],
[
{
html: '<a href="/patterns/check-answers/">Check answers</a>'
html: '<a href="/patterns/check-answers/">Check answers pattern</a>'
},
{
html: 'Redundant entry'
}
],
[
{
html: '<a href="/patterns/complete-multiple-tasks/">Complete multiple tasks</a>'
html: '<a href="/patterns/complete-multiple-tasks/">Complete multiple tasks pattern</a>'
},
{
html: 'Dragging movements<br>Redundant entry'
}
],
[
{
html: '<a href="/patterns/confirm-a-phone-number/">Confirm a phone number</a>'
html: '<a href="/patterns/confirm-a-phone-number/">Confirm a phone number pattern</a>'
},
{
html: 'Consistent help'
}
],
[
{
html: '<a href="/patterns/confirm-an-email-address/">Confirm an email address</a>'
html: '<a href="/patterns/confirm-an-email-address/">Confirm an email address pattern</a>'
},
{
html: 'Accessible authentication'
}
],
[
{
html: '<a href="/patterns/contact-a-department-or-service-team/">Contact a department or service team</a>'
html: '<a href="/patterns/contact-a-department-or-service-team/">Contact a department or service team pattern</a>'
},
{
html: 'Consistent help'
}
],
[
{
html: '<a href="/patterns/create-accounts/">Create accounts</a>'
html: '<a href="/patterns/create-accounts/">Create accounts pattern</a>'
},
{
html: 'Accessible authentication<br>Redundant entry'
}
],
[
{
html: '<a href="/patterns/navigate-a-service/">Navigate a service</a>'
html: '<a href="/patterns/navigate-a-service/">Navigate a service pattern</a>'
},
{
html: 'Focus not obscured (Minimum)<br>Consistent help'
}
],
[
{
html: '<a href="/patterns/validation/">Recover from validation errors</a>'
html: '<a href="/patterns/validation/">Recover from validation errors pattern</a>'
},
{
html: 'Redundant entry'
Expand All @@ -346,31 +346,31 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA
rows: [
[
{
html: '<a href="/patterns/page-not-found-pages/">Page not found pages</a>'
html: '<a href="/patterns/page-not-found-pages/">Page not found pages pattern</a>'
},
{
html: 'Consistent help'
}
],
[
{
html: '<a href="/patterns/question-pages/">Question pages</a>'
html: '<a href="/patterns/question-pages/">Question pages pattern</a>'
},
{
html: 'Dragging movements<br>Redundant entry'
}
],
[
{
html: '<a href="/patterns/service-unavailable-pages/">Service unavailable pages</a>'
html: '<a href="/patterns/service-unavailable-pages/">Service unavailable pages pattern</a>'
},
{
html: 'Consistent help'
}
],
[
{
html: '<a href="/patterns/problem-with-the-service-pages/">There is a problem with the service pages</a>'
html: '<a href="/patterns/problem-with-the-service-pages/">There is a problem with the service pages pattern</a>'
},
{
html: 'Consistent help<br>Redundant entry'
Expand Down
6 changes: 3 additions & 3 deletions src/community/roadmap/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ Last updated 10 October 2024.

We’ve released [GOV.UK Frontend v5.7.1](https://github.com/alphagov/govuk-frontend/releases/tag/v5.7.1) with updated department colours.

Previously, we’ve released [GOV.UK Frontend v5.7.0](https://github.com/alphagov/govuk-frontend/releases/tag/v5.7.0), which includes an update to the Royal Arms in the [GOV.UK footer](/components/footer/). We’ve also added new features to help services [create their own JavaScript components using GOV.UK Frontend](https://frontend.design-system.service.gov.uk/building-your-own-javascript-components/).
Previously, we’ve released [GOV.UK Frontend v5.7.0](https://github.com/alphagov/govuk-frontend/releases/tag/v5.7.0), which includes an update to the Royal Arms in the [GOV.UK footer component](/components/footer/). We’ve also added new features to help services [create their own JavaScript components using GOV.UK Frontend](https://frontend.design-system.service.gov.uk/building-your-own-javascript-components/).

We’ve also recently:

- introduced a new [Service navigation component](/components/service-navigation/) and published a new pattern to [Help users to navigate a service](/patterns/navigate-a-service)
- introduced a new [Service navigation component](/components/service-navigation/) and published a new [pattern to Help users to navigate a service](/patterns/navigate-a-service)
- updated the list of organisations and brand colours
- added a new feature to stop long words from ‘breaking’ out of components
- improved how the Breadcrumbs component appears on screen readers
- fixed some alignment issues with Radio buttons and Checkboxes
- introduced new features to help you include only the components your service uses
- introduced a new [Password input component](/components/password-input/)
- introduced a new [Password input component](/components/password-input/)
- updated the crown in the header, favicon and social share images
- updated the components, patterns and styles to be compliant with WCAG 2.2
- made it easier for teams to understand [what's changed in WCAG 2.2 and what they need to do](/accessibility/wcag-2.2)
Expand Down
2 changes: 1 addition & 1 deletion src/components/accordion/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Do not use the accordion component if the amount of content inside will make the

## Decide between using accordions, tabs and details

Accordions, [tabs](/components/tabs/) and [details](/components/details/) all work by hiding sections of content which a user can choose to reveal. Avoid using any of these components within one another.
The Accordion component, [Tabs component](/components/tabs/) and [Details component](/components/details/) all work by hiding sections of content which a user can choose to reveal. Avoid using any of these components within one another.

If you decide to use one of these components, consider if:

Expand Down
4 changes: 2 additions & 2 deletions src/components/back-link/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ Although browsers have a back button, some sites break when you use it - so many

## When to use this component

Always include the back link component on GOV.UK [question pages](/patterns/question-pages/).
Always include the Back link component on GOV.UK [Question pages in your service](/patterns/question-pages/).

You can include a back link on other pages within a multi-page transaction, if it makes sense to do so.

## When not to use this component

Never use the back link component together with [breadcrumbs](/components/breadcrumbs/). If necessary, you should do research with your users to learn which they find more helpful in your service.
Never use the back link component together with the [Breadcrumbs component](/components/breadcrumbs/). If necessary, you should do research with your users to learn which they find more helpful in your service.

## How it works

Expand Down
8 changes: 4 additions & 4 deletions src/components/button/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ Use the button component to help users carry out an action like starting an appl

Write button text in sentence case, describing the action it performs. For example:

- ‘Start now’ at the [start of the service](/patterns/start-using-a-service/)
- ‘Start now’ at the [start of your service](/patterns/start-using-a-service/)
- ‘Sign in’ to an account a user has already created
- ‘Continue’ when the service does not save a user’s information
- ‘Save and continue’ when the service does save a user’s information
- ‘Save and come back later’ when a user can save their information and come back later
- ‘Add another’ to add another item to a list or group
- ‘Pay’ to make a payment
- ‘Confirm and send’ on a [check answers](/patterns/check-answers/) page that does not have any legal content a user must agree to
- ‘Accept and send’ on a [check answers](/patterns/check-answers/) page that has legal content a user must agree to
- ‘Confirm and send’ on a [Check answers page](/patterns/check-answers/) that does not have any legal content a user must agree to
- ‘Accept and send’ on a [Check answers page](/patterns/check-answers/) that has legal content a user must agree to
- ‘Sign out’ when a user is signed in to an account

You may need to include more or different words to better describe the action. For example, ‘Add another address’ and ‘Accept and claim a tax refund’.
Expand All @@ -65,7 +65,7 @@ Avoid using multiple default buttons on a single page. Having more than one main

### Start buttons

Use a start button for the main call to action on your service’s [start page](/patterns/start-using-a-service/).
Use a start button for the main call to action on [your service’s Start page](/patterns/start-using-a-service/).
Start buttons do not usually submit form data, so use a link tag instead of a button tag.

{{ example({ group: "components", item: "button", example: "start", html: true, nunjucks: true, open: false }) }}
Expand Down
4 changes: 2 additions & 2 deletions src/components/character-count/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If your users keep hitting the character limit imposed by the backend of your se

## How it works

It tells users how many characters they have remaining as they type into a [textarea](/components/textarea/) with a character limit.
It tells users how many characters they have remaining as they type into a [Textarea component](/components/textarea/) with a character limit.

Users will get updates at a pace that works best for the way they interact with the textarea. This means:

Expand All @@ -50,7 +50,7 @@ There are 2 ways to use the character count component. You can use HTML or, if y

### If you’re asking more than one question on the page

If you're asking more than one question on the page, do not set the contents of the `<label>` as the page heading. Read more about [asking multiple questions on question pages](/patterns/question-pages/#asking-multiple-questions-on-a-page).
If you're asking more than one question on the page, do not set the contents of the `<label>` as the page heading. Read more about [asking multiple questions on Question pages](/patterns/question-pages/#asking-multiple-questions-on-a-page).

{{ example({ group: "components", item: "character-count", example: "without-heading", html: true, nunjucks: true, open: false }) }}

Expand Down
Loading

0 comments on commit 9b26345

Please sign in to comment.