govuk_tech_docs 6.5.2.1 → 6.6.0.beta

data/node_modules/govuk-frontend/dist/govuk/components/accordion/accordion.mjs

@@ -1,4 +1,5 @@
 import { ConfigurableComponent } from '../../common/configuration.mjs';
+import { createElement } from '../../common/create-element.mjs';
 import { ElementError } from '../../errors/index.mjs';
 import { I18n } from '../../i18n.mjs';
 
@@ -25,24 +26,16 @@ class Accordion extends ConfigurableComponent {
   constructor($root, config = {}) {
     super($root, config);
     this.i18n = void 0;
-    this.controlsClass = 'govuk-accordion__controls';
-    this.showAllClass = 'govuk-accordion__show-all';
-    this.showAllTextClass = 'govuk-accordion__show-all-text';
     this.sectionClass = 'govuk-accordion__section';
-    this.sectionExpandedClass = 'govuk-accordion__section--expanded';
+    this.sectionExpandedModifier = 'govuk-accordion__section--expanded';
     this.sectionButtonClass = 'govuk-accordion__section-button';
     this.sectionHeaderClass = 'govuk-accordion__section-header';
     this.sectionHeadingClass = 'govuk-accordion__section-heading';
-    this.sectionHeadingDividerClass = 'govuk-accordion__section-heading-divider';
     this.sectionHeadingTextClass = 'govuk-accordion__section-heading-text';
-    this.sectionHeadingTextFocusClass = 'govuk-accordion__section-heading-text-focus';
-    this.sectionShowHideToggleClass = 'govuk-accordion__section-toggle';
-    this.sectionShowHideToggleFocusClass = 'govuk-accordion__section-toggle-focus';
-    this.sectionShowHideTextClass = 'govuk-accordion__section-toggle-text';
-    this.upChevronIconClass = 'govuk-accordion-nav__chevron';
-    this.downChevronIconClass = 'govuk-accordion-nav__chevron--down';
+    this.sectionToggleTextClass = 'govuk-accordion__section-toggle-text';
+    this.iconClass = 'govuk-accordion-nav__chevron';
+    this.iconOpenModifier = 'govuk-accordion-nav__chevron--down';
     this.sectionSummaryClass = 'govuk-accordion__section-summary';
-    this.sectionSummaryFocusClass = 'govuk-accordion__section-summary-focus';
     this.sectionContentClass = 'govuk-accordion__section-content';
     this.$sections = void 0;
     this.$showAllButton = null;
@@ -62,19 +55,23 @@ class Accordion extends ConfigurableComponent {
     this.updateShowAllButton(this.areAllSectionsOpen());
   }
   initControls() {
-    this.$showAllButton = document.createElement('button');
-    this.$showAllButton.setAttribute('type', 'button');
-    this.$showAllButton.setAttribute('class', this.showAllClass);
-    this.$showAllButton.setAttribute('aria-expanded', 'false');
-    this.$showAllIcon = document.createElement('span');
-    this.$showAllIcon.classList.add(this.upChevronIconClass);
+    this.$showAllButton = createElement('button', {
+      type: 'button',
+      class: 'govuk-accordion__show-all',
+      'aria-expanded': 'false'
+    });
+    this.$showAllIcon = createElement('span', {
+      class: this.iconClass
+    });
     this.$showAllButton.appendChild(this.$showAllIcon);
-    const $accordionControls = document.createElement('div');
-    $accordionControls.setAttribute('class', this.controlsClass);
+    const $accordionControls = createElement('div', {
+      class: 'govuk-accordion__controls'
+    });
     $accordionControls.appendChild(this.$showAllButton);
     this.$root.insertBefore($accordionControls, this.$root.firstChild);
-    this.$showAllText = document.createElement('span');
-    this.$showAllText.classList.add(this.showAllTextClass);
+    this.$showAllText = createElement('span', {
+      class: 'govuk-accordion__show-all-text'
+    });
     this.$showAllButton.appendChild(this.$showAllText);
     this.$showAllButton.addEventListener('click', () => this.onShowOrHideAllToggle());
     if ('onbeforematch' in document) {
@@ -112,39 +109,45 @@ class Accordion extends ConfigurableComponent {
         identifier: `Section button placeholder (\`<span class="${this.sectionButtonClass}">\`)`
       });
     }
-    const $button = document.createElement('button');
-    $button.setAttribute('type', 'button');
-    $button.setAttribute('aria-controls', `${this.$root.id}-content-${index + 1}`);
+    const $button = createElement('button', {
+      type: 'button',
+      'aria-controls': `${this.$root.id}-content-${index + 1}`
+    });
     for (const attr of Array.from($span.attributes)) {
       if (attr.name !== 'id') {
         $button.setAttribute(attr.name, attr.value);
       }
     }
-    const $headingText = document.createElement('span');
-    $headingText.classList.add(this.sectionHeadingTextClass);
-    $headingText.id = $span.id;
-    const $headingTextFocus = document.createElement('span');
-    $headingTextFocus.classList.add(this.sectionHeadingTextFocusClass);
+    const $headingText = createElement('span', {
+      class: this.sectionHeadingTextClass,
+      id: $span.id
+    });
+    const $headingTextFocus = createElement('span', {
+      class: 'govuk-accordion__section-heading-text-focus'
+    });
     $headingText.appendChild($headingTextFocus);
     Array.from($span.childNodes).forEach($child => $headingTextFocus.appendChild($child));
-    const $showHideToggle = document.createElement('span');
-    $showHideToggle.classList.add(this.sectionShowHideToggleClass);
-    $showHideToggle.setAttribute('data-nosnippet', '');
-    const $showHideToggleFocus = document.createElement('span');
-    $showHideToggleFocus.classList.add(this.sectionShowHideToggleFocusClass);
+    const $showHideToggle = createElement('span', {
+      class: 'govuk-accordion__section-toggle',
+      'data-nosnippet': ''
+    });
+    const $showHideToggleFocus = createElement('span', {
+      class: 'govuk-accordion__section-toggle-focus'
+    });
     $showHideToggle.appendChild($showHideToggleFocus);
-    const $showHideText = document.createElement('span');
-    const $showHideIcon = document.createElement('span');
-    $showHideIcon.classList.add(this.upChevronIconClass);
-    $showHideToggleFocus.appendChild($showHideIcon);
-    $showHideText.classList.add(this.sectionShowHideTextClass);
-    $showHideToggleFocus.appendChild($showHideText);
+    $showHideToggleFocus.appendChild(createElement('span', {
+      class: this.iconClass
+    }));
+    $showHideToggleFocus.appendChild(createElement('span', {
+      class: this.sectionToggleTextClass
+    }));
     $button.appendChild($headingText);
     $button.appendChild(this.getButtonPunctuationEl());
     if ($summary) {
-      const $summarySpan = document.createElement('span');
-      const $summarySpanFocus = document.createElement('span');
-      $summarySpanFocus.classList.add(this.sectionSummaryFocusClass);
+      const $summarySpan = createElement('span');
+      const $summarySpanFocus = createElement('span', {
+        class: 'govuk-accordion__section-summary-focus'
+      });
       $summarySpan.appendChild($summarySpanFocus);
       for (const attr of Array.from($summary.attributes)) {
         $summarySpan.setAttribute(attr.name, attr.value);
@@ -182,8 +185,8 @@ class Accordion extends ConfigurableComponent {
     this.updateShowAllButton(nowExpanded);
   }
   setExpanded(expanded, $section) {
-    const $showHideIcon = $section.querySelector(`.${this.upChevronIconClass}`);
-    const $showHideText = $section.querySelector(`.${this.sectionShowHideTextClass}`);
+    const $showHideIcon = $section.querySelector(`.${this.iconClass}`);
+    const $showHideText = $section.querySelector(`.${this.sectionToggleTextClass}`);
     const $button = $section.querySelector(`.${this.sectionButtonClass}`);
     const $content = $section.querySelector(`.${this.sectionContentClass}`);
     if (!$content) {
@@ -212,17 +215,17 @@ class Accordion extends ConfigurableComponent {
     $button.setAttribute('aria-label', ariaLabelParts.join(' , '));
     if (expanded) {
       $content.removeAttribute('hidden');
-      $section.classList.add(this.sectionExpandedClass);
-      $showHideIcon.classList.remove(this.downChevronIconClass);
+      $section.classList.add(this.sectionExpandedModifier);
+      $showHideIcon.classList.remove(this.iconOpenModifier);
     } else {
       $content.setAttribute('hidden', 'until-found');
-      $section.classList.remove(this.sectionExpandedClass);
-      $showHideIcon.classList.add(this.downChevronIconClass);
+      $section.classList.remove(this.sectionExpandedModifier);
+      $showHideIcon.classList.add(this.iconOpenModifier);
     }
     this.updateShowAllButton(this.areAllSectionsOpen());
   }
   isExpanded($section) {
-    return $section.classList.contains(this.sectionExpandedClass);
+    return $section.classList.contains(this.sectionExpandedModifier);
   }
   areAllSectionsOpen() {
     return Array.from(this.$sections).every($section => this.isExpanded($section));
@@ -233,7 +236,7 @@ class Accordion extends ConfigurableComponent {
     }
     this.$showAllButton.setAttribute('aria-expanded', expanded.toString());
     this.$showAllText.textContent = expanded ? this.i18n.t('hideAllSections') : this.i18n.t('showAllSections');
-    this.$showAllIcon.classList.toggle(this.downChevronIconClass, !expanded);
+    this.$showAllIcon.classList.toggle(this.iconOpenModifier, !expanded);
   }
 
   /**
@@ -276,10 +279,11 @@ class Accordion extends ConfigurableComponent {
     }
   }
   getButtonPunctuationEl() {
-    const $punctuationEl = document.createElement('span');
-    $punctuationEl.classList.add('govuk-visually-hidden', this.sectionHeadingDividerClass);
-    $punctuationEl.textContent = ', ';
-    return $punctuationEl;
+    const $element = createElement('span', {
+      class: 'govuk-visually-hidden govuk-accordion__section-heading-divider'
+    });
+    $element.textContent = ', ';
+    return $element;
   }
 }
 

data/node_modules/govuk-frontend/dist/govuk/components/button/button.bundle.js

@@ -29,6 +29,9 @@
   function isObject(option) {
     return !!option && typeof option === 'object' && !isArray(option);
   }
+  function isScope($scope) {
+    return !!$scope && ($scope instanceof Element || $scope instanceof Document);
+  }
   function formatErrorMessage(Component, message) {
     return `${Component.moduleName}: ${message}`;
   }
@@ -47,11 +50,14 @@
     /**
      * Checks if GOV.UK Frontend is supported on this page
      *
-     * @param {HTMLElement | null} [$scope] - HTML element `<body>` checked for browser support
+     * @param {Element | Document | null | string} [scopeOrMessage] - HTML element `<body>` checked for browser support or support error message
      */
-    constructor($scope = document.body) {
-      const supportMessage = 'noModule' in HTMLScriptElement.prototype ? 'GOV.UK Frontend initialised without `<body class="govuk-frontend-supported">` from template `<script>` snippet' : 'GOV.UK Frontend is not supported in this browser';
-      super($scope ? supportMessage : 'GOV.UK Frontend initialised without `<script type="module">`');
+    constructor(scopeOrMessage = document.body) {
+      let supportMessage = 'noModule' in HTMLScriptElement.prototype ? 'GOV.UK Frontend initialised without `<body class="govuk-frontend-supported">` from template `<script>` snippet' : 'GOV.UK Frontend is not supported in this browser';
+      if (!isScope(scopeOrMessage)) {
+        supportMessage = 'GOV.UK Frontend initialised without `<script type="module">`';
+      }
+      super(typeof scopeOrMessage === 'string' ? scopeOrMessage : supportMessage);
       this.name = 'SupportError';
     }
   }
@@ -92,6 +98,7 @@
    * @import { ComponentWithModuleName } from '../common/index.mjs'
    */
 
+  const _self = typeof globalThis !== 'undefined' ? globalThis : self;
   class Component {
     /**
      * Returns the root element of the component
@@ -145,7 +152,7 @@
   /**
    * @typedef {typeof Component & ChildClass} ChildClassConstructor
    */
-  Component.elementType = HTMLElement;
+  Component.elementType = _self.HTMLElement;
 
   const configOverride = Symbol.for('configOverride');
   class ConfigurableComponent extends Component {
@@ -170,10 +177,14 @@
         throw new ConfigError(formatErrorMessage(childConstructor, 'Config passed as parameter into constructor but no defaults defined'));
       }
       const datasetConfig = normaliseDataset(childConstructor, this._$root.dataset);
-      this._config = mergeConfigs(childConstructor.defaults, config != null ? config : {}, this[configOverride](datasetConfig), datasetConfig);
+      this._config = mergeConfigs(childConstructor.defaults, config != null ? config : {});
+      this._config = mergeConfigs(this._config, this[configOverride](datasetConfig), datasetConfig);
     }
   }
   function normaliseString(value, property) {
+    if (property != null && property.type && !['string', 'number', 'boolean'].includes(property.type)) {
+      return;
+    }
     const trimmedValue = value ? value.trim() : '';
     let output;
     let outputType = property == null ? void 0 : property.type;

data/node_modules/govuk-frontend/dist/govuk/components/button/button.bundle.mjs

@@ -23,6 +23,9 @@ function isArray(option) {
 function isObject(option) {
   return !!option && typeof option === 'object' && !isArray(option);
 }
+function isScope($scope) {
+  return !!$scope && ($scope instanceof Element || $scope instanceof Document);
+}
 function formatErrorMessage(Component, message) {
   return `${Component.moduleName}: ${message}`;
 }
@@ -41,11 +44,14 @@ class SupportError extends GOVUKFrontendError {
   /**
    * Checks if GOV.UK Frontend is supported on this page
    *
-   * @param {HTMLElement | null} [$scope] - HTML element `<body>` checked for browser support
+   * @param {Element | Document | null | string} [scopeOrMessage] - HTML element `<body>` checked for browser support or support error message
    */
-  constructor($scope = document.body) {
-    const supportMessage = 'noModule' in HTMLScriptElement.prototype ? 'GOV.UK Frontend initialised without `<body class="govuk-frontend-supported">` from template `<script>` snippet' : 'GOV.UK Frontend is not supported in this browser';
-    super($scope ? supportMessage : 'GOV.UK Frontend initialised without `<script type="module">`');
+  constructor(scopeOrMessage = document.body) {
+    let supportMessage = 'noModule' in HTMLScriptElement.prototype ? 'GOV.UK Frontend initialised without `<body class="govuk-frontend-supported">` from template `<script>` snippet' : 'GOV.UK Frontend is not supported in this browser';
+    if (!isScope(scopeOrMessage)) {
+      supportMessage = 'GOV.UK Frontend initialised without `<script type="module">`';
+    }
+    super(typeof scopeOrMessage === 'string' ? scopeOrMessage : supportMessage);
     this.name = 'SupportError';
   }
 }
@@ -86,6 +92,7 @@ class InitError extends GOVUKFrontendError {
  * @import { ComponentWithModuleName } from '../common/index.mjs'
  */
 
+const _self = typeof globalThis !== 'undefined' ? globalThis : self;
 class Component {
   /**
    * Returns the root element of the component
@@ -139,7 +146,7 @@ class Component {
 /**
  * @typedef {typeof Component & ChildClass} ChildClassConstructor
  */
-Component.elementType = HTMLElement;
+Component.elementType = _self.HTMLElement;
 
 const configOverride = Symbol.for('configOverride');
 class ConfigurableComponent extends Component {
@@ -164,10 +171,14 @@ class ConfigurableComponent extends Component {
       throw new ConfigError(formatErrorMessage(childConstructor, 'Config passed as parameter into constructor but no defaults defined'));
     }
     const datasetConfig = normaliseDataset(childConstructor, this._$root.dataset);
-    this._config = mergeConfigs(childConstructor.defaults, config != null ? config : {}, this[configOverride](datasetConfig), datasetConfig);
+    this._config = mergeConfigs(childConstructor.defaults, config != null ? config : {});
+    this._config = mergeConfigs(this._config, this[configOverride](datasetConfig), datasetConfig);
   }
 }
 function normaliseString(value, property) {
+  if (property != null && property.type && !['string', 'number', 'boolean'].includes(property.type)) {
+    return;
+  }
   const trimmedValue = value ? value.trim() : '';
   let output;
   let outputType = property == null ? void 0 : property.type;

data/node_modules/govuk-frontend/dist/govuk/components/character-count/character-count.bundle.js

@@ -34,6 +34,9 @@
   function isObject(option) {
     return !!option && typeof option === 'object' && !isArray(option);
   }
+  function isScope($scope) {
+    return !!$scope && ($scope instanceof Element || $scope instanceof Document);
+  }
   function formatErrorMessage(Component, message) {
     return `${Component.moduleName}: ${message}`;
   }
@@ -52,11 +55,14 @@
     /**
      * Checks if GOV.UK Frontend is supported on this page
      *
-     * @param {HTMLElement | null} [$scope] - HTML element `<body>` checked for browser support
+     * @param {Element | Document | null | string} [scopeOrMessage] - HTML element `<body>` checked for browser support or support error message
      */
-    constructor($scope = document.body) {
-      const supportMessage = 'noModule' in HTMLScriptElement.prototype ? 'GOV.UK Frontend initialised without `<body class="govuk-frontend-supported">` from template `<script>` snippet' : 'GOV.UK Frontend is not supported in this browser';
-      super($scope ? supportMessage : 'GOV.UK Frontend initialised without `<script type="module">`');
+    constructor(scopeOrMessage = document.body) {
+      let supportMessage = 'noModule' in HTMLScriptElement.prototype ? 'GOV.UK Frontend initialised without `<body class="govuk-frontend-supported">` from template `<script>` snippet' : 'GOV.UK Frontend is not supported in this browser';
+      if (!isScope(scopeOrMessage)) {
+        supportMessage = 'GOV.UK Frontend initialised without `<script type="module">`';
+      }
+      super(typeof scopeOrMessage === 'string' ? scopeOrMessage : supportMessage);
       this.name = 'SupportError';
     }
   }
@@ -97,6 +103,7 @@
    * @import { ComponentWithModuleName } from '../common/index.mjs'
    */
 
+  const _self = typeof globalThis !== 'undefined' ? globalThis : self;
   class Component {
     /**
      * Returns the root element of the component
@@ -150,7 +157,7 @@
   /**
    * @typedef {typeof Component & ChildClass} ChildClassConstructor
    */
-  Component.elementType = HTMLElement;
+  Component.elementType = _self.HTMLElement;
 
   const configOverride = Symbol.for('configOverride');
   class ConfigurableComponent extends Component {
@@ -175,10 +182,14 @@
         throw new ConfigError(formatErrorMessage(childConstructor, 'Config passed as parameter into constructor but no defaults defined'));
       }
       const datasetConfig = normaliseDataset(childConstructor, this._$root.dataset);
-      this._config = mergeConfigs(childConstructor.defaults, config != null ? config : {}, this[configOverride](datasetConfig), datasetConfig);
+      this._config = mergeConfigs(childConstructor.defaults, config != null ? config : {});
+      this._config = mergeConfigs(this._config, this[configOverride](datasetConfig), datasetConfig);
     }
   }
   function normaliseString(value, property) {
+    if (property != null && property.type && !['string', 'number', 'boolean'].includes(property.type)) {
+      return;
+    }
     const trimmedValue = value ? value.trim() : '';
     let output;
     let outputType = property == null ? void 0 : property.type;
@@ -318,6 +329,17 @@
    * @import { CompatibleClass, Config, CreateAllOptions, OnErrorCallback } from '../init.mjs'
    */
 
+  function createElement(tagName, attributes = {}, children = []) {
+    const $element = document.createElement(tagName);
+    Object.entries(attributes).forEach(([name, value]) => {
+      $element.setAttribute(name, value);
+    });
+    for (const child of children) {
+      $element.append(child);
+    }
+    return $element;
+  }
+
   class I18n {
     constructor(translations = {}, config = {}) {
       var _config$locale;
@@ -408,6 +430,14 @@
           maxwords: undefined
         };
       }
+      if ('maxwords' in datasetConfig || this.config.maxwords !== undefined) {
+        console.warn(formatErrorMessage(CharacterCount, 'Option `maxwords` is deprecated. Use `maxlength` with `countType: "words"` instead.'));
+        if (!('maxlength' in datasetConfig)) {
+          var _datasetConfig$maxwor;
+          configOverrides.maxlength = (_datasetConfig$maxwor = datasetConfig.maxwords) != null ? _datasetConfig$maxwor : this.config.maxwords;
+          configOverrides.countType = 'words';
+        }
+      }
       return configOverrides;
     }
 
@@ -416,10 +446,11 @@
      * @param {CharacterCountConfig} [config] - Character count config
      */
     constructor($root, config = {}) {
-      var _ref, _this$config$maxwords;
+      var _this$config$maxlengt;
       super($root, config);
       this.$textarea = void 0;
       this.count = 0;
+      this.segmenter = null;
       this.$visibleCountMessage = void 0;
       this.$screenReaderCountMessage = void 0;
       this.lastInputTimestamp = null;
@@ -443,7 +474,15 @@
       this.i18n = new I18n(this.config.i18n, {
         locale: closestAttributeValue(this.$root, 'lang')
       });
-      this.maxLength = (_ref = (_this$config$maxwords = this.config.maxwords) != null ? _this$config$maxwords : this.config.maxlength) != null ? _ref : Infinity;
+      if (this.config.countType === 'characters' || this.config.countType === 'words' && this.config.maxwords === undefined) {
+        if (!('Segmenter' in Intl)) {
+          throw new SupportError(formatErrorMessage(CharacterCount, 'Support for "Intl.Segmenter" required'));
+        }
+        this.segmenter = new Intl.Segmenter(this.i18n.locale, {
+          granularity: this.config.countType === 'words' ? 'word' : 'grapheme'
+        });
+      }
+      this.maxLength = (_this$config$maxlengt = this.config.maxlength) != null ? _this$config$maxlengt : Infinity;
       this.$textarea = $textarea;
       const textareaDescriptionId = `${this.$textarea.id}-info`;
       const $textareaDescription = document.getElementById(textareaDescriptionId);
@@ -461,15 +500,16 @@
         });
       }
       this.$textarea.insertAdjacentElement('afterend', $textareaDescription);
-      const $screenReaderCountMessage = document.createElement('div');
-      $screenReaderCountMessage.className = 'govuk-character-count__sr-status govuk-visually-hidden';
-      $screenReaderCountMessage.setAttribute('aria-live', 'polite');
+      const $screenReaderCountMessage = createElement('div', {
+        class: 'govuk-character-count__sr-status govuk-visually-hidden',
+        'aria-live': 'polite'
+      });
       this.$screenReaderCountMessage = $screenReaderCountMessage;
       $textareaDescription.insertAdjacentElement('afterend', $screenReaderCountMessage);
-      const $visibleCountMessage = document.createElement('div');
-      $visibleCountMessage.className = $textareaDescription.className;
-      $visibleCountMessage.classList.add('govuk-character-count__status');
-      $visibleCountMessage.setAttribute('aria-hidden', 'true');
+      const $visibleCountMessage = createElement('div', {
+        class: `${$textareaDescription.className} govuk-character-count__status`,
+        'aria-hidden': 'true'
+      });
       this.$visibleCountMessage = $visibleCountMessage;
       $textareaDescription.insertAdjacentElement('afterend', $visibleCountMessage);
       $textareaDescription.classList.add('govuk-visually-hidden');
@@ -537,26 +577,38 @@
     }
     updateCount() {
       const text = this.$textarea.value;
-      if (this.config.maxwords) {
-        var _text$match;
-        const tokens = (_text$match = text.match(/\S+/g)) != null ? _text$match : [];
-        this.count = tokens.length;
+      if (this.config.countType === 'characters') {
+        this.count = this.segmenter ? Array.from(this.segmenter.segment(text)).length : 0;
+        return;
+      }
+      if (this.config.countType === 'words') {
+        if (this.config.maxwords !== undefined) {
+          var _text$match$length, _text$match;
+          this.count = (_text$match$length = (_text$match = text.match(/\S+/g)) == null ? void 0 : _text$match.length) != null ? _text$match$length : 0;
+          return;
+        }
+        const segments = this.segmenter ? Array.from(this.segmenter.segment(text)) : [];
+        this.count = segments.filter(segment => segment.isWordLike).length;
         return;
       }
       this.count = text.length;
     }
     getCountMessage() {
       const remainingNumber = this.maxLength - this.count;
-      const countType = this.config.maxwords ? 'words' : 'characters';
-      return this.formatCountMessage(remainingNumber, countType);
+      return this.formatCountMessage(remainingNumber);
     }
     formatCountMessage(remainingNumber, countType) {
+      countType = countType != null ? countType : this.config.countType;
+      let translationKeyPrefix = 'characters';
+      let translationKeySuffix = remainingNumber < 0 ? 'OverLimit' : 'UnderLimit';
+      if (countType === 'words') {
+        translationKeyPrefix = 'words';
+      }
       if (remainingNumber === 0) {
-        return this.i18n.t(`${countType}AtLimit`);
+        translationKeySuffix = 'AtLimit';
       }
-      const translationKeySuffix = remainingNumber < 0 ? 'OverLimit' : 'UnderLimit';
-      return this.i18n.t(`${countType}${translationKeySuffix}`, {
-        count: Math.abs(remainingNumber)
+      return this.i18n.t(`${translationKeyPrefix}${translationKeySuffix}`, {
+        count: remainingNumber === 0 ? undefined : Math.abs(remainingNumber)
       });
     }
     isOverThreshold() {
@@ -575,13 +627,15 @@
    *
    * @see {@link CharacterCount.defaults}
    * @typedef {object} CharacterCountConfig
-   * @property {number} [maxlength] - The maximum number of characters.
-   *   If maxwords is provided, the maxlength option will be ignored.
-   * @property {number} [maxwords] - The maximum number of words. If maxwords is
-   *   provided, the maxlength option will be ignored.
+   * @property {number} [maxlength] - The maximum number of characters (or words
+   *   if `countType` is set to `"words"`).
+   * @property {number} [maxwords] - Deprecated. Use `maxlength` and
+   *   `countType: "words"` instead.
    * @property {number} [threshold=0] - The percentage value of the limit at
    *   which point the count message is displayed. If this attribute is set, the
    *   count message will be hidden by default.
+   * @property {'characters' | 'length' | 'words'} [countType] - The count type
+   *   (`"characters"`, `"length"` or `"words"`) used to count the text.
    * @property {CharacterCountTranslations} [i18n=CharacterCount.defaults.i18n] - Character count translations
    */
 
@@ -627,9 +681,9 @@
    * @property {TranslationPluralForms} [textareaDescription] - Message made
    *   available to assistive technologies, if none is already present in the
    *   HTML, to describe that the component accepts only a limited amount of
-   *   content. It is visible on the page when JavaScript is unavailable. The
-   *   component will replace the `%{count}` placeholder with the value of the
-   *   `maxlength` or `maxwords` parameter.
+   *   content. It is visible on the page if `countType` is not supported or
+   *   JavaScript is unavailable. The component will replace the `%{count}`
+   *   placeholder with the value of the `maxlength` parameter.
    */
 
   /**
@@ -639,6 +693,7 @@
   CharacterCount.moduleName = 'govuk-character-count';
   CharacterCount.defaults = Object.freeze({
     threshold: 0,
+    countType: 'length',
     i18n: {
       charactersUnderLimit: {
         one: 'You have %{count} character remaining',
@@ -676,6 +731,9 @@
       },
       threshold: {
         type: 'number'
+      },
+      countType: {
+        type: 'string'
       }
     },
     anyOf: [{