govuk_publishing_components 34.7.0 → 34.8.0

data/node_modules/govuk-frontend/govuk-esm/components/error-summary/error-summary.mjs

@@ -1,9 +1,10 @@
-import '../../vendor/polyfills/Function/prototype/bind.mjs'
-import '../../vendor/polyfills/Event.mjs' // addEventListener
-import '../../vendor/polyfills/Element/prototype/closest.mjs'
+/* eslint-disable es-x/no-function-prototype-bind -- Polyfill imported */
 
 import { mergeConfigs } from '../../common/index.mjs'
 import { normaliseDataset } from '../../common/normalise-dataset.mjs'
+import '../../vendor/polyfills/Element/prototype/closest.mjs'
+import '../../vendor/polyfills/Event.mjs' // addEventListener, event.target normalization and DOMContentLoaded
+import '../../vendor/polyfills/Function/prototype/bind.mjs'
 
 /**
  * JavaScript enhancements for the ErrorSummary
@@ -11,8 +12,8 @@ import { normaliseDataset } from '../../common/normalise-dataset.mjs'
  * Takes focus on initialisation for accessible announcement, unless disabled in configuration.
  *
  * @class
- * @param {HTMLElement} $module - The element this component controls
- * @param {ErrorSummaryConfig} config - Error summary config
+ * @param {HTMLElement} $module - HTML element to use for error summary
+ * @param {ErrorSummaryConfig} [config] - Error summary config
  */
 function ErrorSummary ($module, config) {
   // Some consuming code may not be passing a module,
@@ -40,6 +41,9 @@ function ErrorSummary ($module, config) {
   )
 }
 
+/**
+ * Initialise component
+ */
 ErrorSummary.prototype.init = function () {
   var $module = this.$module
   if (!$module) {
@@ -77,8 +81,8 @@ ErrorSummary.prototype.setFocus = function () {
  * @param {MouseEvent} event - Click event
  */
 ErrorSummary.prototype.handleClick = function (event) {
-  var target = event.target
-  if (this.focusTarget(target)) {
+  var $target = event.target
+  if (this.focusTarget($target)) {
     event.preventDefault()
   }
 }
@@ -98,7 +102,7 @@ ErrorSummary.prototype.handleClick = function (event) {
  * NVDA (as tested in 2018.3.2) - without this only the field type is announced
  * (e.g. "Edit, has autocomplete").
  *
- * @param {HTMLElement} $target - Event target
+ * @param {EventTarget} $target - Event target
  * @returns {boolean} True if the target was able to be focussed
  */
 ErrorSummary.prototype.focusTarget = function ($target) {
@@ -163,10 +167,10 @@ ErrorSummary.prototype.getAssociatedLegendOrLabel = function ($input) {
   var $fieldset = $input.closest('fieldset')
 
   if ($fieldset) {
-    var legends = $fieldset.getElementsByTagName('legend')
+    var $legends = $fieldset.getElementsByTagName('legend')
 
-    if (legends.length) {
-      var $candidateLegend = legends[0]
+    if ($legends.length) {
+      var $candidateLegend = $legends[0]
 
       // If the input type is radio or checkbox, always use the legend if there
       // is one.

data/node_modules/govuk-frontend/govuk-esm/components/header/header.mjs

@@ -1,5 +1,6 @@
+/* eslint-disable es-x/no-function-prototype-bind -- Polyfill imported */
+
 import '../../vendor/polyfills/Event.mjs'
-import '../../vendor/polyfills/Element/prototype/classList.mjs'
 import '../../vendor/polyfills/Function/prototype/bind.mjs'
 
 /**
@@ -28,7 +29,7 @@ function Header ($module) {
 }
 
 /**
- * Initialise header
+ * Initialise component
  *
  * Check for the presence of the header, menu and menu button – if any are
  * missing then there's nothing to do so return early.

data/node_modules/govuk-frontend/govuk-esm/components/notification-banner/notification-banner.mjs

@@ -1,14 +1,13 @@
-import '../../vendor/polyfills/Event.mjs' // addEventListener
-
 import { mergeConfigs } from '../../common/index.mjs'
 import { normaliseDataset } from '../../common/normalise-dataset.mjs'
+import '../../vendor/polyfills/Event.mjs' // addEventListener, event.target normalization and DOMContentLoaded
 
 /**
  * Notification Banner component
  *
  * @class
  * @param {HTMLElement} $module - HTML element to use for notification banner
- * @param {NotificationBannerConfig} config - Notification banner config
+ * @param {NotificationBannerConfig} [config] - Notification banner config
  */
 function NotificationBanner ($module, config) {
   this.$module = $module
@@ -24,7 +23,7 @@ function NotificationBanner ($module, config) {
 }
 
 /**
- * Initialise the component
+ * Initialise component
  */
 NotificationBanner.prototype.init = function () {
   var $module = this.$module

data/node_modules/govuk-frontend/govuk-esm/components/radios/radios.mjs

@@ -1,8 +1,9 @@
-import '../../vendor/polyfills/Function/prototype/bind.mjs'
-// addEventListener, event.target normalization and DOMContentLoaded
-import '../../vendor/polyfills/Event.mjs'
-import '../../vendor/polyfills/Element/prototype/classList.mjs'
+/* eslint-disable es-x/no-function-prototype-bind -- Polyfill imported */
+
 import { nodeListForEach } from '../../common/index.mjs'
+import '../../vendor/polyfills/Element/prototype/classList.mjs'
+import '../../vendor/polyfills/Event.mjs' // addEventListener, event.target normalization and DOMContentLoaded
+import '../../vendor/polyfills/Function/prototype/bind.mjs'
 
 /**
  * Radios component
@@ -16,7 +17,7 @@ function Radios ($module) {
 }
 
 /**
- * Initialise Radios
+ * Initialise component
  *
  * Radios can be associated with a 'conditionally revealed' content block – for
  * example, a radio for 'Phone' could reveal an additional form field for the
@@ -34,17 +35,17 @@ Radios.prototype.init = function () {
   var $inputs = this.$inputs
 
   nodeListForEach($inputs, function ($input) {
-    var target = $input.getAttribute('data-aria-controls')
+    var targetId = $input.getAttribute('data-aria-controls')
 
     // Skip radios without data-aria-controls attributes, or where the
     // target element does not exist.
-    if (!target || !document.getElementById(target)) {
+    if (!targetId || !document.getElementById(targetId)) {
       return
     }
 
     // Promote the data-aria-controls attribute to a aria-controls attribute
     // so that the relationship is exposed in the AOM
-    $input.setAttribute('aria-controls', target)
+    $input.setAttribute('aria-controls', targetId)
     $input.removeAttribute('data-aria-controls')
   })
 
@@ -68,7 +69,7 @@ Radios.prototype.init = function () {
 }
 
 /**
- * Sync the conditional reveal states for all inputs in this $module.
+ * Sync the conditional reveal states for all radio buttons in this $module.
  */
 Radios.prototype.syncAllConditionalReveals = function () {
   nodeListForEach(this.$inputs, this.syncConditionalRevealWithInputState.bind(this))

data/node_modules/govuk-frontend/govuk-esm/components/skip-link/skip-link.mjs

@@ -1,6 +1,8 @@
-import '../../vendor/polyfills/Function/prototype/bind.mjs'
+/* eslint-disable es-x/no-function-prototype-bind -- Polyfill imported */
+
 import '../../vendor/polyfills/Element/prototype/classList.mjs'
-import '../../vendor/polyfills/Event.mjs' // addEventListener and event.target normalization
+import '../../vendor/polyfills/Event.mjs' // addEventListener, event.target normalization and DOMContentLoaded
+import '../../vendor/polyfills/Function/prototype/bind.mjs'
 
 /**
  * Skip link component
@@ -15,7 +17,7 @@ function SkipLink ($module) {
 }
 
 /**
- * Initialise the component
+ * Initialise component
  */
 SkipLink.prototype.init = function () {
   // Check for module

data/node_modules/govuk-frontend/govuk-esm/components/tabs/tabs.mjs

@@ -1,9 +1,11 @@
-import '../../vendor/polyfills/Function/prototype/bind.mjs'
+/* eslint-disable es-x/no-function-prototype-bind -- Polyfill imported */
+
+import { nodeListForEach } from '../../common/index.mjs'
 import '../../vendor/polyfills/Element/prototype/classList.mjs'
 import '../../vendor/polyfills/Element/prototype/nextElementSibling.mjs'
 import '../../vendor/polyfills/Element/prototype/previousElementSibling.mjs'
-import '../../vendor/polyfills/Event.mjs' // addEventListener and event.target normaliziation
-import { nodeListForEach } from '../../common/index.mjs'
+import '../../vendor/polyfills/Event.mjs' // addEventListener, event.target normalization and DOMContentLoaded
+import '../../vendor/polyfills/Function/prototype/bind.mjs'
 
 /**
  * Tabs component
@@ -19,6 +21,9 @@ function Tabs ($module) {
   this.jsHiddenClass = 'govuk-tabs__panel--hidden'
 }
 
+/**
+ * Initialise component
+ */
 Tabs.prototype.init = function () {
   if (typeof window.matchMedia === 'function') {
     this.setupResponsiveChecks()
@@ -27,12 +32,18 @@ Tabs.prototype.init = function () {
   }
 }
 
+/**
+ * Setup viewport resize check
+ */
 Tabs.prototype.setupResponsiveChecks = function () {
   this.mql = window.matchMedia('(min-width: 40.0625em)')
   this.mql.addListener(this.checkMode.bind(this))
   this.checkMode()
 }
 
+/**
+ * Setup or teardown handler for viewport resize check
+ */
 Tabs.prototype.checkMode = function () {
   if (this.mql.matches) {
     this.setup()
@@ -41,6 +52,9 @@ Tabs.prototype.checkMode = function () {
   }
 }
 
+/**
+ * Setup tab component
+ */
 Tabs.prototype.setup = function () {
   var $module = this.$module
   var $tabs = this.$tabs
@@ -82,6 +96,9 @@ Tabs.prototype.setup = function () {
   window.addEventListener('hashchange', $module.boundOnHashChange, true)
 }
 
+/**
+ * Teardown tab component
+ */
 Tabs.prototype.teardown = function () {
   var $module = this.$module
   var $tabs = this.$tabs
@@ -111,7 +128,13 @@ Tabs.prototype.teardown = function () {
   window.removeEventListener('hashchange', $module.boundOnHashChange, true)
 }
 
-Tabs.prototype.onHashChange = function (e) {
+/**
+ * Handle hashchange event
+ *
+ * @param {HashChangeEvent} event - Hash change event
+ * @returns {void | undefined} Returns void, or undefined when prevented
+ */
+Tabs.prototype.onHashChange = function (event) {
   var hash = window.location.hash
   var $tabWithHash = this.getTab(hash)
   if (!$tabWithHash) {
@@ -132,20 +155,41 @@ Tabs.prototype.onHashChange = function (e) {
   $tabWithHash.focus()
 }
 
+/**
+ * Hide panel for tab link
+ *
+ * @param {HTMLAnchorElement} $tab - Tab link
+ */
 Tabs.prototype.hideTab = function ($tab) {
   this.unhighlightTab($tab)
   this.hidePanel($tab)
 }
 
+/**
+ * Show panel for tab link
+ *
+ * @param {HTMLAnchorElement} $tab - Tab link
+ */
 Tabs.prototype.showTab = function ($tab) {
   this.highlightTab($tab)
   this.showPanel($tab)
 }
 
+/**
+ * Get tab link by hash
+ *
+ * @param {string} hash - Hash fragment including #
+ * @returns {HTMLAnchorElement | null} Tab link
+ */
 Tabs.prototype.getTab = function (hash) {
   return this.$module.querySelector('.govuk-tabs__tab[href="' + hash + '"]')
 }
 
+/**
+ * Set tab link and panel attributes
+ *
+ * @param {HTMLAnchorElement} $tab - Tab link
+ */
 Tabs.prototype.setAttributes = function ($tab) {
   // set tab attributes
   var panelId = this.getHref($tab).slice(1)
@@ -162,6 +206,11 @@ Tabs.prototype.setAttributes = function ($tab) {
   $panel.classList.add(this.jsHiddenClass)
 }
 
+/**
+ * Unset tab link and panel attributes
+ *
+ * @param {HTMLAnchorElement} $tab - Tab link
+ */
 Tabs.prototype.unsetAttributes = function ($tab) {
   // unset tab attributes
   $tab.removeAttribute('id')
@@ -177,108 +226,186 @@ Tabs.prototype.unsetAttributes = function ($tab) {
   $panel.classList.remove(this.jsHiddenClass)
 }
 
-Tabs.prototype.onTabClick = function (e) {
-  if (!e.target.classList.contains('govuk-tabs__tab')) {
-  // Allow events on child DOM elements to bubble up to tab parent
+/**
+ * Handle tab link clicks
+ *
+ * @param {MouseEvent} event - Mouse click event
+ * @returns {void | false} Returns void, or false within tab link
+ */
+Tabs.prototype.onTabClick = function (event) {
+  if (!event.target.classList.contains('govuk-tabs__tab')) {
+    // Allow events on child DOM elements to bubble up to tab parent
     return false
   }
-  e.preventDefault()
-  var $newTab = e.target
+  event.preventDefault()
+  var $newTab = event.target
   var $currentTab = this.getCurrentTab()
   this.hideTab($currentTab)
   this.showTab($newTab)
   this.createHistoryEntry($newTab)
 }
 
+/**
+ * Update browser URL hash fragment for tab
+ *
+ * - Allows back/forward to navigate tabs
+ * - Avoids page jump when hash changes
+ *
+ * @param {HTMLAnchorElement} $tab - Tab link
+ */
 Tabs.prototype.createHistoryEntry = function ($tab) {
   var $panel = this.getPanel($tab)
 
   // Save and restore the id
   // so the page doesn't jump when a user clicks a tab (which changes the hash)
-  var id = $panel.id
+  var panelId = $panel.id
   $panel.id = ''
   this.changingHash = true
   window.location.hash = this.getHref($tab).slice(1)
-  $panel.id = id
+  $panel.id = panelId
 }
 
-Tabs.prototype.onTabKeydown = function (e) {
-  switch (e.keyCode) {
+/**
+ * Handle tab keydown event
+ *
+ * - Press right/down arrow for next tab
+ * - Press left/up arrow for previous tab
+ *
+ * @param {KeyboardEvent} event - Keydown event
+ */
+Tabs.prototype.onTabKeydown = function (event) {
+  switch (event.keyCode) {
     case this.keys.left:
     case this.keys.up:
       this.activatePreviousTab()
-      e.preventDefault()
+      event.preventDefault()
       break
     case this.keys.right:
     case this.keys.down:
       this.activateNextTab()
-      e.preventDefault()
+      event.preventDefault()
       break
   }
 }
 
+/**
+ * Activate next tab
+ */
 Tabs.prototype.activateNextTab = function () {
-  var currentTab = this.getCurrentTab()
-  var nextTabListItem = currentTab.parentNode.nextElementSibling
-  if (nextTabListItem) {
-    var nextTab = nextTabListItem.querySelector('.govuk-tabs__tab')
+  var $currentTab = this.getCurrentTab()
+  if (!$currentTab) {
+    return
   }
-  if (nextTab) {
-    this.hideTab(currentTab)
-    this.showTab(nextTab)
-    nextTab.focus()
-    this.createHistoryEntry(nextTab)
+
+  var $nextTabListItem = $currentTab.parentElement.nextElementSibling
+  if (!$nextTabListItem) {
+    return
+  }
+
+  var $nextTab = $nextTabListItem.querySelector('.govuk-tabs__tab')
+  if ($nextTab) {
+    this.hideTab($currentTab)
+    this.showTab($nextTab)
+    $nextTab.focus()
+    this.createHistoryEntry($nextTab)
   }
 }
 
+/**
+ * Activate previous tab
+ */
 Tabs.prototype.activatePreviousTab = function () {
-  var currentTab = this.getCurrentTab()
-  var previousTabListItem = currentTab.parentNode.previousElementSibling
-  if (previousTabListItem) {
-    var previousTab = previousTabListItem.querySelector('.govuk-tabs__tab')
+  var $currentTab = this.getCurrentTab()
+  if (!$currentTab) {
+    return
+  }
+
+  var $previousTabListItem = $currentTab.parentElement.previousElementSibling
+  if (!$previousTabListItem) {
+    return
   }
-  if (previousTab) {
-    this.hideTab(currentTab)
-    this.showTab(previousTab)
-    previousTab.focus()
-    this.createHistoryEntry(previousTab)
+
+  var $previousTab = $previousTabListItem.querySelector('.govuk-tabs__tab')
+  if ($previousTab) {
+    this.hideTab($currentTab)
+    this.showTab($previousTab)
+    $previousTab.focus()
+    this.createHistoryEntry($previousTab)
   }
 }
 
+/**
+ * Get tab panel for tab link
+ *
+ * @param {HTMLAnchorElement} $tab - Tab link
+ * @returns {HTMLDivElement} Tab panel
+ */
 Tabs.prototype.getPanel = function ($tab) {
   var $panel = this.$module.querySelector(this.getHref($tab))
   return $panel
 }
 
+/**
+ * Show tab panel for tab link
+ *
+ * @param {HTMLAnchorElement} $tab - Tab link
+ */
 Tabs.prototype.showPanel = function ($tab) {
   var $panel = this.getPanel($tab)
   $panel.classList.remove(this.jsHiddenClass)
 }
 
-Tabs.prototype.hidePanel = function (tab) {
-  var $panel = this.getPanel(tab)
+/**
+ * Hide tab panel for tab link
+ *
+ * @param {HTMLAnchorElement} $tab - Tab link
+ */
+Tabs.prototype.hidePanel = function ($tab) {
+  var $panel = this.getPanel($tab)
   $panel.classList.add(this.jsHiddenClass)
 }
 
+/**
+ * Unset 'selected' state for tab link
+ *
+ * @param {HTMLAnchorElement} $tab - Tab link
+ */
 Tabs.prototype.unhighlightTab = function ($tab) {
   $tab.setAttribute('aria-selected', 'false')
   $tab.parentNode.classList.remove('govuk-tabs__list-item--selected')
   $tab.setAttribute('tabindex', '-1')
 }
 
+/**
+ * Set 'selected' state for tab link
+ *
+ * @param {HTMLAnchorElement} $tab - Tab link
+ */
 Tabs.prototype.highlightTab = function ($tab) {
   $tab.setAttribute('aria-selected', 'true')
   $tab.parentNode.classList.add('govuk-tabs__list-item--selected')
   $tab.setAttribute('tabindex', '0')
 }
 
+/**
+ * Get current tab link
+ *
+ * @returns {HTMLAnchorElement | undefined} Tab link
+ */
 Tabs.prototype.getCurrentTab = function () {
   return this.$module.querySelector('.govuk-tabs__list-item--selected .govuk-tabs__tab')
 }
 
-// this is because IE doesn't always return the actual value but a relative full path
-// should be a utility function most prob
-// http://labs.thesedays.com/blog/2010/01/08/getting-the-href-value-with-jquery-in-ie/
+/**
+ * Get link hash fragment for href attribute
+ *
+ * this is because IE doesn't always return the actual value but a relative full path
+ * should be a utility function most prob
+ * {@link http://labs.thesedays.com/blog/2010/01/08/getting-the-href-value-with-jquery-in-ie/}
+ *
+ * @param {HTMLAnchorElement} $tab - Tab link
+ * @returns {string} Hash fragment including #
+ */
 Tabs.prototype.getHref = function ($tab) {
   var href = $tab.getAttribute('href')
   var hash = href.slice(href.indexOf('#'), href.length)

data/node_modules/govuk-frontend/govuk-esm/i18n.mjs

@@ -4,9 +4,9 @@
  *
  * @class
  * @private
- * @param {TranslationsFlattened} translations - Key-value pairs of the translation strings to use.
+ * @param {Object<string, unknown>} translations - Key-value pairs of the translation strings to use.
  * @param {object} [config] - Configuration options for the function.
- * @param {string} config.locale - An overriding locale for the PluralRules functionality.
+ * @param {string} [config.locale] - An overriding locale for the PluralRules functionality.
  */
 export function I18n (translations, config) {
   // Make list of translations available throughout function
@@ -21,8 +21,10 @@ export function I18n (translations, config) {
  * returns the appropriate string.
  *
  * @param {string} lookupKey - The lookup key of the string to use.
- * @param {object} options - Any options passed with the translation string, e.g: for string interpolation.
+ * @param {Object<string, unknown>} [options] - Any options passed with the translation string, e.g: for string interpolation.
  * @returns {string} The appropriate translation string.
+ * @throws {Error} Lookup key required
+ * @throws {Error} Options required for `${}` placeholders
  */
 I18n.prototype.t = function (lookupKey, options) {
   if (!lookupKey) {
@@ -64,7 +66,7 @@ I18n.prototype.t = function (lookupKey, options) {
  * with the provided data
  *
  * @param {string} translationString - The translation string
- * @param {object} options - Any options passed with the translation string, e.g: for string interpolation.
+ * @param {Object<string, unknown>} options - Any options passed with the translation string, e.g: for string interpolation.
  * @returns {string} The translation string to output, with ${} placeholders replaced
  */
 I18n.prototype.replacePlaceholders = function (translationString, options) {
@@ -137,6 +139,7 @@ I18n.prototype.hasIntlNumberFormatSupport = function () {
  * @param {string} lookupKey - The lookup key of the string to use.
  * @param {number} count - Number used to determine which pluralisation to use.
  * @returns {PluralRule} The suffix associated with the correct pluralisation for this locale.
+ * @throws {Error} Plural form `.other` required when preferred plural form is missing
  */
 I18n.prototype.getPluralSuffix = function (lookupKey, count) {
   // Validate that the number is actually a number.
@@ -290,6 +293,7 @@ I18n.pluralRulesMap = {
  * @type {Object<string, function(number): PluralRule>}
  */
 I18n.pluralRules = {
+  /* eslint-disable jsdoc/require-jsdoc */
   arabic: function (n) {
     if (n === 0) { return 'zero' }
     if (n === 1) { return 'one' }
@@ -343,6 +347,7 @@ I18n.pluralRules = {
     if (n === 6) { return 'many' }
     return 'other'
   }
+  /* eslint-enable jsdoc/require-jsdoc */
 }
 
 /**
@@ -371,10 +376,3 @@ I18n.pluralRules = {
  * @property {string} [few] - Plural form used for a few
  * @property {string} [many] - Plural form used for many
  */
-
-/**
- * Translated messages (flattened)
- *
- * @private
- * @typedef {Object<string, string> | {}} TranslationsFlattened
- */

data/node_modules/govuk-frontend/package.json

@@ -1,7 +1,7 @@
 {
   "name": "govuk-frontend",
   "description": "GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.",
-  "version": "4.4.1",
+  "version": "4.5.0",
   "main": "govuk/all.js",
   "module": "govuk-esm/all.mjs",
   "exports": {