@ministryofjustice/frontend 2.2.4 → 3.0.0

package/moj/all.js

@@ -133,6 +133,12 @@ MOJFrontend.initAll = function (options) {
   MOJFrontend.nodeListForEach($datepickers, function ($datepicker) {
     new MOJFrontend.DatePicker($datepicker, {}).init();
   })
+
+  const $buttonMenus = scope.querySelectorAll('[data-module="moj-button-menu"]')
+  MOJFrontend.nodeListForEach($buttonMenus, function ($buttonmenu) {
+    new MOJFrontend.ButtonMenu($buttonmenu, {}).init();
+  })
+
 }
 
 MOJFrontend.AddAnother = function(container) {
@@ -219,162 +225,331 @@ MOJFrontend.AddAnother.prototype.focusHeading = function() {
 	this.container.find('.moj-add-another__heading').focus();
 };
 
-MOJFrontend.ButtonMenu = function(params) {
-	this.container = $(params.container);
-	this.menu = this.container.find('.moj-button-menu__wrapper');
-	if(params.menuClasses) {
-		this.menu.addClass(params.menuClasses);
-	}
-	this.menu.attr('role', 'menu');
-	this.mq = params.mq;
-	this.buttonText = params.buttonText;
-	this.buttonClasses = params.buttonClasses || '';
-	this.keys = { esc: 27, up: 38, down: 40, tab: 9 };
-	this.menu.on('keydown', '[role=menuitem]', $.proxy(this, 'onButtonKeydown'));
-	this.createToggleButton();
-	this.setupResponsiveChecks();
-	$(document).on('click', $.proxy(this, 'onDocumentClick'));
-};
+/**
+ * @typedef {object} ButtonMenuConfig
+ * @property {string} [buttonText=Actions] - Label for the toggle button
+ * @property {"left" | "right"} [alignMenu=left] - the alignment of the menu
+ * @property {string} [buttonClasses=govuk-button--secondary] - css classes applied to the toggle button
+ */
 
-MOJFrontend.ButtonMenu.prototype.onDocumentClick = function(e) {
-	if(!$.contains(this.container[0], e.target)) {
-	  this.hideMenu();
+/**
+ * @param {HTMLElement} $module
+ * @param {ButtonMenuConfig} config
+ * @constructor
+ */
+MOJFrontend.ButtonMenu = function ($module, config = {}) {
+  if (!$module) {
+    return this;
   }
-};
 
-MOJFrontend.ButtonMenu.prototype.createToggleButton = function() {
-	this.menuButton = $('<button class="govuk-button moj-button-menu__toggle-button ' + this.buttonClasses + '" type="button" aria-haspopup="true" aria-expanded="false">'+this.buttonText+'</button>');
-	this.menuButton.on('click', $.proxy(this, 'onMenuButtonClick'));
-	this.menuButton.on('keydown', $.proxy(this, 'onMenuKeyDown'));
+  const schema = Object.freeze({
+    properties: {
+      buttonText: { type: "string" },
+      buttonClasses: { type: "string" },
+      alignMenu: { type: "string" },
+    },
+  });
+
+  const defaults = {
+    buttonText: "Actions",
+    alignMenu: "left",
+    buttonClasses: "",
+  };
+  // data attributes override JS config, which overrides defaults
+  this.config = this.mergeConfigs(
+    defaults,
+    config,
+    this.parseDataset(schema, $module.dataset),
+  );
+
+  this.$module = $module;
 };
 
-MOJFrontend.ButtonMenu.prototype.setupResponsiveChecks = function() {
-	this.mql = window.matchMedia(this.mq);
-	this.mql.addListener($.proxy(this, 'checkMode'));
-	this.checkMode(this.mql);
+MOJFrontend.ButtonMenu.prototype.init = function () {
+  // If only one button is provided, don't initiate a menu and toggle button
+  // if classes have been provided for the toggleButton, apply them to the single item
+  if (this.$module.children.length == 1) {
+    const button = this.$module.children[0];
+    button.classList.forEach((className) => {
+      if (className.startsWith("govuk-button-")) {
+        button.classList.remove(className);
+      }
+      button.classList.remove("moj-button-menu__item")
+    });
+    if (this.config.buttonClasses) {
+      button.classList.add(...this.config.buttonClasses.split(" "));
+    }
+  }
+  // Otherwise intialise a button menu
+  if (this.$module.children.length > 1) {
+    this.initMenu();
+  }
 };
 
-MOJFrontend.ButtonMenu.prototype.checkMode = function(mql) {
-	if(mql.matches) {
-		this.enableBigMode();
-	} else {
-		this.enableSmallMode();
-	}
+MOJFrontend.ButtonMenu.prototype.initMenu = function () {
+  this.$menu = this.createMenu();
+  this.$module.insertAdjacentHTML("afterbegin", this.toggleTemplate());
+  this.setupMenuItems();
+
+  this.$menuToggle = this.$module.querySelector(":scope > button");
+  this.items = this.$menu.querySelectorAll("a, button");
+
+  this.$menuToggle.addEventListener("click", (event) => {
+    this.toggleMenu(event);
+  });
+
+  this.$module.addEventListener("keydown", (event) => {
+    this.handleKeyDown(event);
+  });
+
+  document.addEventListener("click", (event) => {
+    if (!this.$module.contains(event.target)) {
+      this.closeMenu(false);
+    }
+  });
 };
 
-MOJFrontend.ButtonMenu.prototype.enableSmallMode = function() {
-	this.container.prepend(this.menuButton);
-	this.hideMenu();
-	this.removeButtonClasses();
-	this.menu.attr('role', 'menu');
-	this.container.find('.moj-button-menu__item').attr('role', 'menuitem');
+MOJFrontend.ButtonMenu.prototype.createMenu = function () {
+  const $menu = document.createElement("ul");
+  $menu.setAttribute("role", "list");
+  $menu.hidden = true;
+  $menu.classList.add("moj-button-menu__wrapper");
+  if (this.config.alignMenu == "right") {
+    $menu.classList.add("moj-button-menu__wrapper--right");
+  }
+
+  this.$module.appendChild($menu);
+  while (this.$module.firstChild !== $menu) {
+    $menu.appendChild(this.$module.firstChild);
+  }
+
+  return $menu;
 };
 
-MOJFrontend.ButtonMenu.prototype.enableBigMode = function() {
-	this.menuButton.detach();
-	this.showMenu();
-	this.addButtonClasses();
-	this.menu.removeAttr('role');
-	this.container.find('.moj-button-menu__item').removeAttr('role');
+MOJFrontend.ButtonMenu.prototype.setupMenuItems = function () {
+  Array.from(this.$menu.children).forEach((item) => {
+    // wrap item in li tag
+    const listItem = document.createElement("li");
+    this.$menu.insertBefore(listItem, item);
+    listItem.appendChild(item);
+
+    item.setAttribute("tabindex", -1);
+
+    if (item.tagName == "BUTTON") {
+      item.setAttribute("type", "button");
+    }
+
+    item.classList.forEach((className) => {
+      if (className.startsWith("govuk-button")) {
+        item.classList.remove(className);
+      }
+    });
+
+    // add a slight delay after click before closing the menu, makes it *feel* better
+    item.addEventListener("click", (event) => {
+      setTimeout(() => {
+        this.closeMenu(false);
+      }, 50);
+    });
+  });
 };
 
-MOJFrontend.ButtonMenu.prototype.removeButtonClasses = function() {
-	this.menu.find('.moj-button-menu__item').each(function(index, el) {
-		if($(el).hasClass('govuk-button--secondary')) {
-			$(el).attr('data-secondary', 'true');
-			$(el).removeClass('govuk-button--secondary');
-		}
-		if($(el).hasClass('govuk-button--warning')) {
-			$(el).attr('data-warning', 'true');
-			$(el).removeClass('govuk-button--warning');
-		}
-		$(el).removeClass('govuk-button');
-	});
+MOJFrontend.ButtonMenu.prototype.toggleTemplate = function () {
+  return `
+    <button type="button" class="govuk-button moj-button-menu__toggle-button ${this.config.buttonClasses || ""}" aria-haspopup="true" aria-expanded="false">
+      <span>
+       ${this.config.buttonText}
+       <svg width="11" height="5" viewBox="0 0 11 5"  xmlns="http://www.w3.org/2000/svg">
+         <path d="M5.5 0L11 5L0 5L5.5 0Z" fill="currentColor"/>
+       </svg>
+      </span>
+    </button>`;
 };
 
-MOJFrontend.ButtonMenu.prototype.addButtonClasses = function() {
-	this.menu.find('.moj-button-menu__item').each(function(index, el) {
-		if($(el).attr('data-secondary') == 'true') {
-			$(el).addClass('govuk-button--secondary');
-		}
-		if($(el).attr('data-warning') == 'true') {
-			$(el).addClass('govuk-button--warning');
-		}
-		$(el).addClass('govuk-button');
-	});
+/**
+ * @returns {boolean}
+ */
+MOJFrontend.ButtonMenu.prototype.isOpen = function () {
+  return this.$menuToggle.getAttribute("aria-expanded") === "true";
 };
 
-MOJFrontend.ButtonMenu.prototype.hideMenu = function() {
-	this.menuButton.attr('aria-expanded', 'false');
+MOJFrontend.ButtonMenu.prototype.toggleMenu = function (event) {
+  event.preventDefault();
+
+  // If menu is triggered with mouse don't move focus to first item
+  const keyboardEvent = event.detail == 0;
+  const focusIndex = keyboardEvent ? 0 : -1;
+
+  if (this.isOpen()) {
+    this.closeMenu();
+  } else {
+    this.openMenu(focusIndex);
+  }
 };
 
-MOJFrontend.ButtonMenu.prototype.showMenu = function() {
-	this.menuButton.attr('aria-expanded', 'true');
+/**
+ * Opens the menu and optionally sets the focus to the item with given index
+ *
+ * @param {number} focusIndex - The index of the item to focus
+ */
+MOJFrontend.ButtonMenu.prototype.openMenu = function (focusIndex = 0) {
+  this.$menu.hidden = false;
+  this.$menuToggle.setAttribute("aria-expanded", "true");
+  if (focusIndex !== -1) {
+    this.focusItem(focusIndex);
+  }
 };
 
-MOJFrontend.ButtonMenu.prototype.onMenuButtonClick = function() {
-	this.toggle();
+/**
+ * Closes the menu and optionally returns focus back to menuToggle
+ *
+ * @param {boolean} moveFocus - whether to return focus to the toggle button
+ */
+MOJFrontend.ButtonMenu.prototype.closeMenu = function (moveFocus = true) {
+  this.$menu.hidden = true;
+  this.$menuToggle.setAttribute("aria-expanded", "false");
+  if (moveFocus) {
+    this.$menuToggle.focus();
+  }
 };
 
-MOJFrontend.ButtonMenu.prototype.toggle = function() {
-	if(this.menuButton.attr('aria-expanded') == 'false') {
-		this.showMenu();
-		this.menu.find('[role=menuitem]').first().focus();
-	} else {
-		this.hideMenu();
-		this.menuButton.focus();
-	}
+/**
+ * Focuses the menu item at the specified index
+ *
+ * @param {number} index - the index of the item to focus
+ */
+MOJFrontend.ButtonMenu.prototype.focusItem = function (index) {
+  if (index >= this.items.length) index = 0;
+  if (index < 0) index = this.items.length - 1;
+
+  this.items.item(index)?.focus();
 };
 
-MOJFrontend.ButtonMenu.prototype.onMenuKeyDown = function(e) {
-	switch (e.keyCode) {
-		case this.keys.down:
-			this.toggle();
-			break;
-	}
+MOJFrontend.ButtonMenu.prototype.currentFocusIndex = function () {
+  const activeElement = document.activeElement;
+  const menuItems = Array.from(this.items);
+
+  return menuItems.indexOf(activeElement);
 };
 
-MOJFrontend.ButtonMenu.prototype.onButtonKeydown = function(e) {
-	switch (e.keyCode) {
-		case this.keys.up:
-			e.preventDefault();
-			this.focusPrevious(e.currentTarget);
-			break;
-		case this.keys.down:
-			e.preventDefault();
-			this.focusNext(e.currentTarget);
-			break;
-		case this.keys.esc:
-			if(!this.mql.matches) {
-				this.menuButton.focus();
-				this.hideMenu();
-			}
-			break;
-		case this.keys.tab:
-			if(!this.mql.matches) {
-				this.hideMenu();
-			}
-	}
+MOJFrontend.ButtonMenu.prototype.handleKeyDown = function (event) {
+  if (event.target == this.$menuToggle) {
+    switch (event.key) {
+      case "ArrowDown":
+        event.preventDefault();
+        this.openMenu();
+        break;
+      case "ArrowUp":
+        event.preventDefault();
+        this.openMenu(this.items.length - 1);
+        break;
+    }
+  }
+
+  if (this.$menu.contains(event.target) && this.isOpen()) {
+    switch (event.key) {
+      case "ArrowDown":
+        event.preventDefault();
+        if (this.currentFocusIndex() !== -1) {
+          this.focusItem(this.currentFocusIndex() + 1);
+        }
+        break;
+      case "ArrowUp":
+        event.preventDefault();
+        if (this.currentFocusIndex() !== -1) {
+          this.focusItem(this.currentFocusIndex() - 1);
+        }
+        break;
+      case "Home":
+        event.preventDefault();
+        this.focusItem(0);
+        break;
+      case "End":
+        event.preventDefault();
+        this.focusItem(this.items.length - 1);
+        break;
+    }
+  }
+
+  if (event.key == "Escape" && this.isOpen()) {
+    this.closeMenu();
+  }
+  if (event.key == "Tab" && this.isOpen()) {
+    this.closeMenu(false);
+  }
 };
 
-MOJFrontend.ButtonMenu.prototype.focusNext = function(currentButton) {
-	var next = $(currentButton).next();
-	if(next[0]) {
-		next.focus();
-	} else {
-		this.container.find('[role=menuitem]').first().focus();
-	}
+/**
+ * Parse dataset
+ *
+ * Loop over an object and normalise each value using {@link normaliseString},
+ * optionally expanding nested `i18n.field`
+ *
+ * @param {{ schema: Schema }} Component - Component class
+ * @param {DOMStringMap} dataset - HTML element dataset
+ * @returns {Object} Normalised dataset
+ */
+MOJFrontend.ButtonMenu.prototype.parseDataset = function (schema, dataset) {
+  const parsed = {};
+
+  for (const [field, attributes] of Object.entries(schema.properties)) {
+    if (field in dataset) {
+      if (dataset[field]) {
+        parsed[field] = dataset[field];
+      }
+    }
+  }
+
+  return parsed;
 };
 
-MOJFrontend.ButtonMenu.prototype.focusPrevious = function(currentButton) {
-	var prev = $(currentButton).prev();
-	if(prev[0]) {
-		prev.focus();
-	} else {
-		this.container.find('[role=menuitem]').last().focus();
-	}
+/**
+ * Config merging function
+ *
+ * Takes any number of objects and combines them together, with
+ * greatest priority on the LAST item passed in.
+ *
+ * @param {...{ [key: string]: unknown }} configObjects - Config objects to merge
+ * @returns {{ [key: string]: unknown }} A merged config object
+ */
+MOJFrontend.ButtonMenu.prototype.mergeConfigs = function (...configObjects) {
+  const formattedConfigObject = {};
+
+  // Loop through each of the passed objects
+  for (const configObject of configObjects) {
+    for (const key of Object.keys(configObject)) {
+      const option = formattedConfigObject[key];
+      const override = configObject[key];
+
+      // Push their keys one-by-one into formattedConfigObject. Any duplicate
+      // keys with object values will be merged, otherwise the new value will
+      // override the existing value.
+      if (typeof option === "object" && typeof override === "object") {
+        // @ts-expect-error Index signature for type 'string' is missing
+        formattedConfigObject[key] = this.mergeConfigs(option, override);
+      } else {
+        formattedConfigObject[key] = override;
+      }
+    }
+  }
+
+  return formattedConfigObject;
 };
 
+/**
+ * Schema for component config
+ *
+ * @typedef {object} Schema
+ * @property {{ [field: string]: SchemaProperty | undefined }} properties - Schema properties
+ */
+
+/**
+ * Schema property for component config
+ *
+ * @typedef {object} SchemaProperty
+ * @property {'string' | 'boolean' | 'number' | 'object'} type - Property type
+ */
+
 /**
  * Datepicker config
  *
@@ -471,7 +646,7 @@ Datepicker.prototype.init = function () {
 
   this.setOptions();
   this.initControls();
-  this.$module.setAttribute('data-initialized', 'true')
+  this.$module.setAttribute("data-initialized", "true");
 };
 
 Datepicker.prototype.initControls = function () {
@@ -580,6 +755,7 @@ Datepicker.prototype.createDialog = function () {
   $dialog.setAttribute("aria-modal", "true");
   $dialog.setAttribute("aria-labelledby", titleId);
   $dialog.innerHTML = this.dialogTemplate(titleId);
+  $dialog.hidden = true;
 
   return $dialog;
 };
@@ -717,20 +893,14 @@ Datepicker.prototype.setOptions = function () {
 
 Datepicker.prototype.setMinAndMaxDatesOnCalendar = function () {
   if (this.config.minDate) {
-    this.minDate = this.formattedDateFromString(
-      this.config.minDate,
-      null,
-    );
+    this.minDate = this.formattedDateFromString(this.config.minDate, null);
     if (this.minDate && this.currentDate < this.minDate) {
       this.currentDate = this.minDate;
     }
   }
 
   if (this.config.maxDate) {
-    this.maxDate = this.formattedDateFromString(
-      this.config.maxDate,
-      null,
-    );
+    this.maxDate = this.formattedDateFromString(this.config.maxDate, null);
     if (this.maxDate && this.currentDate > this.maxDate) {
       this.currentDate = this.maxDate;
     }
@@ -860,7 +1030,7 @@ Datepicker.prototype.formattedDateFromString = function (
   const month = match[3];
   const year = match[4];
 
-  formattedDate = new Date(`${month}-${day}-${year}`);
+  formattedDate = new Date(`${year}-${month}-${day}`);
   if (formattedDate instanceof Date && !isNaN(formattedDate)) {
     return formattedDate;
   }
@@ -948,7 +1118,6 @@ Datepicker.prototype.updateCalendar = function () {
 
 Datepicker.prototype.setCurrentDate = function (focus = true) {
   const { currentDate } = this;
-
   this.calendarDays.forEach((calendarDay) => {
     calendarDay.button.classList.add("moj-datepicker__button");
     calendarDay.button.classList.add("moj-datepicker__calendar-day");
@@ -976,10 +1145,10 @@ Datepicker.prototype.setCurrentDate = function (focus = true) {
       calendarDayDate.getTime() === this.inputDate.getTime()
     ) {
       calendarDay.button.classList.add(this.currentDayButtonClass);
-      calendarDay.button.setAttribute("aria-selected", true);
+      calendarDay.button.setAttribute("aria-current", "date");
     } else {
       calendarDay.button.classList.remove(this.currentDayButtonClass);
-      calendarDay.button.removeAttribute("aria-selected");
+      calendarDay.button.removeAttribute("aria-current");
     }
 
     if (calendarDayDate.getTime() === today.getTime()) {
@@ -1034,6 +1203,7 @@ Datepicker.prototype.toggleDialog = function (event) {
 };
 
 Datepicker.prototype.openDialog = function () {
+  this.$dialog.hidden = false;
   this.$dialog.classList.add("moj-datepicker__dialog--open");
   this.$calendarButton.setAttribute("aria-expanded", "true");
 
@@ -1054,6 +1224,7 @@ Datepicker.prototype.openDialog = function () {
 };
 
 Datepicker.prototype.closeDialog = function () {
+  this.$dialog.hidden = true;
   this.$dialog.classList.remove("moj-datepicker__dialog--open");
   this.$calendarButton.setAttribute("aria-expanded", "false");
   this.$calendarButton.focus();
@@ -1101,13 +1272,31 @@ Datepicker.prototype.focusPreviousWeek = function () {
 
 Datepicker.prototype.focusFirstDayOfWeek = function () {
   const date = new Date(this.currentDate);
-  date.setDate(date.getDate() - date.getDay());
+  const firstDayOfWeekIndex = this.config.weekStartDay == "sunday" ? 0 : 1;
+  const dayOfWeek = date.getDay();
+  const diff =
+    dayOfWeek >= firstDayOfWeekIndex
+      ? dayOfWeek - firstDayOfWeekIndex
+      : 6 - dayOfWeek;
+
+  date.setDate(date.getDate() - diff);
+  date.setHours(0, 0, 0, 0);
+
   this.goToDate(date);
 };
 
 Datepicker.prototype.focusLastDayOfWeek = function () {
   const date = new Date(this.currentDate);
-  date.setDate(date.getDate() - date.getDay() + 6);
+  const lastDayOfWeekIndex = this.config.weekStartDay == "sunday" ? 6 : 0;
+  const dayOfWeek = date.getDay();
+  const diff =
+    dayOfWeek <= lastDayOfWeekIndex
+      ? lastDayOfWeekIndex - dayOfWeek
+      : 7 - dayOfWeek;
+
+  date.setDate(date.getDate() + diff);
+  date.setHours(0, 0, 0, 0);
+
   this.goToDate(date);
 };