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.
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.
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.
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.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
#3817: Fix package resolution in Node.js 17+ #3836: Announce whitespace in screen reader announcements of visually hidden text
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.
We’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.
{{ govukInput({
id: "disabled-input",
name: "disabled-input",
value: "Unchangeable value",
disabled: true
}) }}
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.
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 the govukAccordion
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.
We’ve updated the Button Nunjucks macro to include an optional id
parameter.
{{ govukButton({
text: "Save and continue",
id: "continue-button"
}) }}
This was added in pull request #3344: Adding optional ‘id’ attribute to button component.
Thanks to Tom Billington for this contribution.
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 the class
attribute of the <input>
when using HTML.
This was added in pull request #2230: Add extra letter spacing modifier for inputs
We 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.
We 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.
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:
- using the
govuk-if-ie8
andgovuk-not-ie8
mixins in your own Sass code (for example@include govuk-if-ie8
) - changing the
$govuk-is-ie8
and$govuk-ie8-breakpoint
settings to anything other than their default values
If 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.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
- #3255: Including the JavaScript source map in the prototype kit config
- #3272: Add empty alt attribute to logo IE8 fallback PNG
- #3306: Re-enable complete hover link styles on the footer
- #3312: Add default value for warning text icon fallback attribute
- #3426: Add organisation brand colour for Department for Business & Trade - thanks to Barbara Slawinska for contributing this change
- #3454: Update default link underline offset setting
You can now use the summary card. This new variant of the Summary list component can help you:
- design and build pages with multiple summary lists
- show visual dividers between summary lists
- allow users to apply actions to entire lists
This was added in pull request #2931: Add summary card enhancement to summary list.
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:
- #3053: Enhance the Accordion component with
hidden='until-found'
- #3095: Hide Accordion content (again) during
.js-enabled
page load
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.
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
and release-v4.4.0.zip
assets on GitHub releases:
- #3137: Enable UglifyJS compatibility workarounds
- #3013: Swap JavaScript minifier from UglifyJS to terser
We've made fixes to GOV.UK Frontend in the following pull requests:
- #2998: Refactor back link and breadcrumb chevrons to use ems
- #3021: Change colour for current page link in the header to improve contrast when printing - thanks to Malcolm Butler for the contribution
- #3094: Fix Accordion margin/padding inconsistencies
- #3112: Remove unused
classList
polyfill from header component JavaScript - #3150: Add missing
Event
polyfill to accordion component JavaScript - #3156: Correct the closing double quotes in pagination Nunjucks - thanks to Joanna Pinto Paul for the contribution
- #3199: Fix Sass rounding issues with width of grid columns
We've made fixes to GOV.UK Frontend in the following pull requests:
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.
@import "node_modules/govuk-frontend/govuk/base";
$govuk-button-background-colour: govuk-colour("yellow");
$govuk-button-text-colour: govuk-colour("black");
@import "node_modules/govuk-frontend/govuk/components/button/index";
This was added in pull request #2752: Change the Button component background and text colour. Thanks to Nick Colley for this contribution.
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.
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.
You can now translate the text shown by the character count component to inform users of:
- when they have reached the maximum number of characters or words
- the number of characters or words over or under the allowed maximum
The Nunjucks macro accepts new options so you can customise each message. You can:
- Use
charactersAtLimitText
orwordsAtLimitText
to provide the text that shows when users have reached the limit. - Use
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. - Use
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:
- use
data-i18n.characters-at-limit
ordata-i18n.words-at-limit
for when users are at the limit - configure the text that informs the end user they are under the character or word limit, by using
data-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 locale - configure the text that informs the end user they are over the character or word limit, by using
data-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 locale
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 the following pull requests:
- #2895 Add macro options to configure CharacterCount translations
- #2887 Allow CharacterCount component to receive i18n config via JS
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.
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
and hideSectionText
parameters to customise the text of the 'show' and 'hide' toggles in each section.
You can also use showAllSectionsText
and hideAllSectionsText
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:
- #2818: Add support for localisation via data-* attributes to Accordion component
- #2826: Add support for localisation via JavaScript configuration to Accordion component
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:
$govuk-suppressed-warnings: (
deprecated-feature
);
This was added in #2911 Add warning suppression functionality
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:
- the
Button
component, for itspreventDoubleClick
option (matchingdata-prevent-double-click
) - the
CharacterCount
component, for itsmaxlength
,maxwords
andthreshold
options (matchingdata-maxlength
,data-maxwords
anddata-threshold
, respectively) - the
ErrorSummary
component, for itsdisableAutoFocus
option (matchingdata-disable-auto-focus
) - the
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:
- creating a component, in a configuration object as second argument
- initialising components in bulk using
initAll
For example:
// Creating a single instance
var button = document.querySelector('[data-module="button"]')
new GOVUKFrontend.Button(button, {preventDoubleClick: true})
// Or initialising components in bulk
GOVUKFrontend.initAll({
button: {
preventDoubleClick: true
}
// Or, for the other components,
// characterCount: {/* options */},
// errorSummary: {/* options */},
// notificationBanner: {/* options */}
})
You can find more information about component configuration in GOV.UK Frontend documentation.
This was added in pull requests specific for each components:
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:
- Remove
aria-labelledby="error-summary-title"
androle="alert"
from the parent element (govuk-error-summary
) - Add a
div
wrapper around the contents ofgovuk-error-summary
with the attributerole="alert"
- Remove
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.
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.
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.
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:
- #2807: Tidy up and refactor the Character Count JavaScript
- #2811: Use Element.id to get module id for accordion
- #2821: Avoid duplicated --error class on Character Count
- #2800: Improve Pagination component print styles
- #2909: Fix JavaScript errors when entering text into the Character Count in IE8
We'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
with govuk-!-static-margin
. For example: govuk-!-margin-static-2
would become govuk-!-static-margin-2
.
If you're using the static spacing padding override classes, replace any classes starting with govuk-!-padding-static
with govuk-!-static-padding
. For example: govuk-!-padding-static-2
would become govuk-!-static-padding-2
.
We've deprecated the govuk-!-margin-static
and govuk-!-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.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
You can now customise the Open Graph image URL included in the head
by setting the opengraphImageUrl
Nunjucks option.
Also, the default Open Graph image URL meta tag will now only be included if you set the either opengraphImageUrl
or assetUrl
.
This was added in pull request #2673: Allow Open Graph image URL to be customised.
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
and copyright
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.
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:
- Details
- Error summary (mapped to
descriptionHtml
parameter) - Inset text
- Notification banner
- Panel
This was added in pull request #2734: Update various components to be callable.
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 either margin-
or padding-
, and then a spacing unit number.
To apply spacing in a single direction, include left-
, right-
, top-
, or bottom-
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 sizes
This was added in pull request #2672: Add static spacing override classes. Thanks to @patrickpatrickpatrick for this contribution.
We'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.
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 component
If you're not using the Nunjucks macros, add the hidden
attribute to the mobile menu button in the header component. The mobile menu button is govuk-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. Adding hidden
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.
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:
- #2668: Fix Summary List action link alignment
- #2670: Define minimum width for select component - thanks @Nosfistis for reporting this issue
- #2723: Style accordion and tabs text content with govuk-body class
- #2724: Remove redundant aria-hidden attribute from the content when using the Details polyfill
- #2725: Remove padding-right from last column in summary list row - thanks @edwardhorsford for reporting this issue and suggesting a fix
- #2737: Avoid unnecessary spacing-related media queries
- #2747: Ensure accordion uses overriden focus colour - thanks @NickColley for reporting this issue and suggesting a fix
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.
When using the govukCheckboxes
Nunjucks macro, you can now use the values
option to determine which checkboxes should already be checked when the page loads.
For example, values: ['red', 'blue']
would check any checkboxes that have a value
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.
When using the govukRadios
Nunjucks macro, you can now use the value
option to determine which radio should already be checked when the page loads.
For example, value: 'red'
would check the radio that has a value
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.
When using the govukSelect
Nunjucks macro, you can now use the value
option to determine which option should already be selected when the page loads.
For example, value: 'red'
would select the option that has a value
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.
If you're not using the Nunjucks macros in the header, replace any instances of the class govuk-header__link--service-name
with govuk-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.
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.
Cannot find module '../node_modules/govuk-frontend/govuk-esm/common' imported from ../node_modules/govuk-frontend/govuk-esm/all.mjs
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.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
- #2617: Do not make the service name in the header a link if no
serviceUrl
is provided - #2640: Add top padding to accordion section
- #2644: Allow users to use
require.resolve
to import GOV.UK Frontend JavaScript - thanks to @HughePaul for reporting this issue and testing the fix - #2647: Allow users to import sass files via Webpack
sass-loader
- thanks to @Garethp for reporting this issue, and to @Garethp and @richpjames for testing the fix - #2659: Add missing label and legend classes to HTML fixtures
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:
import { SkipLink, Radios } from 'govuk-frontend'
var $skipLink = document.querySelector('[data-module="govuk-skip-link"]')
if ($skipLink) {
new SkipLink($skipLink).init()
}
var $radios = document.querySelectorAll('[data-module="govuk-radios]')
if ($radios) {
for (var i = 0; i < $radios.length; i++) {
new Radios($radios[i]).init()
}
}
If you need to import all of GOV.UK Frontend's components, then use the initAll
function to initialise them:
import { initAll } from 'govuk-frontend'
initAll()
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).
We've recently made some non-breaking changes to GOV.UK Frontend. Implementing these changes will make your service work better.
If 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.
If 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 the inputmode
attribute provides this functionality for newer Safari versions.
This change was introduced in pull request #2599: Remove pattern
attribute from date input component.
We've made the following fixes in pull request #2577: Refactor character count to inject new element:
- fix character count message being repeated twice by screen readers
- fix character count hint text being announced as part of the count message
- fix multiple outdated character count messages being announced at once
- fix character count message being announced when input length is below a defined threshold
We’ve also made fixes in the following pull requests:
- #2549: Fix header with product name focus and hover state length
- #2573: Better handle cases where
$govuk-text-colour
is set to a non-colour value - #2590: Remove
maxlength
attribute fromtextarea
after character count JavaScript has been initialised - #2615: Fix hints for disabled checkboxes or radios appearing darker than the associated labels
We've recently made some non-breaking changes to GOV.UK Frontend. Implementing these changes will make your service work better.
If 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.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
- #2475: Tweak whitespace HTML for text input component to improve readability
- #2494: Allow disabling autofocus on error summary
- #2514: Fix accordion heading style while JavaScript is disabled
- #2515: Add explicit width to summary list row with 'no actions' pseudo-element
- #2524: Fix select component renders with grey background in Firefox and Safari
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.
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:
- accordions with custom styles
- section headings that contain unusual formatting (for example, wrappers)
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.
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.
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.
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 the govuk-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.
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:
- move the
<button>
inside the<nav>
, immediately before the<ul>
- move the
aria-label
attribute from the<ul>
to the<nav>
- move the
govuk-header__navigation
class from the<ul>
to the<nav>
- add the
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.
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 the govuk-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.
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.
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:
<div class="govuk-skip-link" data-module="govuk-skip-link">
...
</div>
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 a tabindex
attribute.
This change was introduced in pull request #2450: Set focus to skip link target to improve screen reader announcements.
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.
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 same id
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.
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 same id
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.
You do not need to do anything if you have done at least one of the following:
- followed our Getting Started guide and are importing all of the GOV.UK Frontend JavaScript in one go via
all.js
- installed GOV.UK Frontend using precompiled files
We've changed the naming of our components' JavaScript modules so individual imports are now attached to
window.GOVUKFrontend.[ComponentName]
instead of window.GOVUKFrontend
.
You can now import multiple modules without overwriting the previous one, for example:
//= require govuk/components/accordion/accordion.js
//= require govuk/components/button/button.js
# These modules are available under window.GOVUKFrontend.Accordion and window.GOVUKFrontend.Button respectively
If you're importing JavaScript modules individually, you should check any references to window.GOVUKFrontend
in your code and update them to point to the correct component, window.GOVUKFrontend.[ComponentName]
. You can now remove any workarounds you may have implemented.
This change was introduced in pull request #2426: Rename exported JavaScript modules to include component name. Thanks to Alex Jurubita for reporting this issue.
If you import individual files from the core
or overrides
layers, you might see the error Undefined mixin 'govuk-exports'
or no mixin named govuk-exports
when compiling your Sass.
To fix the error, import node_modules/govuk-frontend/govuk/base
first. For example:
@import "node_modules/govuk-frontend/govuk/base";
@import "node_modules/govuk-frontend/core/typography";
This change was introduced in pull request #2455: Remove 'base' import from files in core
and overrides
layers.
If you import the 'template' Sass file from the core
layer, you might see the error File to import not found or unreadable: template
when compiling your Sass.
To fix this error, replace any imports of node_modules/govuk-frontend/govuk/core/template
with node_modules/govuk-frontend/govuk/objects/template
.
This change was introduced in pull request #2463: Move template styles from core
to objects
layer.
We’ve made some fixes to the alignment of columns within the footer component, so they now align with our grid. We've also removed the logic that assumes a 2-section layout displays as a 'two-thirds and one-third' layout. Footer sections now display as full-width by default.
If you're using the Nunjucks macros, check your footer displays as expected and use the width
macro option to set the width you want for each section.
If you're not using the Nunjucks macros, check your footer displays as expected and use the standard Design System grid classes on the govuk-footer__section
element to set the width. For example:
<div class="govuk-footer__section govuk-grid-column-two-thirds">...</div>
This change was introduced in pull request #2462: Fix footer alignment with grid classes and add width
macro option.
In GOV.UK Frontend v3.8.0, we made the border width of form elements in their error state the same as for form elements in their normal state and deprecated the $govuk-border-width-form-element-error
variable.
Before, an element's border got thicker to show the element was in an error state. However, elements in their focused state also have a thicker border. As a result, when users focused an element in an error state, the only visible border-change was from red to black. Not all users could perceive this change. So, we reduced the element border's width, to make sure its thickness changes when users focus.
We've now removed $govuk-border-width-form-element-error
completely.
If you’re referencing $govuk-border-width-form-element-error
in your own Sass, you must remove it. If you're also defining your own error state, you only need to change the border colour.
You should avoid overriding the border width. For example, replace border: $govuk-border-width-form-element-error solid $govuk-error-colour;
with border-color: $govuk-error-colour;
.
You should also remove any override of $govuk-border-width-form-element-error
from your Sass. This override no longer does anything.
This change was introduced in pull request #1963: Remove deprecated $govuk-border-width-form-element-error
variable.
We've removed the govuk-main-wrapper
and govuk-main-wrapper--l
mixins we deprecated in GOV.UK Frontend v3.0.0.
Remove any use of these mixins in your own Sass. You can replace these mixins with direct references to the spacing mixins.
This change was introduced in pull request #2385: Remove deprecated govuk-main-wrapper
and govuk-main-wrapper--l
mixins.
We've removed the iff
function we deprecated in GOV.UK Frontend version 3.6.0.
If you’re calling iff
from your own Sass, you should use Sass's native if
function instead.
This change was introduced in pull request #2409: Remove deprecated iff
Sass function.
We've removed the govuk-tag--inactive
class we deprecated in GOV.UK Frontend v3.6.0.
Replace any use of this class with the govuk-tag--grey
class.
This change was introduced in pull request #2417: Remove deprecated govuk-tag--inactive class
.
We've recently made some other changes to GOV.UK Frontend. While these are not breaking changes, implementing them will make your service work better.
You do not need to do anything if you're using Nunjucks macros.
There are some known issues with inputs of type="number"
. Read our research into the issues with type="number"
.
If you’re not using Nunjucks macros, remove the type="number"
attribute from the date input component.
Replace it with type="text"
and inputmode="numeric"
. For example:
<input class="govuk-input govuk-date-input__input" id="passport-issued-month" name="passport-issued-month" type="text" pattern="[0-9]*" inputmode="numeric">
This change was introduced in pull request #1704: Update date input to use type=text
and inputmode=numeric
.
If you’re not using Nunjucks macros, change the SVG markup within the header, footer and button components. We’ve added this fix so screen readers will not announce the fallback image to users.
For the header, footer and button, replace role="presentation"
with aria-hidden="true"
. For example:
<svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewBox="0 0 33 40" aria-hidden="true" focusable="false">
This change was introduced in pull request #1724: Fix fallback logo so Chrome will not flag it to screen readers.
Apply a data-nosnippet
attribute to the cookie banner component to stop it appearing in Google Search snippets.
If you’re not using Nunjucks macros, add a new data-nosnippet
attribute to the cookie banner.
<div class="govuk-cookie-banner " data-nosnippet role="region" aria-label="Cookies on your service">
This change was introduced in pull request #2192: Add data-nosnippet
to prevent cookie banner text appearing in Google Search snippets.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
- #2255: Prevent conditionally revealed questions getting out of sync when multiple sets of radios and checkboxes contain inputs with the same name
- #2323: Avoid invalid nesting of
<span>
within a<dd>
in summary list - #2370: Prevent issues with conditionally revealed content when content
id
includes CSS syntax characters - #2408: Prevent issues with character count when textarea
id
includes CSS syntax characters - #2426: Rename exported JavaScript modules to include component name
- #2434: Add brand colour for Department for Levelling Up, Housing and Communities (DLUHC) - thanks to Bruce Bolt for contributing this change
- #2447: Remove bottom margin from navigation on tablets
- #2448: Remove the border from the last item in the collapsible navigation menu in the header
You can now use the govuk-!-text-align-left
, govuk-!-text-align-centre
and govuk-!-text-align-right
CSS classes to set text alignment on elements.
This was added in pull request #2339: Add text-align
override classes. Thanks to Ed Horsford for reporting this issue.
You can now pass the negative equivalent of a point from the spacing scale to the govuk-spacing
function to get negative spacing.
For example, govuk-spacing(1)
returns 5px
, and govuk-spacing(-1)
returns -5px
.
This was added in pull request #2348: Allow govuk-spacing
to output negative spacing. Thanks to Chris Hill-Scott for reporting this issue.
- #2347: Prevent panel text overflowing when zoomed in on mobile - thanks to Phil Sherry for reporting this issue.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
- #2264: Improve focus state for radio and checkbox controls in forced colors mode (for example, Windows High Contrast Mode) – thanks to @adamliptrot-oc for reporting this issue
- #2265: Do not remove focus outline from disabled link buttons in forced colors mode
- #2273: Fix invisible footer on Open Government Licence logo in forced colors mode – thanks to @oscarduignan for reporting this issue
- #2277: Fix invisible start button chevron in forced colors mode
- #2290: Improve support for Internet Explorer 11 with Windows High Contrast Mode
- #2306: Add
max-width
to file upload component - #2312: Remove
padding-right
from details component
You can now add a 'none' option to checkboxes. For example, 'None of the above' or 'None of these options apply to me'.
Use the 'none' option to allow users to state that none of the checkboxes apply to them. Otherwise, users would have to work out that they should leave all the checkboxes unticked.
You can now also add an 'or' divider before the 'none' option. Use the 'or' divider to make the 'none' option more visible to users.
This was added in pull request #2151: Add 'None of the above' and 'or' divider to checkboxes. Thanks to @frankieroberto for contributing this improvement.
If your service has a Content Security Policy (CSP), you can now add a nonce
attribute to inline scripts within the Nunjucks page template. To do this, set the cspNonce
Nunjucks variable. However, you should only add this attribute if you're not able to include the hash for the inline scripts in your CSP.
Make sure you understand the security implications of using this attribute, as wrong implementation could affect your service’s security.
Read more about how to configure your CSP to work with GOV.UK Frontend.
This was added in pull request #2245: Allow the CSP nonce
attribute to be set on the inline script in the page template. Thanks to @natcarey for contributing this issue and its solution.
We've made the following fixes in pull request #2229: Change approach to fallback PNG in the header to fix blank data URI from triggering Content Security Policy error:
- fix blank data URI from triggering CSP error
- fix alignment of fallback PNG in the header
We’ve also made fixes in the following pull requests:
- #2228: Fix display of checkboxes in Internet Explorer 8
- #2237: Fix GOV.UK logo disappearing on light background in Windows High Contrast Mode
- #2251: Disable ink skipping for underlines in hover state
Links now have underlines that are consistently thinner and a bit further away from the link text.
Links also have a clearer hover state, where the underline gets thicker to make the link stand out to users.
These changes are an opt-in feature because you may:
- need to make changes to your service to introduce these new link styles consistently
- want to avoid opting in if you have links within a multiple-column layout in your CSS - there is a Chromium bug that affects such links
To enable this feature, set $govuk-new-link-styles
to true
before you import GOV.UK Frontend in your Sass:
// application.scss
$govuk-new-link-styles: true;
@import "govuk-frontend/all";
If you have created your own link styles, you should review them to ensure their use is consistent across your service.
To make it easier to be consistent in your use of link styles, we’ve also introduced new mixins and modifier classes for:
- removing underlines
- displaying white text on dark backgrounds
These new link styles will be enabled by default in a future major version of GOV.UK Frontend.
This was added in pull request #2183: Updates to link styles and link hover states.
You can now remove underlines from links by using either the:
govuk-link-style-no-underline
mixin in your Sass, orgovuk-link--no-underline
class in your HTML
An underline still appears when the user hovers their cursor over the link.
This was added in pull request #2214: Add no-underline mixin and modifier class.
You can now style links on dark backgrounds to use white text colour by using either the:
govuk-link-style-inverse
mixin in your Sass, orgovuk-link--inverse
class in your HTML
This was added in pull request #2213: Add inverse link mixin and modifier class.
You can now add links styled as buttons to cookie banners. For example, you can set the Hide button to be a link styled as a button that reloads the page. Use this feature if you set non-essential cookies on the server and want to help users keep their place using progressive enhancement.
This feature is enabled by default.
This was added in pull request #2164: Enable cookie banner to set link styled as a button.
- #2132: Improve vertical alignment of phase banner tag on mobile devices – thanks to @matthewmascord for contributing this issue.
- #2157: Use pointer cursor for 'Menu' button in header – thanks to @MalcolmVonMoJ for contributing this issue.
- #2171: Fix padding on GOV.UK logo affecting hover and focus states
- #2186: Fix display of warning text in Edge when Windows High Contrast Mode is enabled
- #2192: Add data-nosnippet to prevent cookie banner text appearing in Google Search snippets
- #2201: Set -webkit-appearance: button on file upload so text is aligned in Safari
- #2205: Stop file upload component 'jumping' on focus
- #2212: Add underline to crown copyright link in footer
You can now use cookie banners to allow users to accept or reject cookies which are not essential for making your service work.
This was added in pull request #2131: Add cookie banner component and button groups.
You can now use a button group when you place two or more buttons together.
Any links you include within a button group now line up visually with the buttons.
Read more about button groups on the Design System’s button page.
This was added in pull request #2114: Add button groups for use in cookie banner.
You can now make table captions larger or smaller by applying the govuk-table__caption--xl
, govuk-table__caption--l
, govuk-table__caption--m
or govuk-table__caption--s
classes.
This was added in pull request #2048: Add modifiers for table captions.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
- #2045: Stop same-site cookies from being wiped when printing in Internet Explorer 11 – thanks to @gunjam for contributing this issue.
- #2080: Fix JavaScript error when character count ID starts with a number - thanks to @josef-vlach for reporting this issue.
- #2092: Use tabular numbers for character count message - thanks to @quis for contributing this issue.
- #2093: Only output space after breadcrumbs class if there’s an additional class – thanks to @frankieroberto for contributing this issue.
- #2133: Remove user-agent default 2px horizontal margins on buttons in Safari
We’ve made fixes to the fixtures you can use to check your HTML matches GOV.UK Frontend.
These changes were made in the following pull requests:
- #2031: Include hidden status of the component examples in published fixtures – thanks to @andymantell for contributing this
- #2043: Fixes for a couple of component examples / fixtures – thanks to @andymantell for contributing this as well!
- #2071: Use non-bool type strings for attributes in test fixtures – thanks to @matthew-shaw for contributing this
There are no other changes to GOV.UK Frontend in this release.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
- #2035: Fix hairline gap between notification banner header and outer border on high resolution screens in Chrome/Edge (Blink)
- #2036: Explicitly set the text colour for notification banner content, rather than using the user-agent default text colour
- #2042: Wrap notification banner content at 2/3 grid width
You can now use notification banners to tell users about events that occur elsewhere in your service. For example, when they need to complete tasks.
This was added in pull request #1935: Create notification banner component.
You can now change which keyboard type displays for mobile and tablet users. This enables users to enter characters other than numbers when they use the date input. To change the keyboard type, set the inputmode
when you use the Nunjucks macro options.
This was added in pull request #1975: Enable custom inputmode for date input component. Thanks to @foaly-nr1 for contributing this issue.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
You can now use prefixes and suffixes in the text input component to help users enter things like currencies and measurements.
This was added in pull request #1816: Add input prefix and suffix. Thanks to @simonwhatley and the GOV.UK Coronavirus Services Team.
You can now use our test fixtures to check you're outputting the same HTML that GOV.UK Frontend uses.
This was added in pull request #1925: Generate fixtures.json files for components on build:package. Thanks to everyone who fed back on our test fixtures proposal.
If you use the header component with navigation, you can now:
- customise the section's
aria-label
text - add navigation items without links
You can use the new:
navigationLabel
option to set thearia-label
text for the navigation sectionmenuButtonLabel
option to set thearia-label
text for the button that hides or shows the navigation section on mobile
For example:
{{ govukHeader({
navigationLabel: "Custom navigation section aria-label",
menuButtonLabel: "Custom menu button aria-label"
}) }}
The default labels are now:
- Navigation menu for
navigationLabel
- Show or hide navigation menu for
menuButtonLabel
This was added in pull requests:
- #1905: Set navigation and mobile menu labels of the header component with new options
- #1943: Change header menu button label - thanks to @domoscargin for raising this issue
To add a navigation item without a link, use the text
or html
option to add the item but do not use the href
option.
For example:
{{ govukHeader({
navigation: [
{
html: "<form method='post' action='url.com'>
<input type='submit' class='app-logout-button-style' value='Log out' />
</form>"
}
]
}) }}
This was added in pull request #1921: Make it possible to exclude link from header navigation item.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
- #1918: Add new brand colour for FCDO - thanks to @deborahchua and @beccapearce for contributing this
- #1942: Set aria-expanded and aria-hidden attributes on header menu button and menu when page loads
- #1947 Add print styles for the panel component
We’ve made fixes to GOV.UK Frontend in the following pull requests:
$govuk-secondary-text-colour
and govuk-colour("dark-grey")
are now darker so users can more clearly read hint text that uses the colour.
The colour now has a contrast ratio of 7:1 against a white background, and helps hint text meet the WCAG 2.1 (AAA) accessibility standard.
This was added in pull request #1827: Make dark grey darker.
The error styling for the:
- text input, select and textarea components no longer makes the border thicker
- file upload component no longer includes a border around the file upload input
This means it’s easier for users to tell the difference between a field with an error and a field that's focused.
When an error message is about several fields, make sure you're clear which field has the error. You must not rely on users being able to tell which field has the error styling.
This was added in pull request #1870: Reduce border width of form inputs in the error state.
You can now turn spellcheck on or off in the input, textarea and character count components using the new spellcheck
option instead of the attributes
option.
For example:
{{ govukInput({
spellcheck: true
}) }}
This was added in pull requests:
From GOV.UK Frontend v4.0.0, you'll no longer be able to reference the $govuk-border-width-form-element-error
Sass setting.
Change any references to $govuk-border-width-form-element-error
in your Sass code so they reference $govuk-border-width-form-element
instead.
This was changed in pull request #1870: Reduce border width of form inputs in the error state.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
- #1838: Correctly camel case SVG attributes in the header and footer
- #1842: Preserve the state of conditional reveals when navigating 'back' in the browser
- #1848: Preserve the state of the character count when navigating 'back' in the browser
- #1855: Hint component can render block-level elements as valid HTML
- #1861: Fix the display of checkboxes when border-box box sizing is applied globally
- #1862: Fix display of warning text icon when border-box box sizing is applied globally #1862
- #1879: Explicitly set outline-offset to remove 1px transparent border in chrome v84
If a list is hard to read because the items run across multiple lines, you can now add extra spacing between list items using the new govuk-list--spaced
class.
This was added in pull request #1775: Add list--spaced modifier. Thanks to @frankieroberto for raising this issue.
You can now use HTML for a navigation item in the header component, using the new html
option.
This was added in pull request #1819: Add the ability to specify HTML for a navigation item. Thanks to @adamsilver.
You can now import node_modules/govuk-frontend/govuk/base
, instead of importing settings
, helpers
and tools
separately.
GOV.UK Frontend's Sass files now compile to CSS faster, because we've changed the way dependencies work when you import them.
If you already import node_modules/govuk-frontend/govuk/all
in your Sass file, you do not need to do anything. Sass will automatically compile faster.
If you import specific parts of GOV.UK Frontend in your Sass file instead, you can now make Sass compile faster by importing base
then a component's index
file. This will avoid GOV.UK Frontend importing dependencies multiple times.
For example:
@import "node_modules/govuk-frontend/govuk/base";
@import "node_modules/govuk-frontend/govuk/core/all";
@import "node_modules/govuk-frontend/govuk/objects/all";
@import "node_modules/govuk-frontend/govuk/components/button/index";
@import "node_modules/govuk-frontend/govuk/components/footer/index";
@import "node_modules/govuk-frontend/govuk/components/header/index";
Find out more about importing CSS.
This was added in pull request #1804: Allow components to be imported without dependencies. Thanks to @kevindew for raising this issue.
You can now collapse the breadcrumb component on mobile using the new collapseOnMobile
option, so it:
- shows only the first and last items
- does not wrap
This was added in pull request #1754: Add collapseOnMobile breadcrumbs flag. Thanks to @vanitabarrett and @miaallers.
The back link component is now:
- bigger, so it's easier to select if you're using a touch screen
- more consistent with the design of the breadcrumb component
This was added in pull request #1753: Make back link arrow consistent with breadcrumb component. Thanks to @vanitabarrett and @miaallers.
If you import specific files from the core
or overrides
layers, you’ll now see a deprecation warning when compiling Sass if you do not import node_modules/govuk-frontend/govuk/base
first.
To fix the warning, import node_modules/govuk-frontend/govuk/base
first. For example:
@import "node_modules/govuk-frontend/govuk/base";
@import "node_modules/govuk-frontend/core/typography";
If you do not import node_modules/govuk-frontend/govuk/base
first, your service will no longer work from GOV.UK Frontend v4.0.0.
This was added in pull request #1807: Warn if importing core, overrides without dependencies.
We’ve made fixes to GOV.UK Frontend in the following pull requests:
- #1778: Fix accordion underline hover state being removed when hovering plus/minus symbol
- #1765: Import textarea from character count
- #1796: Standardise accordion section headings font size (reduce height of section headings on mobile)
You can now use colour with tags to help distinguish between different tags - or to help draw the user’s attention to a tag if it’s especially important.
This also means you should replace the .govuk-tag--inactive
class with the .govuk-tag--grey
class. .govuk-tag--inactive
is now deprecated, and it will be removed in a future release.
Pull request #1711: Additional Tag modifier classes for different colours.
You can now hide elements when users print a page, using the new govuk-!-display-none-print
class.
Pull request #1723: Add display override for hiding content when printing.
You should no longer use the iff
Sass function. The function is now deprecated, and it will be removed in a future release.
Pull request #1742: Deprecate iff function.
- Pull request #1724: Fix fallback logo being detected by Google Chrome's image description feature.
- Pull request #1745: Update vendor polyfills to match upstream.
- Pull request #1746: Use generic div element for tabspanel.
If you're using Nunjucks, you can now add classes to the character count component's count message using the countMessage.classes
option.
- Pull request #1704: Update the date input component to use
input type=text inputmode=numeric
. - Pull request #1690: Don't unneccesarily self-close tags.
- Pull request #1678: Fix tabs component throwing JavaScript errors in Internet Explorer 8.
- Pull request #1676: Fix skip link component focus style with global styles enabled.
- Pull request #1672: Ensure footer links look clickable.
- Pull request #1670: Make width-container margins more targetted to avoid specificity issues.
- Pull request #1655: Ensure components use public
govuk-media-query
mixin. - Pull request #1648: Update checkboxes and radio buttons to include item hint classes on item hint.
- Pull request #1638: Check component item arrays are not empty before outputting markup.
If you're using Nunjucks, you can now add classes to the page wrapper using the containerClasses
variable.
Pull request #1626: Allow creating custom width containers and using them with template.
If you're using Sass, you can now use the govuk-width-container
mixin to create a custom wrapper class with a specific width. You can then add that class to the following wrappers to override the width of the govuk-width-container
class:
To create your custom wrapper class, include the govuk-width-container
mixin. Pass in the width in pixels.
For example:
.app-width-container--wide {
@include govuk-width-container(1200px);
}
If you’re using Nunjucks, you should then add your class using either the:
containerClasses
variable in the page templatecontainerClasses
option in the header or footer
Use the $govuk-page-width
Sass variable instead if all your pages are the same width.
You can now add attributes to the <body>
element of a page, by using the bodyAttributes
variable in the page template.
- Pull request #1594: Refactor handling of count message in character count JavaScript.
- Pull request #1609: Update hex value for secondary text to improve contrast.
- Pull request #1620: Only add underline to back link when href exists.
- Pull request #1631: Fix classes on character count when in error state.
You can now set the lang attribute in the title and main of page template.
This will help with scenarios where some of the elements, such as navigation and footer, are in English whereas the title and page content are in a different language.
You can now use the .govuk-!-display-none
override class to hide elements.
Align ‘Warning text’ icon with first line of the content fixing #1352 Some changes were made to the size and spacing of the icon to help with positioning.
- Pull request #1574: Make form elements scale correctly when text resized by user.
- Pull request #1584: Fix text resize issue with warning text icon
- Pull request #1570: Prevent inputs ending up off screen or obscured by keyboards when linking from the error summary to inputs within a large fieldset
- Pull request #1585: Explicitly set font weight on warning-text component
- Pull request #1587: Fix height and alignment issue within header in Chrome 76+
- Pull request #1589: Remove role="button" from header button
- Pull request #1595: Do not output conditionally revealed content for radios or checkboxes when it's empty
You can now add classes to the form group wrapper of the character count component.
govukCharacterCount({
formGroup: {
classes: 'app-character-count--custom-modifier'
}
})
- Pull request #1553: Include formGroup on character count and pass through to textarea to allow class to be added to character count form group. Thanks to Emma Lewis.
- Pull request #1548: Fix fieldset legend text clipping when using a custom or fallback font.
- Pull request #1559: Stop IE8 from downloading GDS Transport font.
- Pull request #1564: Ensure legacy styles do not override button active state.
You can now pass attributes to add to the fieldset on the date input component.
Pull request #1541: Allow date input fieldset attributes to be set. Thanks to andrew-mcgregor for raising this.
You can now pass an ARIA role to the fieldset component.
Pull request #1541: Allow date input fieldset attributes to be set.
You can now pass inputmode to the input component.
govukInput({
inputmode: 'email'
})
- Pull request #1523: Improve accessibility of details component by polyfilling only where the native element is not available.
- Pull request #1512: Update components to only output items when they are defined.
- Pull request #1538: Simplify button types to avoid unnecessary type attribute.
- Pull request #1542: Only default two thirds/one-third layout when footer has two sections.
You must make the following changes when you migrate to this release, or your service may break.
To make sure GOV.UK Frontend's files do not conflict with your code, we've moved our package files into a directory called govuk
.
Add govuk/
after govuk-frontend/
to @import
paths in your Sass file.
For example:
@import "node_modules/govuk-frontend/govuk/all";
If you’ve added node_modules/govuk-frontend
as a Sass include path, add govuk/
to your @import
paths:
@import "govuk/all";
You must do the following.
- Update file paths.
- Update and add
data-module
attributes. - Update CSS class names.
You must add govuk/
to your import paths.
If you're importing node_modules/govuk-frontend/all.js
, change this import path to node_modules/govuk-frontend/govuk/all.js
.
If you’re importing a specific path, add govuk/
after govuk-frontend/
. For example, if you're importing the button component:
import Button from 'govuk-frontend/govuk/components/button/button'
You do not need to do anything if you're using Nunjucks macros and the initAll
function.
If you are not using Nunjucks macros, add a govuk-
prefix to data-module
attribute values. For example:
<div class="govuk-accordion" data-module="govuk-accordion">
...
</div>
The button and details components now also use the data-module
attribute for initialisation. If you are not using Nunjucks macros, add:
data-module="govuk-button"
to each<button>
HTML tagdata-module="govuk-details"
to each<details>
HTML tag
If you're using your own JavaScript code to initialise components, add a govuk-
prefix to any selectors that find components using the data-module
attribute.
Pull request #1443: Ensure GOV.UK Frontend component selectors cannot conflict when initialised
You do not need to do anything if you're using Nunjucks.
If you're using HTML or custom JavaScript, change:
js-character-count
togovuk-js-character-count
js-header-toggle
in the GOV.UK Frontend header component togovuk-js-header-toggle
Pull request #1444: Renames js-
css prefix to govuk-js-
- Change the list of paths in
nunjucks.configure
so that the only GOV.UK Frontend path isnode_modules/govuk-frontend/
:
nunjucks.configure([
"node_modules/govuk-frontend/"
])
- If you've extended the page template, add
govuk/
to the template path:
{% extends "govuk/template.njk" %}
- Change the import paths in your components so they include
govuk/components/
. For example:
{% from "govuk/components/breadcrumbs/macro.njk" import govukBreadcrumbs %}
In the assets path, add govuk/
after govuk-frontend/
:
/node_modules/govuk-frontend/govuk/assets
If your code uses Express.js, you must also use the following code in your configuration file:
app.use('/assets', express.static(path.join(__dirname, '/node_modules/govuk-frontend/govuk/assets')))
Pull requests:
The focus state of components now meets the new WCAG 2.1 level AA requirements.
You must update your component’s focus state to make your design consistent with our new focus styles.
If you've extended or created components, you can no longer use the govuk-focusable
or govuk-focusable-fill
Sass mixins.
If you're using govuk-focusable
, you must remove it. There’s no direct replacement, so you must use our Sass variables to make your components consistent with GOV.UK Frontend.
If you're using govuk-focusable-fill
, include the govuk-focused-text
mixin inside your component's :focus
selector. For example:
.app-component:focus {
@include govuk-focused-text;
}
Pull requests:
- #1309: Update links (and things that look like links) to use the new focus style
- #1312: Update form inputs focus to comply with WCAG 2.1
- #1313: Add new focus style to buttons
- #1321: Update footer links to use new focus style
- #1324: Update accordion to use new WCAG 2.1 compliant focus style
- #1326: Update tabs component to WCAG 2.1 compliant focus style
- #1361: Remove
govuk-focusable
,govuk-focusable-fill
mixins, introducegovuk-focus-text
mixin
You can now use the following new colour variables that we've added to the colour palette:
- dark-blue
- dark-grey
- mid-grey
- light-grey
5 Sass colour variables no longer exist. Replace the following colour variables if you're using Sass:
Colour variable removed | Suggested replacement |
---|---|
bright-red | red |
grey-1 | dark-grey |
grey-2 | mid-grey |
grey-3 | light-grey |
grey-4 | light-grey |
You should check the contrast ratio of your colours.
If you're not using Sass, change the values of the following colours:
Colour name | Old value | Replace with |
---|---|---|
purple | #2e358b | #4c2c92 |
red | #b10e1e | #d4351c |
yellow | #ffbf47 | #ffdd00 |
green | #006435 | #00703c |
grey-2 | #bfc1c3 | #b1b4b6 |
grey-3 | #dee0e2 | #f3f2f1 |
grey-4 | #f8f8f8 | #f3f2f1 |
light-blue | #2b8cc4 | #5694ca |
blue | #005ea5 | #1d70b8 |
bright-red | #df3034 | #d4351c |
We've also changed the background of the following components:
- buttons -
green
instead of a custom green - confirmation panels -
green
instead ofturquoise
- links in their hover state -
dark-blue
instead oflight-blue
If you're using legacy projects like GOV.UK Elements, you can keep your current colours by turning on compatibility mode.
Read our blog post about why we changed the colour palette
Pull request #1288: Update colour palette.
The size and baseline of the Design System's font are now more consistent with other fonts. Text now aligns vertically in text boxes without you needing to adjust it.
If you've extended or created components, you should check that your text is still vertically aligned correctly.
If you're using GOV.UK Frontend and GOV.UK Template, you can turn on compatibility mode to keep using the font from GOV.UK Template.
Pull requests:
If you've linked from an error summary component to the first input in a radios or checkboxes component, the link will no longer work.
This is because the id
of the first input no longer has the suffix -1
.
If there are links back to radios or checkboxes components in your error summary component, remove -1
from the end of the href
attribute.
Pull request #1426: Make radios and checkboxes components easier to link to from error summary
You do not need to do anything if you're using Nunjucks macros.
If you are not using Nunjucks macros, remove the govuk-tabs__tab--selected
class from the first tab's link, then add the govuk-tabs__list-item--selected
class to that link's parent list item.
For example:
<li class="govuk-tabs__list-item govuk-tabs__list-item--selected">
<a class="govuk-tabs__tab" href="#tab1">
Tab 1
</a>
</li>
Pull request #1496: Update the focus state for tabs
Start buttons have a new icon. Your start buttons will lose their current icons unless you replace the old icon with the new one.
If you're using Nunjucks:
- set the
isStartButton
option totrue
- remove the
.govuk-button--start
class
For example:
govukButton({
text: "Start now",
href: "#",
isStartButton: true
})
If you're using HTML, add the SVG code from the start button example in the Design System.
Pull request #1341: Add new start button icon
Text now aligns to the top of table cells. If you've used a different alignment in a table, you should use your own CSS styles to keep the alignment the same.
For example, to align text in the centre:
.app-table--vertical-align-middle .govuk-table__header,
.app-table--vertical-align-middle .govuk-table__cell {
vertical-align: middle;
...
}
Pull request #1345: Set 'vertical-align:top' positioning on table headers and cells
If you're using the @govuk-grid-column
Sass mixin to create custom grid classes, you must remove the $class
parameter.
If you're passing a class name, put the mixin inside your selector. For example:
.your-class-name {
@include govuk-grid-column(...)
}
You can no longer use the govuk-grid-row
mixin. You can replace it with the .govuk-grid-row
class in your HTML.
You must also replace calls to the grid-width
mixin with calls to the govuk-grid-width
mixin.
Pull requests:
- #1376: Remove $class param from @govuk-grid-column mixin
- #1342: Remove grid-width mixin
- #1343: Removes govuk-grid-row mixin
If you use Sass and you’ve extended or created components that use the border width variable, rename $govuk-border-width-mobile
to $govuk-border-width-narrow
.
Pull request #1287: Rename border-width-mobile to reflect how it's used
You can now add attributes like classes, rowspan and colspan to table row headers.
Pull request #1367: Allow for classes, rowspan, colspan and attributes on row headers. Thanks to edwardhorsford.
You can now add the .govuk-main-wrapper--auto-spacing
modifier class to your <main>
element to add responsive padding to the top and bottom of the page.
This will add the correct amount of padding depending on if there are elements above the <main>
element inside the govuk-width-container
wrapper. Elements above the <main>
element could include a back link or breadcrumb component.
If you need to control the spacing manually, use the .govuk-main-wrapper--l
modifier instead.
The govuk-main-wrapper
and govuk-main-wrapper--l
Sass mixins are now deprecated. Contact us if you need to continue using these mixins.
Pull request #1493: Add automatic vertical spacing modifier for main wrapper
IE8 will now use Arial instead of GDS Transport.
This is because IE8 requires a very large Embedded Open Type (.eot) font file for external fonts. Arial will take less time to render for IE8 users, who are likely to be on older computers.
Pull request #1434: Update font to use v2 of GOV.UK Transport font. Thanks to @Nooshu.
- Pull request #1310: The border on error summaries is now the correct width on mobile. GOV.UK Template's focused link colour no longer overrides GOV.UK Frontend.
- Pull request #1316: Checkboxes and radios no longer have a transparent outline - because it's no longer needed to fix custom focus state colours.
- Pull request #1324: There’s no longer an outline when a user focuses an accordion element in Firefox.
- Pull request #1330: We've changed the spacing around lists in tabs on mobile and with JavasScript disabled, so they're consistent with other lists.
- Pull request #1351: You can now use HTML elements in the labels for tabs.
- Pull request #1353: Example HTML code in the Design System now has correct indenting.
- Pull request #1368: We’ve clarified how you should use
productName
andserviceName
in the header component - thanks to @edwardhorsford. - Pull request #1359: Users can now use the Tab key to highlight tabs in IE8.
- Pull request #1370: Each submit button on a page now has its own double-click timer, so clicking one button will not disable the other buttons.
- Pull request #1381: You can now import the Sass settings files without needing to import the other settings first.
- Pull request #1442: Character count components are now hidden to assistive technologies when they're not visible.
- Pull request #1434: The underline below links no longer sits too far down in Firefox.
- Pull request #1435: When a user resubmits a form, the error summary is now correctly focused instead of the form.
- Pull request #1473: We’ve removed icon-arrow-left.png and icon-important.png, because they were not used in GOV.UK Frontend
- Pull request #1497: Users can now conditionally reveal content on pages with multiple grouped radios - thanks to @colinrotherham and @frankieroberto for their help.
🆕 New features
-
You can now override the visually hidden 'Support links' text in the footer by setting
meta.visuallyHiddenTitle
.
🔧 Fixes
-
Secondary buttons and warning buttons now have the correct background colour when they're disabled.
-
The crown logo image in the header now:
- has height and width attributes set
- aligns better with 'GOV.UK' in IE8
🆕 New features:
-
Support custom attributes on summary list action links
You can now use the
attributes
macro option to add additional HTML attributes to summary list action links.(PR #1372)
-
Support aria-describedby on all form fields
All form fields now support an initial
aria-describedby
value, populated before the optional hint and error message IDs are appended.Useful when fields are described by errors or hints on parent fieldsets.
(PR #1347)
🔧 Fixes:
-
Update colour for MHCLG
Fixes the brand colour for MHCLG to their correct corporate "green" brand.
(PR #1319)
-
Remove deprecated
@else-if
statement, replace with@else if
(PR #1333)
-
Prevent the fallback PNG image for the crown in the header from being downloaded unnecessarily in Internet Explorer and Edge.
(PR #1337)
🆕 New features:
-
Add new secondary and warning button variants
(PR #1207)
-
Add new govuk-shade and govuk-tint functions for creating shades and tints of colours.
(PR #1207)
-
Add support for custom row classes on the summary list component (including support for some rows without action links)
(PR #1259)
-
Ensure fieldset never exceeds max-width
This fix ensures that both WebKit/Blink and Firefox are prevented from expanding their fieldset widths to the content's minimum size.
This was preventing
max-width: 100%
from being applied to select menus inside a fieldset.See discussion in "Reset your fieldset" and raised by issue #1264
(PR #1269)
🔧 Fixes:
-
Add various fixes to the summary list component:
-
Fixes the 1px row height change when borders are removed Padding is now adjusted by 1px instead
-
Fixes the text alignment when the actions column isn't added So the key column always stays at 30% width
(PR #1259)
-
🆕 New features:
-
Add smaller versions of radio buttons and checkboxes
Thanks to @owenm6 for their help and support on this one.
(PR #1125)
🔧 Fixes:
-
Prevent duplicate checkbox aria-describedby
Addresses an edge case where a checkbox with a hint (but without a fieldset) is output with duplicate
aria-describeby
attributes. Fixes issue #1248.Thanks to @colinrotherham for fixing this issue.
(PR #1265)
🆕 New features:
-
Add classes to action items in the summary list component
(PR #1233)
-
Allow initAll to be scoped to a specific part of a page
See "Initialise GOV.UK Frontend in only certain sections of a page" for more information.
(PR #1216)
🔧 Fixes:
-
Fix tabs bullet point character encoding issue when not enhanced
Thanks Ed Horsford and Steve Sims for their help on this one.
(PR #1247)
-
Update padding of govuk-main-wrapper
This increases the padding of
govuk-main-wrapper
(on tablet and above) to be more inline with GOV.UK. When updating, your pages will have 10px more white space above and below the 'main' content area.(PR #1073)
-
Remove error-summary dependence on document.onload
(PR #1215)
-
Ensure font is not loaded twice on slow networks
This is only an issue for users that are using alphagov/govuk_template alongside GOV.UK Frontend.
(PR #1242)
We have been made aware that the change to force scroll bars to appear at all times can change the behaviour of some components such as modals.
If you're using your own components that rely on the overflow state of the document (such as modals) you should make sure you test those components when updating to this version.
🆕 New features:
-
Enable
pattern
attribute for inputYou can now set the
pattern
attribute on input fields using the component macros:{{ govukInput({ name: "example", pattern: "[0-9]*" }) }}
As well as
pattern
, custom attributes can also be added on day/month/year inputs (e.g.data-example
) shown below:{{ govukDateInput({ items: [ { pattern: "[0-9]*", attributes: { "data-example": "value" } } ] }) }}
(PR #1172)
-
Prevent horizontal jump as scrollbars appear
As content vertical height grows (e.g. autocomplete results appear), browsers may add scroll bars causing the page to jump horizontally in position.
To avoid this, re-introduce fix from GOV.UK Template: #1204
(PR #1230)
-
Accommodate camera notches on new devices (iPhone X, Google Pixel 3 etc)
On newer devices with "camera notches", browsers reserve a safe area in landscape orientation (known as pillarboxing) so content isn't obscured.
To avoid this, support has been added for
viewport-fit=cover
as shown here: https://webkit.org/blog/7929/designing-websites-for-iphone-x/(PR #1176)
-
Prefix error messages with a visually hidden "Error:", to make it clearer to users of assistive technologies
(PR #1221)
-
Prevent accidental multiple submissions of forms
If a user double clicks a submit button in a form, we debounce this event and ignore the second click.
HTML data attribute:
<button class="govuk-button" data-prevent-double-click="true"> Submit </button>
Nunjucks macro:
{{ govukButton({ text: "Submit", preventDoubleClick: true }) }}
(PR #1018)
🔧 Fixes:
-
Ensure that files within the core, objects and overrides layers can be imported individually
Unlike components, the files within these layers did not previously import their dependencies (for example, most of them require the govuk-exports mixin but did not import it).
We've also added tests to ensure that files within these layers can be imported and rendered to CSS without erroring, which should catch this in the future.
Thanks to Alasdair McLeay for originally raising a PR to fix this.
(PR #1235)
-
Ensure inset component does not misalign nested components
Thanks to Paul Hayes for raising this issue.
(PR #1232)
-
Improve word wrapping in summary list component
Thanks to Edward Horsford and Lee Kowalkowski for their help on this one.
Also thanks to Malcolm Butler for exploring a previous version of this fix.
(PR #1220)
🆕 New features:
-
Added config file for prototype kit.
Added a configuration file for an experimental feature in Prototype kit to allow departments to use their own frontend alongside govuk-frontend
Thanks @matcarey (HMRC) for this contribution
(PR #1102)
-
Disable incorrect iOS/Edge text size adjustments
To cater for non-responsive websites, iOS and Edge automatically increase font sizes (iOS in landscape, Edge in portrait on HiDPI displays).
Since we have already considered typography at these device sizes, this feature is now turned off.
(PR #1178)
🔧 Fixes:
-
Fix wrapping of long lines of text in summary list
Thanks to @MoJ-Longbeard for raising the issue.
(PR #1169)
🆕 New features:
-
Enable
autocomplete
attributes for input components.You can now set the
autocomplete
attribute on input, date input and textarea components using the component macros.This was already possible to do with the
attributes
option but this change highlights the new WCAG 2.1 success criteria Identify Input Purpose which "is to ensure that the purpose of a form input collecting information about the user can be programmatically determined, so that user agents can extract and present this purpose to users using different modalities".See autofill for the full list of attributes that can be used.
(PR #1146)
🔧 Fixes:
-
Include Accordion component in global namespace
Accordion component was not exported and was therefore unavailable in global namespace
(PR #1157)
-
Fix Checkboxes and Radios targeting selectors outside it's scope
Thanks to @andysellick and @bilbof for helping us with this issue.
(PR #1156)
-
Fixes styling of the accordion component when there is no JavaScript or it has been turned off
Thanks @dankmitchell for reporting this issue (#1130)
(PR #1149)
-
Remove hover state for accordion sections on mobile
(PR #1148)
-
Fix container not being centered in IE8
Since the header and the footer component use this container it also fixes centering for these components.
(PR #1147)
-
Make gutters in the header consistent with the grid
This means that the header will now line up with the grid.
Thanks to @edwardhorsford for raising this issue.
(PR #1144)
🔧 Fixes:
-
Update summary list to simplify actions
Only output actions in a list when there's multiple actions.
(PR #1131)
🆕 New features:
-
Accordion component 🎉
Contributed by @frankieroberto, as well as @injms, @hannalaakso, @joelanman and others.
The accordion component lets users show and hide sections of related content on a page.
For more information see guidance.
(PR #958)
-
Add desktop specific grid column widths
This allow you to define different grid behaviour for the tablet and desktop breakpoints. For example, you can make a column two-thirds on desktop but expand to full-width on smaller tablet sized screens.
(PR #1094)
-
Add summary list component
This component was initially developed to allow us to build the 'check your answers' pattern.
It is mostly the same as in the original pattern with some notable differences:
- On smaller screens it wraps by default
- It's possible to have multiple actions
(PR #1065)
🔧 Fixes:
-
Update visually hidden class to fix ordering issue in VoiceOver OSX
We have fixed an issue in VoiceOver OSX where using the
govuk-visually-hidden
class in links would result in the text being announced out of order.We also now recommend to use aria-label or aria-labelledby where appropriate.
Thanks to @stevenaproctor and the accessibility team at HMRC for letting us know about this issue.
(PR #1109)
-
Improve rendering in older Internet Explorer
Added a meta tag to ensure that older IE versions always render with the correct rendering engine
(PR #1119)
🔧 Fixes:
-
Remove unused hint, error message and label imports from the Character Count component
(PR #1087)
-
Warning text component, remove negative margin left and reduce padding left to match.
(PR #1084)
-
Add 5px bottom margin to list items within lists that do not have bullets or numbers on mobile breakpoints to make each item visually distinct.
(PR #1078)
-
Add error message attributes to all components
(PR #1086)
🆕 New features:
-
Scroll to label or legend when linked from error summary
When users click links in the error summary, the corresponding label or legend will now be moved to the top of the viewport, rather than the input. This means that the context for the input remains on-screen.
(PR #1056)
-
Label or legend are announced for NVDA users when navigating to an input from the error summary
(PR #1056)
-
Allow form group classes on date, file upload, input, select and textarea
All remaining form groups should allow additional classes, like with radios and checkboxes
(PR #1059)
🔧 Fixes:
-
Remove implicit dependency on Element for classList
(PR #1063)
-
Single field with error should have 'aria-describeby' attribute
Although we discourage using checkboxes without fieldsets, this fix ensures that if there are no fieldset then the aria-describeby will still be usable by screenreaders by adding the element ids to the checkbox input elements 'aria-describeby' attribute.
(PR #1054)
🆕 New features:
-
Add important parameter to visually hidden sass mixins
Optional parameter added to
govuk-visually-hidden
andgovuk-visually-hidden-focusable
mixins (defaults to true)(PR #1037)
-
Add support for attributes on table cells
Can now use the familiar
attrubutes: {}
pattern to add various attributes such asid
ordata-attr
to cells within tables(PR #1045)
-
Allow form group classes on radios and checkboxes
We now provide a way to add classes to the radio and checkbox form-group wrapper
(PR #1043)
🔧 Fixes:
-
Fix anchor links in tabs component panels
(PR #1031)
-
Fix IE8 support in builds in the
dist/
folder(PR #1035)
🆕 New features:
-
Allow classes on table header and row cells
Optional classes attribute can now be used on table header and row cell item in the Nunjucks macro
(PR #1015)
-
Add character count component
(PR #959)
🔧 Fixes:
-
Apply max-width to the
<select>
elementThe
<select>
element's width is governed by the widths of its<option>
's.When the text in the options grows large, the element can grow to > 100% of the width of its container and break the layout.
(PR #1013)
-
Prevent product name in header from wrapping
Currently the product name in the header wraps when the space shrinks which doesn't look great.
Adding
display: inline-table
prevents that so that the product name as a whole drops to a new line when space is shrunk.(PR #1007)
-
Set text colour for radios divider
(PR 1023)
-
Stop links styled as button from being dragged
Moving the mouse over a link while its button is depressed causes the browser’s dragging behaviour to trigger (and prevents the
click
event from firing). This is contrary to how actual<button>
elements work. This pull request makes the behaviour of links styled as buttons consistent with that of buttons.(PR #1020)
🆕 New features:
-
Allow additional 'meta' content in the footer
You can now pass additional 'meta' content (as
meta.html
ormeta.text
) which will appear below any meta links, above the OGL license. This is ideal for, for example, the 'Built by Department Name' colophon.(PR #990)
-
Allow attributes to be added to some child items in header, footer, breadcrumbs, tabs and error-summary components
You can now pass additional attributes to links in header, footer, breadcrumbs, tabs and error-summary components
(PR #993)
-
Fix issue with conditional form content and inline form controls
When inline variant of form controls is used with conditional content, we force it to display block. This is to avoid breaking and confusing styling as it is a combination we don't recommend.
(PR #970)
-
Add component options (arguments) as
macro-options.json
topackage
We want to be able to expose these options to GOV.UK Design System. This change includes them as
yaml
insrc/components
and adds a build step to transform them toJSON
and copy them topackage/components
. It also adds a test to check if the copied files are valid JSON and contain expected attributes.(PR #998)
🔧 Fixes:
-
Fix mobile menu button submitting parent forms
The menu
<button>
didn’t have an explicittype
set, which meant that it defaulted totype=“submit”
.This meant that if the header was inside a form (as it is in the Design System examples, but we can imagine other scenarios where this would be the case) clicking the menu button would submit the form.
In most cases this would also cause the page to reload, which closes the menu.
(PR #994)
-
Fix flash of unstyled content in tabs component
(PR #1000)
-
Add 48px favicon
Microsoft recommends including at least a 48x48px favicon.
(PR #986)
-
Update
browsersList
inpackage.json
to reflect our supported browsersbrowsersList
is used by PostCSS in our current build to determine which browser prefixes or rules to generate for the built CSS files. This PR adds rules to specify that the browsers in our browser matrix should always be prefixed for. Additionally, any browser with more than 0.1% of the global market share is prefixed for.In terms of changes to our built CSS, this means that
-webkit-box-sizing
and-webkit-box-shadow
prefixes will be removed - neither of these prefixes are required by desktop Safari 5.1 or later so this seems a fairly safe change to make.(PR #1002)
💥 Breaking changes:
-
Set panel component's title heading level to 1 as default
We think the panel title should be the h1 in the majority of cases, so we made it the default.
If you have need to change the Panel component heading to something other than h1, you can do so by specifying
headingLevel: <number>
in the Nunjucks macro.(PR #967)
-
Remove deprecated
govuk-visually-hidden-focussable
class nameIn 1.1 release we added a new, correctly spelt
govuk-visually-hidden-focusable
CSS class and marked the old one as deprecated.To migrate you need to change
govuk-visually-hidden-focussable
togovuk-visually-hidden-focusable
in your codebase.(PR #968)
-
Remove name-based width logic from date-input component
In 1.1 release we removed styling which made the year field 4 characters wide, but was coupled to the field's name.
However, to avoid making this a breaking release, we added logic to automatically add the width classes based on the name.
We are now removing this behaviour. Instead, users need pass explicit classes for each field in the
items
object for the desired width of the input field.If you are not passing items at all, you will get the default items which include these classes.
If you are using the Nunjucks macro, you need to provide a width class for each item, for example:
{{ govukDateInput({ "id": "dob", "name": "dob", "fieldset": { "legend": { "text": "What is your date of birth?" } }, "items": [ { "name": "day", "classes": "govuk-input--width-2" }, { "name": "month", "classes": "govuk-input--width-2" }, { "name": "year", "classes": "govuk-input--width-4" } ] }) }}
If you are using plain HTML, you need to manually add a width-based class, such as
govuk-input--width-2
orgovuk-input--width-4
to the input fields.(PR #969)
-
Rename
name
argument of date-input component tonamePrefix
.This is better reflective of the purpose of the argument, which is to prefix the
name
attribute ofitems
. This is consistent with other components which use the nameidPrefix
to explain similar functionality.If your project currently uses this optional argument with the date-input macro, you need to rename all instances of it to
namePrefix
(NB: this argument shouldn't be confused with theitems.{}.name
attribute which hasn't changed.)(PR #984)
-
Turn off compatibility mode by default for GOV.UK Elements, GOV.UK Template, GOV.UK Frontend Toolkit
You do not need to make any changes if you do not use these projects alongside GOV.UK Frontend.
To migrate include the SCSS variables that correspond with the projects you depend on before importing GOV.UK Frontend styles into your app:
// application.scss $govuk-compatibility-govukfrontendtoolkit: true; $govuk-compatibility-govuktemplate: true; $govuk-compatibility-govukelements: true; @import "govuk-frontend/all";
(PR #981)
-
Turn on relative typography (rem) by default
This allows for end-users to adjust GOV.UK Frontend components by setting their font size in their browser.
If you are using GOV.UK Frontend on with no other frameworks this should not break your project.
If you need to change this setting for compatibility with GOV.UK Elements, GOV.UK Template, GOV.UK Frontend Toolkit consider enabling compatibility mode.
Otherwise, set
$govuk-typography-use-rem
tofalse
before importing GOV.UK Frontend styles into your app:// application.scss $govuk-typography-use-rem: false; @import "govuk-frontend/all";
(PR #981)
-
Remove anchor styling in govuk-lists
This was an undocumented feature of lists.
To migrate we recommend using adding
.govuk-link
class to any anchors within a govuk-list.If you would like to replicate this functionality without adding a class you can also enable global styles (Note: global styles are enabled by default in the GOV.UK Prototype Kit)
(PR #985)
-
Remove the width declaration from the
<select>
componentThe
<select>
component’s width will now be defined by it’s content. This addresses some accessibility issues with the select being 100% wide by default. If you want to style your select to be 100% wide we have added a new override class.govuk-!-width-full
to allow this.(PR #960)
-
Use text colour on focus for better contrast
Updates the focus styles of links in GOV.UK Frontend so they pass WCAG contrast requirements.
(PR #982)
🆕 New features:
-
Add a new width override class
.govuk-!-width-full
You can now override elements that have an undefined or smaller percentage width to be 100% width of their container.
(PR #960)
-
Allow attributes on select items
You can now provide attributes on select items
attributes: { 'data-attribute': 'value' }
(PR #977)
🔧 Fixes:
-
Textareas can now only be resized vertically, to prevent them being resized outside of their container bounds. Additionally, they now have a minimum height to prevent them being resized smaller than a text input.
(PR #976)
-
Defend tables against GOV.UK Elements code (PR #983)
🆕 New features:
-
Allow attributes on checkboxes/radios
You can now provide attributes on checkbox and radio items
attributes: { 'data-attribute': 'value' }
(PR #942)
🔧 Fixes:
-
Fix incorrect panel title bottom margin with optional text
Margin is only added when panel text is provided
(PR #936)
-
Remove template whitespace
Remove leading whitespace before the doctype in the page template. Some older browser will be forced into 'quirks mode' if there is whitespace before the doctype.
(PR #949)
-
Remove additional dotted outline from focussed buttons in Firefox
This was already the intended behaviour, but a minor typo (: rather than ::) meant that it wasn't being applied.
(PR #951)
-
Update date input component to use
display: inline-block
(PR #938) -
Change spacing relationship on default and small legends and hints (PR #940)
-
Adjust tag component padding to compensate for font spacing (PR #955)
🆕 New features:
-
Allow for optional divider between radio items
You can now provide a divider item (e.g "or") to separate items (PR #849)
-
Allow og:image meta tag url to be set independantly Image url for the opengraph image needs to be absolute and can now be overwritten by setting the
assetUrl
variable. (PR #847) -
Only underline the logo in the header on underline when users have overridden colours in their browser, rather than it appearing underlined all the time (PR #926)
-
Allow for optional hint for each radio and checkbox item
You can now pass a hint object (or add in html) to each radio and checkbox item to display the hint (PR #846)
-
Allow additional classes to be added to the radio and checkbox items
You can now provide
label: { classes: 'extra-class' }
to each item.(PR #880)
🔧 Fixes:
-
Replace conflicting
js-hidden
class used within the tabs component with a new modifier class. Because this class is defined and used within the JavaScript, no markup changes are required. (PR #916) -
Use
get-function
when calling a Sass function as passing a string to `call()`` is deprecated and will be illegal in Sass 4.0 (PR #919) -
Fix flash of unstyled content with conditional reveals (Radios and Checkboxes)
If the conditional reveal JavaScript is slow to execute it can result in showing the user their contents briefly which can be jarring.
(PR #885)
🔧 Fixes:
-
Update details behaviour to remove margin-bottom for all elements (PR #900)
-
Update internal padding of tab content in the tabs component (PR #886)
-
Fixes an issue where clicking the revealed content in browsers that do not support the native details element causes the details element to collapse. (PR #912)
-
Fixes an issue where clicking the revealed content within a details element toggles the aria-expanded attribute on the summary element and the aria-hidden attribute on the content element, causing them to get out of sync with the visible state of the component. (PR #912)
-
Fixes an issue where it's not possible to make any field that does not have the name ‘year’ use any other width than 2 characters (PR #908)
-
Fix undefined class displaying in date input (PR #913)
🆕 New features:
-
Add
govuk-visually-hidden-focusable
classAdds
.govuk-visually-hidden-focusable
and deprecates.govuk-visually-hidden-focussable
in order to fix the typo in the class name. Please consider updating your code as the next major release will remove the deprecated class.(PR #859)
-
Allow panel component title heading to be customisable.
You can now specify a heading level by providing
headingLevel: <number>
parameter. Default is2
. (PR #853) -
Update date input component
Allow the
name
andid
attributes to be passed individually for each input item.Rely on
classes
instead of item names to set the width of input items.Add default (day, month, year) date input items if no items are being specified
(PR #857)
-
The typography scale can now be converted from pixels to rem automatically, with pixels also being provided as a fallback for older browsers.
This feature is disabled by default - in order to use it you will need to set
$govuk-typography-use-rem: true
and ensure that$govuk-root-font-size
is set to the effective size of your root (html) element. For new projects, this should be the default of 16px so you don't have to do anything. For projects that use alphagov/govuk_template this should be 10px.The intention is to enable this by default in the next major version: #868
(PR #858)
🔧 Fixes:
-
Remove mistakenly applied 5px bottom margin from radio and checkbox labels. (PR #883)
-
Apply
display:block
to.govuk-main-wrapper
In IE11
main
element is set todisplay:inline
so padding and margins aren't applied. (PR #863)) -
Line-heights are now converted from pixels to relative 'unit-less' values in order to prevent issues when resizing text in the browser. (PR #837 and PR #848)
-
Add bottom margin to Tabs component All components (or outer layer components) have a bottom margin applied to them so spacing feels automatic. (PR #841)
-
Update Crown copyright link Update the Crown copyright link on the National Archives so we don't send users on an unnecessary redirect. (PR #824)
-
Fixes radio and checkbox labels extending full width of page (PR #821)
-
Prevent the exclamation mark in the warning text component from being selectable, which also excludes it when it is copied as part of a wider body of text (PR #856)
-
Add customised colours handling for warning text
By adding a border to this component, when a user customises their colour settings they will still see a circle even if the background is removed. (PR #852)
-
Fixes a bug where the phase banner incorrectly uses a font-size of 19px when global styles are enabled (PR #877)
-
Add outlines to Radios and Checkboxes for customised colour users
Now when a user customises their colours, they should see a focus state on both Radios and Checkboxes. (PR #854)
-
Add outline to tag for customised colour users
Now when a user customises their colours, the tag component still keeps it's meaning. (PR #855)
-
Define size of table in
px
rather thanem
This brings the styling of tables inline with rest of GOV.UK Frontend which no longer uses
em
for measurements.This change very slightly increases the padding of table cells on mobile viewport as the use of
em
meant the font size set in the table was used to calculate padding.padding-top
andpadding-bottom
of cells increase by 1.5px respectively which very slightly increases the height of the table on mobile.In the unlikely case that your UI has a dependency on tables being a certain fixed height of mobile viewport, this change might affect you.
(PR #845)
-
Fix header component's reliance on markup whitespace
We have had issues where the header component can render incorrectly if the markup contains whitespace, for example if it has been pretty printed.
This changes the header component to use float based columns similar to how the grid system works.
(PR #884)
🏠 Internal:
-
Fix Design System url in package READMEs and review app (PR #812)
-
Update back-link example to show default usage doesn't need
text
parameter (PR #819) -
Lowercase component names (PR #822)
-
Tidy up some package.json fields to help contributors and users (PR #827)
-
Fix failing Heroku app with Node 10.5.0 Revert to pinning node version in package json (PR #833)
-
Format YAML and Nunjucks consistently (PR #830)
🆕 New features:
-
Add default text for back-link component (PR #793)
-
Add default container class to the header component (PR #807)
-
Add tabs component – thanks to @adamsilver and @trevorsaint for contributing (PR #776)
🔧 Fixes:
- Reduce margin-bottom on the hint when following a default or small labe
This reduces the margin-bottom of the hint by 5px after a default
<label>
or<label class="govuk-label--s">
. (PR #806)
🏠 Internal:
-
Remove instructions to login with npm, which is no longer required (PR #795)
-
Update docs with the assistive technology we support (PR #800)
-
Update docs about installing fonts (PR #802)
-
Update browser support matrix Remove Windows Phone Update IE 8-10 to functional and IE 11 to compliant (PR #803
-
Add notice about the use of
html
arguments in Nunjucks macros for production (PR #785) -
Add CHANGELOG_TEMPLATE to make changelogs easier for new contributors (PR #798)
-
Update package
README
(PR #804) -
Update JavaScript installation instructions (PR #808)
This release changes the name of package. It's now published as govuk-frontend
on npm
.
💥 Breaking changes:
-
The default build of the GOV.UK Frontend JavaScript now does not initialize all components automatically.
This allows you to initialize only the components you need, and gives you finer control over when the JavaScript for GOV.UK Frontend runs.
To migrate your project you need to change
<script src="{path-to-govuk-frontend}/all.js"></script>
to
<script src="{path-to-govuk-frontend}/all.js"></script> <script>window.GOVUKFrontend.initAll()</script>
Now, if you only want to initialize a specific component you can now do so by:
<script src="{path-to-govuk-frontend}/all.js"></script> <script> var Button = window.GOVUKFrontend.Button new Button(document).init() </script>
Note: If you are importing JavaScript with a bundler, this is not likely to change anything for you. (PR #759)
-
Consistently structure the Details and Button component, so that they can be instantiated the same as the other components.
If you're using
GOVUKFrontend.initAll()
you do not need to make any changes, otherwise you need to change<script> new Button().init() new Details().init() </script>
to
<script> new Button(document).init() var $details = document.querySelectorAll('details') nodeListForEach($details, function ($detail) { new Details($detail).init() }) </script>
(PR #761)
-
All sass-mq settings have now been made private. We are now exposing new settings to allow you to customise breakpoints and responsive behaviour:
$govuk-breakpoints
- Map of breakpoint definitions$govuk-show-breakpoints
- Whether to show the current breakpoint in the top right corner$govuk-ie8-breakpoint
- Breakpoint to rasterize to for IE8
If you are overriding any settings prefixed with
$mq-
in your application you will need to update to the use the new$govuk-
prefixed settings.(PR #748)
-
Font settings have been renamed:
$govuk-font-stack
has been renamed to$govuk-font-family
$govuk-font-stack-tabular
has been renamed to$govuk-font-family-tabular
$govuk-font-stack-print
has been renamed to$govuk-font-family-print
(PR #748)
-
Spacing has been refactored. You will need to update Sass that currently uses GOV.UK Frontend spacing:
- Instead of
$govuk-spacing-scale-*
use
govuk-spacing(*)
where
*
is the number on the spacing scale. The scale itself has remained the same so that$govuk-spacing-scale-3
corresponds togovuk-spacing(3)
. This change allows us to control the error messaging when incorrect values are used and to deprecate variables. The values of spacing variables can also be overridden by consumers.- Instead of:
@include govuk-responsive-margin($govuk-spacing-responsive-2, "bottom"); @include govuk-responsive-padding($govuk-spacing-responsive-2, "bottom");
use
@include govuk-responsive-margin(2, "bottom"); @include govuk-responsive-padding(2, "bottom");
This change, again, allows us to control the error messaging since spacing variables are not exposed directly. Also, the spacing scale itself has not changed so that
$govuk-spacing-responsive-2
corresponds to2
when passed to the padding and margin mixins.This PR also updates tests and sass-docs of spacing variables and helpers.
Additionally, this PR hardcodes the value of
$govuk-gutter
, see PR for more details.(PR #779)
-
Remove
pageStart
block from template, as could result in rendering issues in older IE. (PR #765) -
You should no longer call the
mq
mixin directly - you should replace any calls to it from your own code withgovuk-media-query
which accepts the same arguments. All mixins and settings that start withmq-
should be considered private – they could be removed in the future without notice. (PR #763) -
All of the shorthand 'font' mixins (e.g.
govuk-font-bold-80
,govuk-font-regular-tabular-19
), have been removed and replaced with calls to a new mixingovuk-font
. If you are using these mixins in your application you will need to update your code to callgovuk-font
instead.(PR #772)
-
The font maps are no longer as individual variables (e.g.
$govuk-font-80
) - they are all now part of one single$govuk-typography-scale
map. Instead of passing font maps togovuk-typography-responsive
you should now pass the desktop font size (e.g.govuk-typography-responsive(80)
orgovuk-typography-responsive($size: 80)
.(PR #772)
-
All organisation variables (e.g.
$govuk-cabinet-office
) have been moved into a single$govuk-colours-organisations
map. If you need to use an organisation colour in your own code, you should use the newgovuk-organisation-colour
function:.element { color: govuk-organisation-colour(cabinet-office); }
Note that this function will return 'web-safe' colours by default. You can pass $websafe: false to get the non-websafe colour.
-
The colour palette variables (e.g.
$govuk-green
) have been moved into a new single$govuk-colours
map. If you need to reference a colour within your application you should use the newgovuk-colour
function:.element { color: govuk-colour("green"); }
Tints (
$govuk-green-50
,$govuk-green-25
) have been removed from the colour palette. -
A number of the colours have been renamed to use more neutral names:
mauve
→light-purple
fuchsia
→bright-purple
baby-pink
→light-pink
mellow-red
→bright-red
grass-green
→light-green
-
The 'circle shape' object (
.govuk-circle
) which was used by the warning text component's '!' icon has been removed and thegovuk-warning-text__icon
class has been updated to make it circular without the need for another class.(PR #782)
-
Removal of
govuk-prose-scope
We don't have confidence that the prose scope is well understood – without further research / better documentation it's safer to remove it for now.If you are currently using prose-scope, you should revert to applying classes to individual headings, lists and hr elements. In version 0.0.29-alpha release we have added the option to enable global link and paragraph styles.
If you're using a recent version of the Private Beta Prototype kit, this is enabled by default.
(PR #778)
-
Make override classes consistently verbose Based on feedback from the community we have made the override classes consistent where previously some where verbose and some where shorthand.
We've made the decision to remove the 'r' for responsive, this was hard to remember and users found this confusing.
To migrate you will need to replace any instances of:
.govuk-!-f-{size}
with.govuk-!-font-size-{size}
.govuk-!-w-{weight}
with.govuk-!-font-weight-{weight}
.govuk-!-m{direction}-r{scale}
with.govuk-!-margin-{direction}-{scale}
.govuk-!-p{direction}-r{scale}
with.govuk-!-padding-{direction}-{scale}
For example if you were using:
.govuk-!-mb-r5
you would need to change this to.govuk-!-margin-bottom-5
.govuk-!-f-24
you would need to change this to.govuk-!-font-size-24
See the original Pull Request for the full list of classes before and after.
(PR #786)
🔧 Fixes:
-
Fix govuk-equilateral-height function usage in shape-arrow helper (PR ##766)
-
The
<label>
element will now be omitted for form controls where no label text or html is provided. If you call the label component directly whilst passing neither text nor html, no HTML will be outputted. (PR #740) -
Add
govuk-main-wrapper
to<main>
element by default. (PR #742) -
Use relative imports whenever a component imports another component, to allow for cases where users don't want to add the components folder itself to their nunjucks paths. (PR #743)
-
Update JavaScript global namespace from 'all' to 'GOVUKFrontend', we intend to allow users to initialize components from this namespace. (PR #747)
-
Tabular numbers will now correctly use the
$govuk-font-family-tabular
setting rather than being hardcoded to use NTA tabular. (PR #748) -
Prevents focus from being lost to the inline SVGs in the header (the crown) and footer (the OGL logo) by marking them as non-focusable elements (PR #774)
-
Use the correct class name in bold label example (govuk-label--s rather than govuk-label--bold) (PR #784)
-
Update table of arguments for each component to ensure they're accurate. (PR #769)
-
Add explicit dependency on colour maps (PR #790)
🆕 New features:
- Components are now available to use from the
GOVUKFrontend
global. You can now initialize individual components like so:
<script>
var Radios = window.GOVUKFrontend.Radios
new Radios(document).init()
</script>
(PR #759)
-
Add
beforeContent
block to the template, for content that does not belong inside<main>
element. For example: Back links. (PR #742) -
Most of the settings, helpers and tools layers is now documented using Sassdoc, with variables, functions and mixins being marked as private or public. (PR #748) (PR #762)
-
Most of the settings can now be overridden in your application (they are now marked as !default) (PR #748)
🏠 Internal:
-
Fix review application templates to give them the correct HTML structure. (PR #742)
-
Improve release steps (PR #745)
-
Reintroduce mistakenly deleted HTML5Shiv required for IE8 (PR #749)
-
Fix issues with canvas colour bleeding into main review page (PR #741)
-
Add header with service name and navigation variant to header README (PR #781)
💥 Breaking changes:
-
The
govuk-file-url
helper has been renamed to togovuk-image-url
. If you are using this function in your own styles you will need to update calls to it. (PR #726) -
The
$govuk-global-images
variable has been renamed to to$govuk-images-path
. If you are overriding this variable or using it in your own styles you will need to update your code to use the new variable name. (PR #726)
🔧 Fixes:
-
Namespacing SCSS exports with 'govuk' prefix to avoid clashes with exports in applications consuming GOV.UK Frontend (PR #732)
-
Fixes a bug whereby print styles were being 'rasterized' into the screen styles when generating the IE8 stylesheet (this is a bug in sass-mq, and has also been raised upstream – sass-mq/sass-mq#111). (PR #726)
-
Removed some duplicated CSS rules from the outputted CSS (PR #727)
-
Fixes a bug in IE8 where the button component did not have a shadow, by rendering the shadow using a border for IE8 specifically – IE8 does not support box-shadow (PR #737)
🆕 New features:
-
Change font delivery method from Base64 encoded strings to serving WOFF2, WOFF and EOT files as separate HTTP requests. You will need to ensure that you are serving the fonts from the assets folder as part of your application. (PR #726)
-
The font-face is now using
font-display: fallback
. This means that the fallback font (Arial) will be used if NTA doesn't download within 100ms. The browser will then swap to NTA as long as it loads within the short swap period. (PR #726) -
You can now override the helpers used to generate image and font urls, for example if you are using sass-rails' asset-pipeline functionality. You can do this by setting
$govuk-image-url-function
and$govuk-font-url-function
to the name of the function(s) you wish to use. Seesrc/settings/_assets.scss
for more information and examples. (PR #733) -
Add boilerplate template, which is a Nunjucks replacement for GOV.UK Template. (PR #731)
🏠 Internal:
-
Improve release steps, based on doing a release (PR #725)
-
Fix majority of vulnerabilities flagged by
npm audit
(PR #712)
🔧 Fixes:
-
Update component readme files content (PR #704)
-
Fix panel body element rendering with no text (PR #707)
🆕 New features:
-
Add override classes to set
display
property toblock
,inline
andinline-block
(PR #694) -
Add option to set CSS display property for govuk-shape-arrow mixin (PR #701)
-
Add header component (PR #695)
-
Add inset text component (PR #709)
-
Add ability to pass explicit name value to checkbox items (PR #719)
🏠 Internal:
-
Run tests in pre-release (PR #706)
-
Fix CI timeouts: run Jest single thread in TravisCI (PR #712)
-
Ensure 'after' tests are not ignored (PR #720)
💥 Breaking changes:
-
Restructure project to enable it to be published as a single package
The new project structure matches our ITCSS inspired layers and is published as a single package as
@govuk-frontend/frontend
.You will need to:
- Update your npm dependencies to use
@govuk-frontend/frontend
- Update your SCSS import paths to match the new package name and folder structure.
If you're importing everything at once:
@import "node_modules/@govuk-frontend/frontend/all";
If you're importing individual components:
@import "node_modules/@govuk-frontend/frontend/components/button/button";
See the main README for up-to-date installation instructions.
(PR #680)
- Update your npm dependencies to use
-
Error Messages and Hints have been moved out Label and Fieldset components.
They are no longer nested within the label or legend. They are associated with the input or with the fieldset using aria-describedby.
Hint has been made into a new component similar to Error Message.
If you're using markup, you will need to update the old markup:
<label class="govuk-c-label" for="national-insurance-number"> National Insurance number <span class="govuk-c-label__hint"> It’s on your National Insurance card, benefit letter, payslip or P60. For example, ‘QQ 12 34 56 C’. </span> <span class="govuk-c-error-message"> Error message goes here </span> </label> <input class="govuk-c-input govuk-c-input--error" id="national-insurance-number" name="national-insurance-number" type="text">
With the new markup:
<label class="govuk-label" for="national-insurance-number"> National Insurance number </label> <span id="national-insurance-number-hint" class="govuk-hint"> It’s on your <i>National Insurance card</i>, benefit letter, payslip or P60. For example, ‘QQ 12 34 56 C’. </span> <span id="national-insurance-number-error" class="govuk-error-message"> Error message goes here </span> <input class="govuk-input govuk-input--error" id="national-insurance-number" name="test-name-3" type="text" aria-describedby="national-insurance-number-hint national-insurance-number-error">
If you're using macros:
The fieldset macro no longer accepts
legendHintText
orlegendHintHtml
- these parameters are now passed to the hint component which acceptstext
orhtml
. The date-input, checkboxes and radios components have been updated to use the new Hint component.The label macro no longer accepts
hintText
orhintHtml
- these parameters are now passed to the hint component which acceptstext
orhtml
. The file-upload, input, select and textarea components have been updated to use the new Hint component.For example, this example macro call for a File Upload component:
{{ govukFileUpload({ "id": "file-upload", "name": "photo", "label": { "text": "Upload your photo", "hintText": "Your photo may be in your Pictures, Photos, Downloads or Desktop folder." } }) }}
would now be:
{{ govukFileUpload({ "id": "file-upload", "name": "photo", "label": { "text": "Upload your photo" }, "hint": { "text": "Your photo may be in your Pictures, Photos, Downloads or Desktop folder." } }) }}
For more examples of the new markup and Nunjucks macros see the GOV.UK Design System Question Pages pattern
(PR #681)
-
The date-input component now sets an explicit
group
role on the fieldset to force JAWS 18 to announce the error message and hint. (PR #681) -
The label component macro now accepts an
isPageHeading
argument which determines whether the label itself should be wrapped in an h1:<h1 class="govuk-label-wrapper"> <label class="govuk-label">What is your National Insurance number?</label> </h1>
The
.govuk-label-wrapper
removes the margins from the heading so that the presence of theh1
has no effect on the styling of the label.(PR #684)
-
Added new modifier classes for labels to allow you to create a label that visually corresponds to the equivalent heading class (for example, a
.govuk-label--xl
will have the same font size and weight as a.govuk-heading-xl
)(PR #684)
-
The arguments for a fieldset's legend have been rolled up into an object. For example, the following macro call:
{{ govukFieldset({ legendText: "What is your date of birth?" }) }}
would now be:
{{ govukFieldset({ legend: { text: "What is your date of birth?" } }) }}
The
legend
object can also accept newclasses
andarguments
Components that use the fieldset component have been updated to reflect these changes.
(PR #684)
-
The fieldset component has a new parameter legend.isPageHeading, which defines whether the legend text should be wrapped in an h1:
<legend class="govuk-fieldset__legend"> <h1 class="govuk-fieldset__heading">Have you changed your name?</h1> </legend>
The
.govuk-fieldset__heading
class ensures that the<h1>
inherits its properties from the legend, so that the presence of theh1
has no effect on its styling.(PR #684)
-
Added new modifier classes for legends to allow you to create a legend that visually corresponds to the equivalent heading class (for example, a
.govuk-fieldset__legend--xl
will have the same font size and weight as a.govuk-heading-xl
)(PR #684)
-
Remove -c -o -h layer prefixes (PR #644) In user research and in feedback from Private Beta partners we learned that users didn't really understand what -o, -c and -h prefixes stand for or why they're useful.
They also introduced additional cognitive load when composing classes, having to remember which suffix the classname contains.
If you're using markup, you will need to:
- Remove -o, -c and -h prefixes from class names in your markup
For example, change:
<button class="govuk-c-button">Save and continue</button>
Into:
<button class="govuk-button">Save and continue</button>
-
Simplify grid syntax and introduce grid-row and column mixins.
Based on user research feedback we have simplified the grid classes to a more concise naming structure.
You will need to:
- Change grid class names in your markup
For example, change:
<div class="govuk-o-grid"> <div class="govuk-o-grid__item govuk-o-grid__item--two-thirds"> <!-- content --> </div> <div class="govuk-o-grid__item govuk-o-grid__item--one-third"> <!-- content --> </div> </div>
Into:
<div class="govuk-grid-row"> <div class="govuk-grid-column-two-thirds"> <!-- content --> </div> <div class="govuk-grid-column-one-third"> <!-- content --> </div> </div>
We have also introduced two mixins to help generate additional or custom grid styles and widths, see original pull request for usage.
(PR #665)
🔧 Fixes:
-
Remove redundant font-family declaration from the button component – this will also fix an issue where the button uses New Transport when printed instead of falling back to the print stack as expected. (PR #650)
-
Reinstate focus outline for radios and checkboxes on IE8 (PR #670)
-
Fix section break styles when used with GOV.UK Elements (PR #682)
-
Remove
-webkit-tap-highlight-color
from links (PR #692) -
Remove normalize from /dist builds (PR #699)
🆕 New features:
-
We're now using ES6 Modules and rollup to distribute our JavaScript. (PR #652)
-
Checkboxes and Radios conditional reveal (PR #616)
-
Vendor-in SassMQ functionality, write tests and remove external dependency (PR #657)
-
Focus Error Summary on window load (PR #671)
-
Opt-in Global
<a>
and<p>
styles (PR #658)Global styles are not included by default.
This is to avoid the risk of these globals conflicting with any pre-existing globals, for example in GOV.UK Elements or GOV.UK Template.
Hovever, we do include them in the GOV.UK Prototype Kit to speed up prototyping.
To include global styles, you can set
$govuk-global-styles
variable totrue
.
🏠 Internal:
- Remove unused step in travis.yml file (PR #690)
- Update publishing docs (PR #651)
- Wrap
app.css
in conditional comments in review app layout (PR #653) - Fix missing code highlight and remove duplicate layout (PR #663)
- Exclude test related files from
dist/
andpackages/
copy task (PR #662) - Add test to check if Sass in packages compiles correctly after the
build:packages
task (PR #669) - Disable code syntax highlighting in IE8 (PR #675)
- Simplify contents of the
dist/
folder (PR #673) - Added tests to ensure that the settings, helpers and tools layers do not output CSS.
Fixes incomplete release from packages/
and dist/
in 0.0.27-alpha release.
Missing files were:
globals/tools/_compatibility.scss
globals/tools/_ie8.scss
globals/settings/_compatibility.scss
globals/settings/_ie8.scss
💥 Breaking changes:
-
Removed an (undocumented) modifier
govuk-c-radio__item--inline
which made radio buttons inline, in favour of a new block-level modifiergovuk-c-radios--inline
which will automatically make all the radio buttons within that block inline. (PR #607) -
Prefix
$global-images
variable (PR #615) -
Simplified how we build stylesheets that target old versions of IE:
- Removed styles that target IE6 and IE7
- Replaced IE mixins with a simpler version for targeting IE8 specifically without having to specify versions
- Add a new tool mixin to easily exclude styles when targeting IE8
- Automatically set $mq-responsive based on the value of the $govuk-is-ie8 variable.
If you are building an IE8 stylesheet for your application you'll need to update it to reference the new variable $govuk-is-ie8 – see the README for details. (PR #631)
-
Rename captionSize table argument to captionClasses (PR #643)
🔧 Fixes:
- Link styles, as well as links within the back-link, breadcrumbs, button,
error summary, footer and skip link components defend against the
a:link:focus
selector in GOV.UK Template, which was overriding focussed links to always use the dark blue link colour for text. (PR #609) - Fix table captions to allow heading classes (PR #633)
🆕 New features:
- Add
govuk-main-wrapper--l
a variant of the main page wrapper to use when a design does not include back links, breadcrumbs or phase banners (PR #602) - Added a new
.govuk-link--text-colour
modifier to make links use the same colour as the text. (PR #609) - Introduce new mixins for link styles (muted links, text links) and update the existing link classes to use them (PR #609)
- Introduce a new 'compatibility' mixin and settings to allow us to selectively include styles that 'counter' styles from the existing products (e.g. GOV.UK Template) (PR #609)
- The back link, breadcrumbs and skip link have been updated to use the text style link mixin (PR #609)
- Add limited width inputs (PR #626)
- Add details polyfill. This is automatically initialised in the main JS. (PR #610)
- Add button polyfill. This is automatically initialised in the main JS. #572)
Note: Our JavaScript work is ongoing. In the next release of GOV.UK Frontend both of our script will be modularised and split into common functions. This will allow you to use the polyfills in your bundler/build pipeline. For this reason, you might want to wait until the next release before adding these polyfill scripts into your project.
🏠 Internal:
-
Update check script for new components and tweak docs (PR #589)
-
Listen for development server on different port for tests (PR #622)
-
Fix date-input default example (PR #623)
-
Ensure we're testing error-messages in date-input (PR #625)
-
Explain npm link (PR #624)
-
Make Sass imports less broad (PR #617)
-
Update project README with user research findings (PR #617)
-
Update component READMEs to use
import
statement (PR #615) -
Use promisify util instead of manual method (PR #639)
💥 Breaking changes:
- The error summary component now has a default bottom margin (PR #583)
- Nest components correctly (PR #584)
🔧 Fixes:
- Make section break line 1px instead of 2px (PR #585)
🆕 New features:
- Add footer component (PR #569)
🏠 Internal:
- Update pre-release step to check for new components (PR #574)
- Ensure render function does not have undefined object (PR #587)
- Fix components relying on global builds (PR #588)
💥 Breaking changes:
- The colour variable
$govuk-fuschia
has been replaced with a new variable with the correct spelling ($govuk-fuchsia
) – thanks to @charlesrt for reporting. (PR #571)
🆕 New features:
- The input macro now accepts a
type
which allows you to override the default type="text" (PR #568)
🔧 Fixes:
- The transparent outline has been removed from the button, as it already has a transparent border which is visible when overriding colours in the browser (PR #552)
- Redundant duplication on the start button variant has been removed as it is inherited from the main .govuk-c-button class (PR #552)
- A fix to remove a black border from buttons in IE7 has been removed as we are not targeting IE7 for GOV.UK Frontend (PR #552)
- The date input component now sets
type="number"
andpattern="[0-9]*"
to match the previous implementation in Elements (PR #568)
🏠 Internal:
- The logic to determine button text colour automatically has been removed and replaced with a new variable $govuk-button-text-colour (PR #552)
- The button component now uses the focusable mixin (PR #552)
- The button component Sass has been restructured so that e.g. pseudo-selectors are consistently nested within their parents (PR #552)
- Fixes for the release process (PR #567)
- Add HTML5-shiv to review app (PR #575)
💥 Breaking changes:
- Namespace existing mixins and functions ( PR #557)
- The class
.govuk-section-break__visible
has been renamed to.govuk-section-break--visible
as it is a modifier, not an element. (PR #547) - Simplify
src/
folder structure, remove tree and string manipulations from gulp tasks (PR #545)
🆕 New features:
- A new variable
$govuk-input-border-colour
has been introduced to define the border colour for inputs. The Input, Select and Textarea components have been updated to use it. (PR #551)
🔧 Fixes:
-
Removes media query display on body from compiled CSS (PR #560)
-
Fieldset legends now correctly use 'full black' text colour when printed (PR #544)
-
Radio and Checkbox components now explicitly use currentColor for their borders, rather than relying on inheriting it (PR #551)
🏠 Internal:
- The 'prose scope' has been updated to extend only placeholder classes. The corresponding classes the prose scope extends have been updated to provide a placeholder class and separately create the concrete class. This allows us to be specific about which occurrences of the class are meant to be extended. (PR #550)
- The sass-lint config has been updated to prevent the use of
@extend
with concrete classes. (PR #550) - Release process has been streamlined with fewer steps (PR #553)
- Update
govuk-section-break__visible
new class namegovuk-section-break--visible
in the review app's Typography page. (PR #566)
💥 Breaking changes:
- Remove Cookie-banner and Previous-next components (PR #488, PR #523)
- Remove unused colours from the 'applied' colour palette:
(PR #525)
$govuk-panel-colour
$govuk-canvas-colour
$govuk-highlight-colour
$govuk-page-colour
$govuk-discovery-colour
$govuk-alpha-colour
$govuk-beta-colour
$govuk-live-colour
$govuk-error-background
$govuk-proposition-border
$govuk-proposition-active-nav
$govuk-footer-background
$govuk-footer-border-top
$govuk-footer-link
$govuk-footer-link-hover
$govuk-footer-text
- Rename
$govuk-button-colour-darken-15
to$govuk-button-shadow-colour
to avoid tying it to a particular colour. (PR #525)
🆕 New features:
- Button hover colour now has a semantic Sass name: $govuk-button-hover-colour (PR #406)
- A new link variant has been added which removes the visited state, for cases where distinguishing between visited and unvisited links is not helpful (PR #446)
- The responsive spacing and typography mixins will now throw an error if you try to use them with anything other than a spacing or font map respectively. (PR #447)
- Add thematic break to typography and prose scope. This class is added to an
<hr>
, adds margin (xl, l and m). There is also an option to make the<hr>
border visible or invisible. (PR #483)
🔧 Fixes:
- Remove double margin from Date input component (PR #451)
- Add top margin for nested lists (PR #464)
- Remove regular font weight from link styles (PR #469)
- Remove redundant 'govuk-c-border' div from the details component (PR #481)
- Add
govuk-c-select--error
modifier class to the select component instead of relying ongovuk-c-input--error
(PR #506) - Allow error message and hint text to be passed to a select component without requiring a label parameter (PR #506)
- Define size of inputs etc in
px
rather thanem
. (PR #491) - Remove scope=row attribute from non-th elements (PR 527)
- Form components and fieldset now include
govuk-o-form-group
that sets left border for errors and a bottom margin. Add example of form errors to preview app (PR #591)
🏠 Internal:
- Replace Mocha/Chai with Jest, re-enable task tests, add back-link component. Special thanks to @htmlandbacon and @tyom for sharing their approaches. (PR #455)
- Add example of nested lists to typography and prose scope in review app (PR #464)
- Add tests for tag component (PR #457)
- Add tests for button component (PR #461)
- Add tests for breadcrumbs component (PR #461)
- Add tests for details component (PR #480)
- Add tests for warning text component (PR #479)
- Add tests for table component (PR #472)
- Add tests for error-summary component (PR #489)
- Add tests for radios component (PR #476)
- Add tests for input component (PR #478)
- Add tests for date-input component (PR #495)
- Add tests for textarea component (PR #497)
- Add tests for panel component (PR #500)
- Add tests for skip-link component (PR #498)
- Add tests for file-upload component (PR #504)
- Add tests for error-message component (PR #507)
- Add tests for phase-banner component (PR #505)
- Add tests for label component component (PR #508)
- Add tests for fieldset component (PR #509)
- Add tests for select component (PR #506)
- Add tests for checkboxes component (PR #513)
- Add tests to make sure the examples pages render without errors #523
- Add correct links to the guidance in the Design System in component READMEs (PR #528)
💥 Breaking changes:
- The link styles in the core layer no longer style
a
elements directly, but instead provide agovuk-link
class which you will need to apply to links individually. (PR #427) - The link component has been removed from Frontend as the link styles have been moved to the core (PR #431)
- Rename
legal-text
argument accepted bylegal-text
component totext
(PR #431) - Rename
legal-text
component towarning-text
(PR #431)
🆕 New features:
- The prose scope has been extended to style links, which means links within the
scope do not need the
govuk-link
class applied. (PR #427) - The muted link variant from the link component is now available as a core
class (
govuk-link--muted
). (PR #427)
🔧 Fixes:
- The error summary component allows users to pass HTML for an entry in the list again. (PR #428)
- Error list entries in the error summary component no longer get wrapped in
links when no
href
is provided. (PR #428) - Remove redundant 'resets' for link print styles (PR #427)
- The back link, breadcrumbs, error summary, previous / next and skip link components have been updated to include explicit link styling, as they previously relied on the global link styles. (PR #427)
- Adjust
warning-text
icon by 1px for New Transport
🏠 Internal:
- Add prose scope example (PR #429)
- Links within the review app and the examples have been updated to use the
govuk-link
class. (PR #427) - Improve documentation around publishing (PR #430)
- Improve documentation around contributing (PR #433)
- Remove readme content from review app (PR #482)
Skipped 0.0.20-alpha due to difficulties with publishing.
💥 Breaking changes:
- Rename ‘govuk-body-lede’ to ‘govuk-body-lead’. (PR #405)
- Pluralise radio component (PR #388)
- Pluralise checkbox component (PR #384)
🆕 New features:
- Add
width
classes, which were based onform-control
classes that were specific to form control in Elements. (PR #413)
🔧 Fixes:
- Make buttons 40px high including box shadow (PR #416)
- Fix focus outline style in Chrome and Safari (PR #414)
- Remove contributors list from template, fix template markup and update README files (PR #403)
- Generate breadcrumb chevrons using pseudo-elements (PR #407)
- Fix undefined classes in date input macro (PR #410)
- Add documentation for typography helpers / core, simplify syntax (PR #400)
- Add adjacent styles for headings after lists (PR #408)
- Allow line height to be overridden in typography helpers (PR #404)