govuk_tech_docs 3.4.5 → 4.0.0

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

@@ -0,0 +1,349 @@
+import { mergeConfigs } from '../../common/index.mjs';
+import { normaliseDataset } from '../../common/normalise-dataset.mjs';
+import { ElementError } from '../../errors/index.mjs';
+import { GOVUKFrontendComponent } from '../../govuk-frontend-component.mjs';
+import { I18n } from '../../i18n.mjs';
+
+/**
+ * Accordion component
+ *
+ * This allows a collection of sections to be collapsed by default, showing only
+ * their headers. Sections can be expanded or collapsed individually by clicking
+ * their headers. A "Show all sections" button is also added to the top of the
+ * accordion, which switches to "Hide all sections" when all the sections are
+ * expanded.
+ *
+ * The state of each section is saved to the DOM via the `aria-expanded`
+ * attribute, which also provides accessibility.
+ *
+ * @preserve
+ */
+class Accordion extends GOVUKFrontendComponent {
+  /**
+   * @param {Element | null} $root - HTML element to use for accordion
+   * @param {AccordionConfig} [config] - Accordion config
+   */
+  constructor($root, config = {}) {
+    super($root);
+    this.config = void 0;
+    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.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.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;
+    this.$showAllIcon = null;
+    this.$showAllText = null;
+    this.config = mergeConfigs(Accordion.defaults, config, normaliseDataset(Accordion, this.$root.dataset));
+    this.i18n = new I18n(this.config.i18n);
+    const $sections = this.$root.querySelectorAll(`.${this.sectionClass}`);
+    if (!$sections.length) {
+      throw new ElementError({
+        component: Accordion,
+        identifier: `Sections (\`<div class="${this.sectionClass}">\`)`
+      });
+    }
+    this.$sections = $sections;
+    this.initControls();
+    this.initSectionHeaders();
+    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.appendChild(this.$showAllIcon);
+    const $accordionControls = document.createElement('div');
+    $accordionControls.setAttribute('class', this.controlsClass);
+    $accordionControls.appendChild(this.$showAllButton);
+    this.$root.insertBefore($accordionControls, this.$root.firstChild);
+    this.$showAllText = document.createElement('span');
+    this.$showAllText.classList.add(this.showAllTextClass);
+    this.$showAllButton.appendChild(this.$showAllText);
+    this.$showAllButton.addEventListener('click', () => this.onShowOrHideAllToggle());
+    if ('onbeforematch' in document) {
+      document.addEventListener('beforematch', event => this.onBeforeMatch(event));
+    }
+  }
+  initSectionHeaders() {
+    this.$sections.forEach(($section, i) => {
+      const $header = $section.querySelector(`.${this.sectionHeaderClass}`);
+      if (!$header) {
+        throw new ElementError({
+          component: Accordion,
+          identifier: `Section headers (\`<div class="${this.sectionHeaderClass}">\`)`
+        });
+      }
+      this.constructHeaderMarkup($header, i);
+      this.setExpanded(this.isExpanded($section), $section);
+      $header.addEventListener('click', () => this.onSectionToggle($section));
+      this.setInitialState($section);
+    });
+  }
+  constructHeaderMarkup($header, index) {
+    const $span = $header.querySelector(`.${this.sectionButtonClass}`);
+    const $heading = $header.querySelector(`.${this.sectionHeadingClass}`);
+    const $summary = $header.querySelector(`.${this.sectionSummaryClass}`);
+    if (!$heading) {
+      throw new ElementError({
+        component: Accordion,
+        identifier: `Section heading (\`.${this.sectionHeadingClass}\`)`
+      });
+    }
+    if (!$span) {
+      throw new ElementError({
+        component: Accordion,
+        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}`);
+    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);
+    $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);
+    $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);
+    $button.appendChild($headingText);
+    $button.appendChild(this.getButtonPunctuationEl());
+    if ($summary) {
+      const $summarySpan = document.createElement('span');
+      const $summarySpanFocus = document.createElement('span');
+      $summarySpanFocus.classList.add(this.sectionSummaryFocusClass);
+      $summarySpan.appendChild($summarySpanFocus);
+      for (const attr of Array.from($summary.attributes)) {
+        $summarySpan.setAttribute(attr.name, attr.value);
+      }
+      Array.from($summary.childNodes).forEach($child => $summarySpanFocus.appendChild($child));
+      $summary.remove();
+      $button.appendChild($summarySpan);
+      $button.appendChild(this.getButtonPunctuationEl());
+    }
+    $button.appendChild($showHideToggle);
+    $heading.removeChild($span);
+    $heading.appendChild($button);
+  }
+  onBeforeMatch(event) {
+    const $fragment = event.target;
+    if (!($fragment instanceof Element)) {
+      return;
+    }
+    const $section = $fragment.closest(`.${this.sectionClass}`);
+    if ($section) {
+      this.setExpanded(true, $section);
+    }
+  }
+  onSectionToggle($section) {
+    const nowExpanded = !this.isExpanded($section);
+    this.setExpanded(nowExpanded, $section);
+    this.storeState($section, nowExpanded);
+  }
+  onShowOrHideAllToggle() {
+    const nowExpanded = !this.areAllSectionsOpen();
+    this.$sections.forEach($section => {
+      this.setExpanded(nowExpanded, $section);
+      this.storeState($section, nowExpanded);
+    });
+    this.updateShowAllButton(nowExpanded);
+  }
+  setExpanded(expanded, $section) {
+    const $showHideIcon = $section.querySelector(`.${this.upChevronIconClass}`);
+    const $showHideText = $section.querySelector(`.${this.sectionShowHideTextClass}`);
+    const $button = $section.querySelector(`.${this.sectionButtonClass}`);
+    const $content = $section.querySelector(`.${this.sectionContentClass}`);
+    if (!$content) {
+      throw new ElementError({
+        component: Accordion,
+        identifier: `Section content (\`<div class="${this.sectionContentClass}">\`)`
+      });
+    }
+    if (!$showHideIcon || !$showHideText || !$button) {
+      return;
+    }
+    const newButtonText = expanded ? this.i18n.t('hideSection') : this.i18n.t('showSection');
+    $showHideText.textContent = newButtonText;
+    $button.setAttribute('aria-expanded', `${expanded}`);
+    const ariaLabelParts = [];
+    const $headingText = $section.querySelector(`.${this.sectionHeadingTextClass}`);
+    if ($headingText) {
+      ariaLabelParts.push(`${$headingText.textContent}`.trim());
+    }
+    const $summary = $section.querySelector(`.${this.sectionSummaryClass}`);
+    if ($summary) {
+      ariaLabelParts.push(`${$summary.textContent}`.trim());
+    }
+    const ariaLabelMessage = expanded ? this.i18n.t('hideSectionAriaLabel') : this.i18n.t('showSectionAriaLabel');
+    ariaLabelParts.push(ariaLabelMessage);
+    $button.setAttribute('aria-label', ariaLabelParts.join(' , '));
+    if (expanded) {
+      $content.removeAttribute('hidden');
+      $section.classList.add(this.sectionExpandedClass);
+      $showHideIcon.classList.remove(this.downChevronIconClass);
+    } else {
+      $content.setAttribute('hidden', 'until-found');
+      $section.classList.remove(this.sectionExpandedClass);
+      $showHideIcon.classList.add(this.downChevronIconClass);
+    }
+    this.updateShowAllButton(this.areAllSectionsOpen());
+  }
+  isExpanded($section) {
+    return $section.classList.contains(this.sectionExpandedClass);
+  }
+  areAllSectionsOpen() {
+    return Array.from(this.$sections).every($section => this.isExpanded($section));
+  }
+  updateShowAllButton(expanded) {
+    if (!this.$showAllButton || !this.$showAllText || !this.$showAllIcon) {
+      return;
+    }
+    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);
+  }
+
+  /**
+   * Get the identifier for a section
+   *
+   * We need a unique way of identifying each content in the Accordion.
+   * Since an `#id` should be unique and an `id` is required for `aria-`
+   * attributes `id` can be safely used.
+   *
+   * @param {Element} $section - Section element
+   * @returns {string | undefined | null} Identifier for section
+   */
+  getIdentifier($section) {
+    const $button = $section.querySelector(`.${this.sectionButtonClass}`);
+    return $button == null ? void 0 : $button.getAttribute('aria-controls');
+  }
+  storeState($section, isExpanded) {
+    if (!this.config.rememberExpanded) {
+      return;
+    }
+    const id = this.getIdentifier($section);
+    if (id) {
+      try {
+        window.sessionStorage.setItem(id, isExpanded.toString());
+      } catch (exception) {}
+    }
+  }
+  setInitialState($section) {
+    if (!this.config.rememberExpanded) {
+      return;
+    }
+    const id = this.getIdentifier($section);
+    if (id) {
+      try {
+        const state = window.sessionStorage.getItem(id);
+        if (state !== null) {
+          this.setExpanded(state === 'true', $section);
+        }
+      } catch (exception) {}
+    }
+  }
+  getButtonPunctuationEl() {
+    const $punctuationEl = document.createElement('span');
+    $punctuationEl.classList.add('govuk-visually-hidden', this.sectionHeadingDividerClass);
+    $punctuationEl.textContent = ', ';
+    return $punctuationEl;
+  }
+}
+
+/**
+ * Accordion config
+ *
+ * @see {@link Accordion.defaults}
+ * @typedef {object} AccordionConfig
+ * @property {AccordionTranslations} [i18n=Accordion.defaults.i18n] - Accordion translations
+ * @property {boolean} [rememberExpanded] - Whether the expanded and collapsed
+ *   state of each section is remembered and restored when navigating.
+ */
+
+/**
+ * Accordion translations
+ *
+ * @see {@link Accordion.defaults.i18n}
+ * @typedef {object} AccordionTranslations
+ *
+ * Messages used by the component for the labels of its buttons. This includes
+ * the visible text shown on screen, and text to help assistive technology users
+ * for the buttons toggling each section.
+ * @property {string} [hideAllSections] - The text content for the 'Hide all
+ *   sections' button, used when at least one section is expanded.
+ * @property {string} [hideSection] - The text content for the 'Hide'
+ *   button, used when a section is expanded.
+ * @property {string} [hideSectionAriaLabel] - The text content appended to the
+ *   'Hide' button's accessible name when a section is expanded.
+ * @property {string} [showAllSections] - The text content for the 'Show all
+ *   sections' button, used when all sections are collapsed.
+ * @property {string} [showSection] - The text content for the 'Show'
+ *   button, used when a section is collapsed.
+ * @property {string} [showSectionAriaLabel] - The text content appended to the
+ *   'Show' button's accessible name when a section is expanded.
+ */
+
+/**
+ * @typedef {import('../../common/index.mjs').Schema} Schema
+ */
+Accordion.moduleName = 'govuk-accordion';
+Accordion.defaults = Object.freeze({
+  i18n: {
+    hideAllSections: 'Hide all sections',
+    hideSection: 'Hide',
+    hideSectionAriaLabel: 'Hide this section',
+    showAllSections: 'Show all sections',
+    showSection: 'Show',
+    showSectionAriaLabel: 'Show this section'
+  },
+  rememberExpanded: true
+});
+Accordion.schema = Object.freeze({
+  properties: {
+    i18n: {
+      type: 'object'
+    },
+    rememberExpanded: {
+      type: 'boolean'
+    }
+  }
+});
+
+export { Accordion };
+//# sourceMappingURL=accordion.mjs.map

data/node_modules/govuk-frontend/dist/govuk/components/back-link/_back-link.scss

@@ -0,0 +1,4 @@
+@import "../../base";
+@import "./index";
+
+/*# sourceMappingURL=_back-link.scss.map */

data/node_modules/govuk-frontend/{govuk → dist/govuk}/components/back-link/_index.scss

@@ -13,7 +13,7 @@
   $chevron-border-colour: $govuk-secondary-text-colour;
 
   .govuk-back-link {
-    @include govuk-typography-responsive($size: $font-size);
+    @include govuk-font-size($size: $font-size);
     @include govuk-link-common;
     @include govuk-link-style-text;
 
@@ -28,24 +28,14 @@
   }
 
   // Prepend left pointing chevron
-  .govuk-back-link:before {
+  .govuk-back-link::before {
     content: "";
     display: block;
 
     // Vertically align with the parent element
     position: absolute;
-
-    @if $govuk-use-legacy-font {
-      // Begin adjustments for font baseline offset
-      // These should be removed when legacy font support is dropped
-      $offset: govuk-em(1px, $font-size);
-      top: $offset * -1;
-      bottom: $offset;
-    } @else {
-      top: 0;
-      bottom: 0;
-    }
-
+    top: 0;
+    bottom: 0;
     left: govuk-em(3px, $font-size);
 
     width: $chevron-size;
@@ -53,42 +43,26 @@
 
     margin: auto 0;
 
-    -webkit-transform: rotate(225deg);
-
-        -ms-transform: rotate(225deg);
-
-            transform: rotate(225deg);
+    transform: rotate(225deg);
 
     border: solid;
     border-width: $chevron-border-min-width $chevron-border-min-width 0 0;
     border-color: $chevron-border-colour;
 
     @supports (border-width: unquote("max(0px)")) {
-      border-width: unquote("max(#{$chevron-border-min-width}, #{$chevron-border-width}) max(#{$chevron-border-min-width}, #{$chevron-border-width})") 0 0;
+      $border-width-eval: "max(#{$chevron-border-min-width}, #{$chevron-border-width})";
 
       // Ensure that the chevron never gets smaller than 16px
+      border-width: unquote($border-width-eval) unquote($border-width-eval) 0 0;
       font-size: unquote("max(#{$font-size * 1px}, 1em)");
     }
-
-    // Fall back to a less than sign for IE8
-    @include _govuk-if-ie8 {
-      content: "\003c"; // Less than sign (<)
-      width: auto;
-      height: auto;
-      border: 0;
-      color: $chevron-border-colour;
-
-      // IE8 doesn't seem to like rendering pseudo-elements using @font-faces,
-      // so fall back to using another sans-serif font to render the chevron.
-      font-family: Arial, sans-serif;
-    }
   }
 
-  .govuk-back-link:focus:before {
+  .govuk-back-link:focus::before {
     border-color: $govuk-focus-text-colour;
   }
 
-  .govuk-back-link:after {
+  .govuk-back-link::after {
     content: "";
     position: absolute;
     top: -14px;
@@ -100,8 +74,10 @@
   .govuk-back-link--inverse {
     @include govuk-link-style-inverse;
 
-    &:before {
+    &::before {
       border-color: currentcolor;
     }
   }
 }
+
+/*# sourceMappingURL=_index.scss.map */

data/node_modules/govuk-frontend/dist/govuk/components/breadcrumbs/_breadcrumbs.scss

@@ -0,0 +1,4 @@
+@import "../../base";
+@import "./index";
+
+/*# sourceMappingURL=_breadcrumbs.scss.map */

data/node_modules/govuk-frontend/{govuk → dist/govuk}/components/breadcrumbs/_index.scss

@@ -35,7 +35,6 @@
   }
 
   .govuk-breadcrumbs__list-item {
-
     display: inline-block;
     position: relative;
 
@@ -49,22 +48,13 @@
     float: left;
 
     // Create a chevron using a box with borders on two sides, rotated 45deg.
-    &:before {
+    &::before {
       content: "";
       display: block;
 
       position: absolute;
-
-      @if $govuk-use-legacy-font {
-        // Begin adjustments for font baseline offset
-        // These should be removed when legacy font support is dropped
-        $offset: govuk-em(1px, $font-size);
-        top: $offset * -1;
-        bottom: $offset;
-      } @else {
-        top: 0;
-        bottom: 0;
-      }
+      top: 0;
+      bottom: 0;
 
       // Offset by the difference between the width of the non-rotated square
       // and its width when rotated
@@ -75,42 +65,26 @@
 
       margin: auto 0;
 
-      -webkit-transform: rotate(45deg);
-
-          -ms-transform: rotate(45deg);
-
-              transform: rotate(45deg);
+      transform: rotate(45deg);
 
       border: solid;
       border-width: $chevron-border-min-width $chevron-border-min-width 0 0;
       border-color: $chevron-border-colour;
 
       @supports (border-width: unquote("max(0px)")) {
-        border-width: unquote("max(#{$chevron-border-min-width}, #{$chevron-border-width}) max(#{$chevron-border-min-width}, #{$chevron-border-width})") 0 0;
+        $border-width-eval: "max(#{$chevron-border-min-width}, #{$chevron-border-width})";
 
         // Ensure that the chevron never gets smaller than 16px
+        border-width: unquote($border-width-eval) unquote($border-width-eval) 0 0;
         font-size: unquote("max(#{$font-size * 1px}, 1em)");
       }
-
-      // Fall back to a greater than sign for IE8
-      @include _govuk-if-ie8 {
-        content: "\003e"; // Greater than sign (>)
-        width: auto;
-        height: auto;
-        border: 0;
-        color: $chevron-border-colour;
-
-        // IE8 doesn't seem to like rendering pseudo-elements using @font-faces,
-        // so fall back to using another sans-serif font to render the chevron.
-        font-family: Arial, sans-serif;
-      }
     }
 
     &:first-child {
       margin-left: 0;
       padding-left: 0;
 
-      &:before {
+      &::before {
         content: none;
         display: none;
       }
@@ -132,14 +106,13 @@
           display: inline-block;
         }
 
-        &:before {
+        &::before {
           top: govuk-em(6px, $font-size);
           margin: 0;
         }
       }
 
       .govuk-breadcrumbs__list {
-        display: -ms-flexbox;
         display: flex;
       }
     }
@@ -152,8 +125,10 @@
       @include govuk-link-style-inverse;
     }
 
-    .govuk-breadcrumbs__list-item:before {
+    .govuk-breadcrumbs__list-item::before {
       border-color: currentcolor;
     }
   }
 }
+
+/*# sourceMappingURL=_index.scss.map */

data/node_modules/govuk-frontend/dist/govuk/components/button/_button.scss

@@ -0,0 +1,4 @@
+@import "../../base";
+@import "./index";
+
+/*# sourceMappingURL=_button.scss.map */