Update dependency govuk-frontend to v4.8.0 #48
Merged
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:
4.3.1
->4.8.0
Release Notes
alphagov/govuk-frontend (govuk-frontend)
v4.8.0
: GOV.UK Frontend v4.8.0Compare Source
This release includes the ability to update the crown logo. You must do this between 19 February and 1 March 2024.
We’ll send reminders to our mailing list and cross-government Slack as soon as you can make this change.
New features
Update to the new GOV.UK logo (between 19 February and 1 March 2024)
We’ve updated the GOV.UK logo to reflect the changing of the monarch. King Charles III uses the Tudor Crown, rather than the St Edward’s Crown chosen by Queen Elizabeth II.
If your service uses GOV.UK branding, you must update your service to use the new crown.
These changes were made in the following pull requests:
Include the new logo assets
Multiple new image assets are included in this release. You’ll need to copy these to your service's image assets folder if they are not being used directly from the Frontend package. By default this folder is located at
/assets/images
.If you’re using Nunjucks, the asset path may have been changed by the
assetPath
global variable orassetsPath
parameter on the header component.Copy the following files from
/dist/assets/images
into your assets folder. Any images with the same name as an existing image can be safely overwritten.Update the logo in the header of your page
If you are using the
govukHeader
Nunjucks macro in your service, add theuseTudorCrown
parameter to the macro instantiation.If you are not using the Nunjucks macro, locate the HTML for the existing crown and replace it with this updated HTML. Make sure the URL for the new PNG fallback image is correct.
v4.7.0
Compare Source
Note: This release was created from the
support/4.x
branch.New features
Added the Exit This Page component to help users quickly exit a page or service
You can now choose to use the exit this page component to help users quickly leave a page or service which contains sensitive information.
This was added in pull request #2545: Add exit this page component.
Added inverse modifier for buttons on dark backgrounds
You can now choose to use the
govuk-button--inverse
class to style buttons on dark backgrounds with a white background colour.This change was made in pull request #3556: Add inverse button styles.
Added inverse modifier for breadcrumbs on dark backgrounds
You can now choose to use the
govuk-breadcrumbs--inverse
class to style breadcrumbs on dark backgrounds with white text, links and arrows.This change was made in pull request #3774: Add inverse breadcrumb and back link modifiers and styles.
Added inverse modifier for back links on dark backgrounds
You can now choose to use the
govuk-back-link--inverse
class to style back links on dark backgrounds with white links and arrows.This change was made in pull request #3774: Add inverse breadcrumb and back link modifiers and styles.
Fixes
We’ve made fixes to GOV.UK Frontend in the following pull requests:
v4.6.0
Compare Source
New features
Updated the appearance of disabled form controls
We’ve updated the disabled state of Text Input, Textarea, Select and File Upload components so it is consistent across browsers and devices. They’re also now consistent with the existing disabled styles for Buttons, Checkboxes, and Radios.
Disabled form controls appear at 50% opacity and with an alternative cursor appearance when hovered over.
This was added in pull request #3187: Add disabled styles for form controls.
Added a top-level
disabled
parameter to form controlsWe’ve updated the Nunjucks macros for Text Input, Textarea, Select and File Upload components to include a top-level
disabled
parameter. This will make it easier to enable the disabled state for these controls.Disabled form controls have poor contrast and can confuse some users, so avoid them if possible.
Only use disabled form controls if research shows it makes the user interface easier to understand.
This was added in pull request #3187: Add disabled styles for form controls.
Configure whether the Accordion remembers and restores sessions
By default, when a user leaves a page, the Accordion will remember the layout of expanded and collapsed sections selected by the user. If the user returns to the page, this layout will be restored and override any sections manually set as expanded in code.
You can now disable this functionality by using the
rememberExpanded
option in thegovukAccordion
Nunjucks macro.If you're not using the Nunjucks macro, you can disable it using the
data-remember-expanded
HTML attribute.This was added in pull request #3342: Add option to disable sessionState in Accordion.
Added
id
parameter to ButtonsWe’ve updated the Button Nunjucks macro to include an optional
id
parameter.This was added in pull request #3344: Adding optional ‘id’ attribute to button component.
Thanks to Tom Billington for this contribution.
Added a modifier for text input styles that accept sequences of digits
We've added a new
.govuk-input--extra-letter-spacing
class for Text Input. This increases readability of text inputs that receive sequences of digits (like security codes, references or phone numbers).You can add it through the
classes
option when using Nunjucks, or directly in theclass
attribute of the<input>
when using HTML.This was added in pull request #2230: Add extra letter spacing modifier for inputs
Deprecated features
Stop using JavaScript API properties other than the
init
methodWe have deprecated all of the JavaScript properties in the API, except for the
init
method for each component. We'll make all of the deprecated JavaScript properties private in our next main release.Please let us know if you're using parts of the API other than the
init
method by filling in this form. We'll use this information when prioritising future additions to the public API.This was added in pull request #3499: Deprecate all JavaScript instance properties the except
init
method.Stop using the
.govuk-button--disabled
class on buttonsWe have deprecated the
.govuk-button--disabled
class and will remove it in the next major release.If a Button uses a
<button>
or<input>
element, use the disabled HTML attribute instead.You will not need to make any changes if you're using the
govukButton
Nunjucks macro.Disabling links that are styled to look like buttons will not be supported by future releases.
This was added in pull request #3326: Deprecate
govuk-button--disabled
class.Stop using the deprecated Internet Explorer 8 mixins and settings
The next main release of GOV.UK Frontend will remove support for Internet Explorer 8 (IE8). In preparation for this, we've deprecated the settings and mixins used when generating IE8 specific stylesheets.
You'll start seeing deprecation warnings if you're:
govuk-if-ie8
andgovuk-not-ie8
mixins in your own Sass code (for example@include govuk-if-ie8
)$govuk-is-ie8
and$govuk-ie8-breakpoint
settings to anything other than their default valuesIf you no longer need to support IE8, we recommend you stop generating an IE8 specific stylesheet and remove references to the IE8 mixins from your code.
You can also silence these deprecation warnings by adding
ie8
to the$govuk-suppressed-warnings
setting, but once we’ve released v5.0 you will need to address them as part of the upgrade process.Fixes
We’ve made fixes to GOV.UK Frontend in the following pull requests:
v4.5.0
Compare Source
New features
Use summary cards to visually separate multiple summary lists on a single page
You can now use the summary card. This new variant of the Summary list component can help you:
This was added in pull request #2931: Add summary card enhancement to summary list.
Search within accordion content on supporting browsers
We've updated the Accordion component to use the new
hidden="until-found"
attribute value.This allows the browser's native 'find in page' functionality to search within and automatically open sections of the accordion. Currently, this functionality is only supported by recent versions of Google Chrome, Microsoft Edge and Samsung Internet.
This was added in pull requests:
hidden='until-found'
.js-enabled
page loadSource maps for precompiled files
You can now use source maps to help identify errors and console messages from GOV.UK Frontend precompiled files.
This was added in pull request #3023: Add source maps to compiled JavaScript and CSS.
Fixes
We've fixed errors in IE8 caused by updates to our precompiled JavaScript. The issue prevented some polyfills from running, but was limited to the
release-v4.4.1.zip
andrelease-v4.4.0.zip
assets on GitHub releases:We've made fixes to GOV.UK Frontend in the following pull requests:
classList
polyfill from header component JavaScriptEvent
polyfill to accordion component JavaScriptv4.4.1
Compare Source
Note: This release was created from the
support/4.4.x
branch.Fixes
We've made fixes to GOV.UK Frontend in the following pull requests:
v4.4.0
Compare Source
New features
Change the Button component's background and text colour
For non-GOV.UK branded websites, you can now change the Button component background and text colour.
To change the Button component background colour, set the
$govuk-button-background-colour
Sass variable.To change the Button component text colour, set the
$govuk-button-text-colour
Sass variable.This was added in pull request #2752: Change the Button component background and text colour. Thanks to Nick Colley for this contribution.
Localise the navigation menu toggle button
When using the header Nunjucks macro, you can now translate the text of the mobile navigation menu toggle button by using the
menuButtonText
parameter.You should avoid lengthy values for the
menuButtonText
parameter. If the text is too long it can overflow and cause visual issues.This was added in pull request #2720: Add parameter to localise mobile menu toggle button.
Localise the character count's textarea description/fallback text
When using the character count Nunjucks macro, you can now translate the description of textarea by using the
textareaDescriptionText
option.This text is announced by screen readers when the character count input is focused. It's also displayed visually as a fallback if JavaScript is not available.
This was added in pull request #2742: Add ability to customise character count fallback text, and the option renamed to
textareaDescriptionText
in pull request #2915.Localise the character count's counter message
You can now translate the text shown by the character count component to inform users of:
The Nunjucks macro accepts new options so you can customise each message. You can:
charactersAtLimitText
orwordsAtLimitText
to provide the text that shows when users have reached the limit.charactersUnderLimitText
orwordsUnderLimitText
to provide the text that shows when users are under the limit. The component will pluralise the message according to the configured locale and the number of characters or words remaining.charactersOverLimitText
orwordsOverLimitText
to provide the text that shows when users are over the limit. The component will pluralise the message according to the configured locale and the number of characters or words remaining.You'll find guidance about the plural forms in our documentation about localising GOV.UK Frontend. The component will replace
%{count}
with the number of characters over or under the limit.If you're not using Nunjucks macros, you can use data-* attributes to provide these translations. Within the attribute value, any quotation marks or other characters reserved by HTML needs to be converted into their HTML entity equivalents.
You can:
data-i18n.characters-at-limit
ordata-i18n.words-at-limit
for when users are at the limitdata-i18n.characters-under-limit.{other,many,few,two,one,zero}
ordata-i18n.words-under-limit.{other,many,few,two,one,zero}
, with one suffix for each plural form required by your localedata-i18n.characters-over-limit.{other,many,few,two,one,zero}
ordata-i18n.words-over-limit.{other,many,few,two,one,zero}
, with one suffix for each plural form required by your localeYou can also provide these messages using a JavaScript configuration object when creating an instance of the component or initialising all components. See our guidance on localising GOV.UK Frontend for how to do this.
This was added in the following pull requests:
Localise the character count's input description for assistive technologies
When configuring the character count's limit in JavaScript, you can customise the description provided to assistive technologies when users focus the input (so it indicates the overall limit of characters or words).
Depending on the plural form required by your locale, you can pass the description in the HTML using the
data-i18n.textarea-description.{other,many,few,two,one,zero}
attribute on the element to provide the text to set as the description.You can also provide these messages using a JavaScript configuration object when creating an instance of the component or initialising all components. See our guidance on localising GOV.UK Frontend for how to do this.
This was added in pull request #2915.
Localise the accordion's toggle buttons
You can now translate the text of the accordion component's show and hide toggle buttons.
When using the Nunjucks macro, you can use the new
showSectionText
andhideSectionText
parameters to customise the text of the 'show' and 'hide' toggles in each section.You can also use
showAllSectionsText
andhideAllSectionsText
parameters to customise the text of the toggle at the top of the accordion.If you're not using the Nunjucks macro, you can customise these using data-* attributes. Within the attribute value, any quotation marks or other characters reserved by HTML needs to be converted into their HTML entity equivalents.
data-i18n.show-section
data-i18n.show-section-aria-label
data-i18n.hide-section
data-i18n.hide-section-aria-label
data-i18n.show-all-sections
data-i18n.hide-all-sections
You can also change this text for all instances of the Accordion using a JavaScript configuration object. See our guidance on localising GOV.UK Frontend for how to do this.
This was added in pull requests:
Suppress deprecation warnings
You can now suppress warnings from deprecations within GOV.UK Frontend by updating the
$govuk-suppressed-warnings
map in Sass. Every deprecation warning will now include a warning "key" which you can use in the following code, placed at the root of your sass project:This was added in #2911 Add warning suppression functionality
Configure components in JavaScript
JavaScript components can get the same configuration options in 2 ways - through data attributes, as before, and now when creating an instance. These components are:
Button
component, for itspreventDoubleClick
option (matchingdata-prevent-double-click
)CharacterCount
component, for itsmaxlength
,maxwords
andthreshold
options (matchingdata-maxlength
,data-maxwords
anddata-threshold
, respectively)ErrorSummary
component, for itsdisableAutoFocus
option (matchingdata-disable-auto-focus
)NotificationBanner
component, for itsdisableAutoFocus
option (matchingdata-disable-auto-focus
)You can leave out these configuration options when using the Nunjucks macro and provide configuration when:
initAll
For example:
You can find more information about component configuration in GOV.UK Frontend documentation.
This was added in pull requests specific for each components:
Recommended changes
Update the HTML for the error summary
If you're not using the Nunjucks macros, you can improve the experience for screen reader users by making these changes to the error summary markup:
aria-labelledby="error-summary-title"
androle="alert"
from the parent element (govuk-error-summary
)div
wrapper around the contents ofgovuk-error-summary
with the attributerole="alert"
id="error-summary-title"
from the error summaryh2
(govuk-error-summary__title
)This will enable screen reader users to have a better, more coherent experience with the error summary. It will make sure users of JAWS 2022 or later will hear the entire contents of the error summary on page load and therefore have further context on why there is an error on the page they're on.
This was added in pull request #2677: Amend error summary markup to fix page load focus bug in JAWS 2022.
Deprecated features
Stop using the compatibility mode settings
In GOV.UK Frontend v5.0 we will stop supporting compatibility with legacy codebases. We are therefore deprecating the compatibility mode variables associated with legacy codebases:
$govuk-compatibility-govukfrontendtoolkit
$govuk-compatibility-govuktemplate
$govuk-compatibility-govukelements
This was introduced in pull request #2882: Deprecate compatibility mode settings.
Stop using settings associated with legacy codebases
In GOV.UK Frontend v5.0 we will stop supporting compatibility with legacy codebases. As part of this, we're deprecating settings controlled by compatibility mode variables. This includes the
govuk-compatibility
mixin and the following settings:$govuk-use-legacy-palette
$govuk-use-legacy-font
$govuk-typography-use-rem
$govuk-font-family-tabular
This was introduced in pull request #2844: Remove compatibility mode from govuk-frontend.
Fixes
In pull request 2851: Support Prototype Kit v13 we've introduced support for the plugins system included in the upcoming Prototype Kit v13.
We've made fixes to GOV.UK Frontend in the following pull requests:
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - "after 10am every weekday,before 4pm every weekday" in timezone Europe/London.
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.