fix(deps): update dependency govuk-frontend to v4 #403
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.
This PR contains the following updates:
^3.14.0
->^4.0.0
Release Notes
alphagov/govuk-frontend
v4.3.1
Compare Source
Recommended changes
Replace deprecated
govuk-!-margin-static
andgovuk-!-padding-static
classesWe've fixed an error in the naming convention of the static spacing override classes we'd introduced in v4.3.0. These classes should start with
govuk-!-static
, and we've now deprecated the incorrect classes.If you're using the static spacing margin override classes, replace any classes starting with
govuk-!-margin-static
withgovuk-!-static-margin
. For example:govuk-!-margin-static-2
would becomegovuk-!-static-margin-2
.If you're using the static spacing padding override classes, replace any classes starting with
govuk-!-padding-static
withgovuk-!-static-padding
. For example:govuk-!-padding-static-2
would becomegovuk-!-static-padding-2
.We've deprecated the
govuk-!-margin-static
andgovuk-!-padding-static
classes, and will remove them in a future major release.This change was introduced in pull request #2770: Fix ordering of properties in static spacing override classes. Thanks to @garrystewart for reporting this issue.
Fixes
We’ve made fixes to GOV.UK Frontend in the following pull requests:
console.log
calls from accordion JavaScriptv4.3.0
Compare Source
New features
Customise the Open Graph image URL without duplicate meta tags
You can now customise the Open Graph image URL included in the
head
by setting theopengraphImageUrl
Nunjucks option.Also, the default Open Graph image URL meta tag will now only be included if you set the either
opengraphImageUrl
orassetUrl
.This was added in pull request #2673: Allow Open Graph image URL to be customised.
Localise the content licence and copyright statements
When using the footer Nunjucks macro, you can now translate the text of the Open Government Licence (OGL) and Crown copyright statements using the
contentLicence
andcopyright
parameters.Visit The National Archives' documentation on OGL and Crown copyright for information on what you need to include in these statements.
This was added in pull request #2702: Allow localisation of content licence and copyright notices in Footer.
Pass HTML directly into compatible components
If using the Nunjucks macros, you can now pass HTML content directly into compatible components using the Nunjucks call syntax. If HTML is provided through the call syntax, the nunjucks macro will ignore the HTML and text options.
Components updated to support this syntax are:
descriptionHtml
parameter)This was added in pull request #2734: Update various components to be callable.
Use new override classes to apply static spacing
You can now use static spacing override classes to apply spacing from the static spacing scale to elements of your design.
The new classes start with:
govuk-!-static-
followed by eithermargin-
orpadding-
, and then a spacing unit number.To apply spacing in a single direction, include
left-
,right-
,top-
, orbottom-
just before the spacing unit.For example:
govuk-!-static-margin-9
will apply a 60px margin to all sides of the element at all screen sizesgovuk-!-static-padding-right-5
will apply 25px of padding to the right side of the element at all screen sizesgovuk-!-static-margin-0
will remove all margins at all screen sizesThis was added in pull request #2672: Add static spacing override classes. Thanks to @patrickpatrickpatrick for this contribution.
Deprecated features
Remove deprecated
govuk-header__navigation--no-service-name
class in the headerWe've deprecated the
govuk-header__navigation--no-service-name
class, and will remove it in a future major release.This was added in pull request #2694: Deprecate .govuk-header__navigation--no-service-name.
Recommended changes
We've recently made some non-breaking changes to GOV.UK Frontend. Implementing these changes will make your service work better.
Add
hidden
to the mobile menu button in the header componentIf you're not using the Nunjucks macros, add the
hidden
attribute to the mobile menu button in the header component. The mobile menu button isgovuk-header__menu-button
.We've changed the header's mobile menu functionality to use the
hidden
attribute instead of using CSS to show/hide the mobile menu. Addinghidden
to the mobile menu button by default will make sure that it does not display for users when javascript does not load.This was added in pull request 2727: Make use of hidden in header navigation functionality. Thanks to @NickColley and @kr8n3r for their contributions.
Fixes
In pull request 2678: Replace ex units with ems for input lengths, we changed how we define input lengths in our CSS. Browsers might now display these inputs as being slightly wider than before. The difference is usually fewer than 3 pixels.
We’ve also made fixes in the following pull requests:
v4.2.0
Compare Source
New features
Help users navigate through pages with pagination
You can now use pagination to help users navigate forwards and backwards through a series of pages. For example, in search results or guidance that's divided into multiple website pages.
This was added in pull request #2610: Add pagination component.
Check checkboxes by using the
values
Nunjucks optionWhen using the
govukCheckboxes
Nunjucks macro, you can now use thevalues
option to determine which checkboxes should already be checked when the page loads.For example,
values: ['red', 'blue']
would check any checkboxes that have avalue
of 'red' or 'blue'.You can use this option instead of setting the boolean
checked
option on each individual checkbox.This change was introduced in pull request #2616: Allow selecting options by passing current values.
Check a radio button by using the
value
Nunjucks optionWhen using the
govukRadios
Nunjucks macro, you can now use thevalue
option to determine which radio should already be checked when the page loads.For example,
value: 'red'
would check the radio that has avalue
of 'red'.You can use this option instead of setting the boolean
checked
option on each individual radio.This change was introduced in pull request #2616: Allow selecting options by passing current values.
Select an option in a select by using the
value
Nunjucks optionWhen using the
govukSelect
Nunjucks macro, you can now use thevalue
option to determine which option should already be selected when the page loads.For example,
value: 'red'
would select the option that has avalue
of 'red'.You can use this option instead of setting the boolean
selected
option on each individual option.This change was introduced in pull request #2616: Allow selecting options by passing current values.
Recommended changes
Replace deprecated
govuk-header__link--service-name
class in the headerIf you're not using the Nunjucks macros in the header, replace any instances of the class
govuk-header__link--service-name
withgovuk-header__service-name
.We've deprecated the
govuk-header__link--service-name
class, and will remove it in a future major release.This change was introduced in pull request #2617: Do not make the service name in the header a link if no
serviceUrl
is provided.File extensions added for JavaScript ES Module imports
We have updated our component ES module JavaScript to include missing file extensions not provided in release 4.1.0. If you have received an error similar to the following, for example when running or building your application, this fix should resolve the issue.
You should not need to make any changes if you are successfully importing our JavaScript as ES modules with version 4.1.0, but there still might be config you can remove. For example, removing
fullySpecified: false
from your Webpack config file.This change was introduced in pull request #2658: Add missing mandatory file extensions for ESM JavaScript. Thanks to @colinrotherham and @tvararu for reporting issues and suggesting and testing fixes.
Fixes
We’ve made fixes to GOV.UK Frontend in the following pull requests:
serviceUrl
is providedrequire.resolve
to import GOV.UK Frontend JavaScript - thanks to @HughePaul for reporting this issue and testing the fixsass-loader
- thanks to @Garethp for reporting this issue, and to @Garethp and @richpjames for testing the fixv4.1.0
Compare Source
New features
Import GOV.UK Frontend JavaScript as ECMAScript (ES) modules
You can now import our component JavaScript into your service as ES modules, if you're using a bundler.
This change allows you to import only the JavaScript you need, and helps reduce duplication of polyfills.
Because we're shipping ES modules in addition to how we currently publish our component JavaScript, this change is backwards compatible. You will not be required to make any changes unless you want to.
If you want to import using ES modules, we recommend you only use
import
to import the JavaScript for components you're using in your service. For example:If you need to import all of GOV.UK Frontend's components, then use the
initAll
function to initialise them:Depending on the bundler you use, you may also need to make changes to your JavaScript bundler configuration file. You can read more in our installation instructions about importing JavaScript using a bundler.
This was added in pull request #2586: Publish our JavaScript as ES modules alongside Universal Module Definition (UMD).
Recommended changes
We've recently made some non-breaking changes to GOV.UK Frontend. Implementing these changes will make your service work better.
Remove
aria-live
from the character count componentIf you're not using the Nunjucks macros, remove the
aria-live
attribute from the character count message element. This element's content no longer updates, as we've moved the live counter functionality to a new element injected by JavaScript.This change was introduced in pull request #2577: Refactor character count to inject new element.
Remove
pattern
from the date input componentIf you're not using the Nunjucks macros, remove
pattern="[0-9]*"
from each of the date input's elements.We originally added the
pattern
attribute to make numeric keypad functionality the default functionality in Safari on iOS. However, we no longer need to use it, as theinputmode
attribute provides this functionality for newer Safari versions.This change was introduced in pull request #2599: Remove
pattern
attribute from date input component.Fixes
We've made the following fixes in pull request #2577: Refactor character count to inject new element:
We’ve also made fixes in the following pull requests:
$govuk-text-colour
is set to a non-colour valuemaxlength
attribute fromtextarea
after character count JavaScript has been initialisedv4.0.1
Compare Source
Recommended changes
We've recently made some non-breaking changes to GOV.UK Frontend. Implementing these changes will make your service work better.
Remove the
tabindex
attribute from the error summary componentIf you're not using Nunjucks macros, remove the
tabindex
attribute from the error summary's HTML. The component JavaScript now adds and removes this attribute.This change was introduced in pull request #2491: Prevent error summary from being refocused after it has been initially focused on page load.
Fixes
We’ve made fixes to GOV.UK Frontend in the following pull requests:
v4.0.0
Compare Source
Breaking changes
This release contains a lot of breaking changes, but we expect many of them will only affect a small number of users. However, to make sure your service still works after you upgrade, you should read the release notes and make any required changes.
Check your accordions still display as expected
We've changed the design of the accordion. You can see its new look and read the revised guidance, particularly about when and when not to use accordions.
You should check your accordions still display as expected if you have any:
You do not need to make changes to the content that accordions hide or show, as this release's changes do not affect it.
These changes were introduced in pull request #2257: Update accordion design. Thanks to Mia Allers, Owen Jones, Nikin Nagewadia and Chris Yoong for their contributions.
Only use the accordion’s summary line for ‘phrasing content’
The summary line is now inside the HTML
button
element, so you can only add 'phrasing content' to it. Do not use any non-phrasing content, as the resulting HTML will not be valid.This change was introduced in pull request #2257: Update accordion design.
Review and revise the accordion's summary line content
Only add a summary line if you need to, as it's likely to make the button text too long.
If you're already using the summary line, review your use of the summary line to make sure you actually need it.
If you need to keep the summary line, review the accordion guidance and make the summary line as short as possible.
Update the HTML for summary lists
We've updated the HTML for the summary list component to avoid nesting
<span>
elements within<dd>
elements, which is invalid HTML. This update only affects you if you have summary lists that include a mix of rows with and without actions. You can read more about adding actions to rows.If you're not using Nunjucks macros, do not include an empty
<span class="govuk-summary-list__actions"></span>
in rows without actions. Instead, add thegovuk-summary-list__row--no-actions
modifier class to the row.This change was introduced in pull request #2323: Avoid invalid nesting of
<span>
within a<dd>
in summary list. Thanks to Malcolm Hire for reporting this issue.Update the HTML for navigation in the header
We've updated the HTML for the header. This update only affects you if your header includes navigation.
Any additional classes passed using the
navigationClasses
Nunjucks option are now applied to the<nav>
rather than the<ul>
. Check the additional classes are still doing what you expect.If you're not using Nunjucks macros, then you should:
<button>
inside the<nav>
, immediately before the<ul>
aria-label
attribute from the<ul>
to the<nav>
govuk-header__navigation
class from the<ul>
to the<nav>
govuk-header__navigation-list
class to the<ul>
Check your changes against the header example in the Design System to make sure you have correctly implemented them.
This change was introduced in pull request #2427: Improve the screen reader experience for the header menu.
Style any custom HTML in your cookie banner
We've removed the default font styles from the cookie banner Sass. This change makes it more obvious when you have not added classes and styles to any custom HTML.
If you're passing custom HTML into the cookie banner component (for example, using the
html
Nunjucks parameter), you must make sure you're applying the appropriate classes and styles to that HTML. This could look like, for example, adding thegovuk-body
class to any paragraph tags. You must do this to prevent your cookie banner displaying with unstyled text.This change was introduced in pull request #2432: Remove default font styles from cookie banner Sass.
Update the HTML for hints
In GOV.UK Frontend v3.8.0, we updated the HTML for hints to use a
<div>
rather than a<span>
element, to allow the use of block elements. We've now removed the styles which made the hint<span>
display as block.If you’re not using Nunjucks macros, update your hint HTML to use a
<div>
rather than a<span>
. For example:<div id="input-hint" class="govuk-hint"></div>
instead of<span id="input-hint" class="govuk-hint"></span>
.This change was introduced in pull request #2437: Remove
display:block
on hint component.Include JavaScript for skip link to improve screen reader announcements
We've added JavaScript for the skip link component to set focus to the linked element, for example, the main content on the page. This helps screen readers read the linked content when users use the skip link component.
If you're importing JavaScript for individual components, import the skip link JavaScript.
If you're not using Nunjucks macros, add a
data-module="govuk-skip-link"
attribute to the component HTML. For example:Once you've made the changes, check the skip link JavaScript works. To do this, select the skip link and check the linked element (usually the
<main>
element) in the browser has atabindex
attribute.This change was introduced in pull request #2450: Set focus to skip link target to improve screen reader announcements.
Update the HTML for error messages
We’ve updated the HTML for the error message component to use a
<p>
element instead of a<span>
element, as this is more semantically correct.If you’re not using Nunjucks macros, swap the
<span class="govuk-error-message">
for a<p class="govuk-error-message">
.This change was introduced in pull request #2452: Update error messages to use paragraph tags instead of spans.
Check components that conditionally reveal content still work
On radios and checkboxes, the JavaScript now looks within the whole page for conditionally-revealed content. Before, it only looked within the same set of radios or checkboxes.
If you see unexpected behaviour, make sure the revealed content's
id
is unique within the page the content is on. Reusing the sameid
within a page could cause a radio or checkbox to reveal or hide the wrong element, and also means your HTML is invalid.This change was introduced in pull request #2370: Prevent issues with conditionally revealed content when content
id
includes CSS syntax characters.Check the character count component still works as expected
On character counts, the JavaScript now looks within the whole page for the count message, which will be something similar to “You have 200 characters remaining”. Before, it only looked within the character count component.
If you see unexpected behaviour, make sure the
id
for the textarea component is unique within the page the content is on. Reusing the sameid
within a page could cause the wrong count message to update, and also means your HTML is invalid.This change was introduced in pull request #2408: Prevent issues with character count when textarea
id
includes CSS syntax characters.Check individually-imported JavaScript modules work as expected
You do not need to do anything if you have done at least one of the following:
all.js
We've changed the naming of our components' JavaScript modules so individual imports are now attached to
window.GOVUKFrontend.[ComponentName]
instead ofwindow.GOVUKFrontend
.You can now import multiple modules without overwriting the previous one, for example:
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.