@ukhomeoffice/cop-react-form-renderer 5.26.1 → 5.27.0

package/dist/components/CheckYourAnswers/CheckYourAnswers.js

@@ -135,14 +135,14 @@ var CheckYourAnswers = function CheckYourAnswers(_ref) {
   var getPageHeading = function getPageHeading(page, size) {
     var _page$cya_link;
     if (!((_page$cya_link = page.cya_link) !== null && _page$cya_link !== void 0 && _page$cya_link.singleChangeLink) || noChangeAction) {
-      return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, size === 's' && /*#__PURE__*/_react.default.createElement(_copReactComponents.SmallHeading, null, _utils.default.interpolateString(page.title, page.formData)), size === 'm' && /*#__PURE__*/_react.default.createElement(_copReactComponents.MediumHeading, null, _utils.default.interpolateString(page.title, page.formData)));
+      return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, size === 's' && /*#__PURE__*/_react.default.createElement(_copReactComponents.SmallHeading, null, _utils.default.FormPage.getTitle(page.title, page.formData)), size === 'm' && /*#__PURE__*/_react.default.createElement(_copReactComponents.MediumHeading, null, _utils.default.FormPage.getTitle(page.title, page.formData)));
     }
     var headingAction = (0, _getCYAAction.default)(false, page, onRowAction);
     return /*#__PURE__*/_react.default.createElement("div", {
       className: "heading-with-action"
     }, /*#__PURE__*/_react.default.createElement("div", {
       className: "heading-text"
-    }, size === 's' && /*#__PURE__*/_react.default.createElement(_copReactComponents.SmallHeading, null, _utils.default.interpolateString(page.title, page.formData)), size === 'm' && /*#__PURE__*/_react.default.createElement(_copReactComponents.MediumHeading, null, _utils.default.interpolateString(page.title, page.formData))), /*#__PURE__*/_react.default.createElement("div", {
+    }, size === 's' && /*#__PURE__*/_react.default.createElement(_copReactComponents.SmallHeading, null, _utils.default.FormPage.getTitle(page.title, page.formData)), size === 'm' && /*#__PURE__*/_react.default.createElement(_copReactComponents.MediumHeading, null, _utils.default.FormPage.getTitle(page.title, page.formData))), /*#__PURE__*/_react.default.createElement("div", {
       className: "heading-action"
     }, /*#__PURE__*/_react.default.createElement(_RowAction.default, {
       row: {
@@ -191,7 +191,7 @@ var CheckYourAnswers = function CheckYourAnswers(_ref) {
       key: pageIndex
     }, showHeading && getPageHeading(page, 'm'), isGroup(page.id) && /*#__PURE__*/_react.default.createElement("div", {
       className: "group-title"
-    }, /*#__PURE__*/_react.default.createElement(_copReactComponents.MediumHeading, null, currentGroup.title || page.title)), /*#__PURE__*/_react.default.createElement(_SummaryList.default, {
+    }, /*#__PURE__*/_react.default.createElement(_copReactComponents.MediumHeading, null, currentGroup.title || _utils.default.FormPage.getTitle(page.title, page.formData))), /*#__PURE__*/_react.default.createElement(_SummaryList.default, {
       className: className,
       rows: page.rows,
       classModifiers: summaryListClassModifiers,

package/dist/components/CollectionPage/CollectionPage.test.js

@@ -4,6 +4,7 @@ var _react = require("@testing-library/react");
 var _react2 = _interopRequireDefault(require("react"));
 var _models = require("../../models");
 var _setupTests = require("../../setupTests");
+var _utils = _interopRequireDefault(require("../../utils"));
 var _ActionButton = require("../PageActions/ActionButton");
 var _CollectionPage = _interopRequireWildcard(require("./CollectionPage"));
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
@@ -222,7 +223,7 @@ describe('components.CollectionPage', function () {
             expect(page.classList).toContain(_CollectionPage.DEFAULT_CLASS);
             heading = page.childNodes[0];
             expect(heading.classList).toContain('govuk-heading-l');
-            expect(heading.textContent).toEqual(PAGE.title);
+            expect(heading.textContent).toEqual(_utils.default.FormPage.getTitle(PAGE.title, PAGE.formData));
             checkInputField(page.childNodes[1], TEXT.fieldId, "".concat(TEXT.label, " (optional)"), TEXT.hint, VALUE);
             checkFormButtonGroup(page.childNodes[2], [_ActionButton.DEFAULT_LABEL]);
           case 9:

package/dist/components/FormPage/FormPage.js

@@ -86,7 +86,7 @@ var FormPage = function FormPage(_ref) {
     }) : action;
   });
   formPage.formData = _utils.default.Operate.runPageOperations(formPage, _objectSpread(_objectSpread({}, formPage.formData), patch), onWrapperChange || onPageChange);
-  var headingContent = page.title ? /*#__PURE__*/_react.default.createElement(_copReactComponents.LargeHeading, null, _utils.default.interpolateString(page.title, page.formData)) : /*#__PURE__*/_react.default.createElement(_copReactComponents.Label, {
+  var headingContent = page.title ? /*#__PURE__*/_react.default.createElement(_copReactComponents.LargeHeading, null, _utils.default.FormPage.getTitle(page.title, page.formData)) : /*#__PURE__*/_react.default.createElement(_copReactComponents.Label, {
     id: page.id,
     required: page.required,
     hideOptionalSuffix: page.hideOptionalSuffix

package/dist/components/FormPage/FormPage.test.js

@@ -5,6 +5,7 @@ var _react = require("@testing-library/react");
 var _react2 = _interopRequireDefault(require("react"));
 var _models = require("../../models");
 var _setupTests = require("../../setupTests");
+var _utils = _interopRequireDefault(require("../../utils"));
 var _ActionButton = require("../PageActions/ActionButton");
 var _FormPage = _interopRequireWildcard(require("./FormPage"));
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
@@ -208,7 +209,7 @@ describe('components.FormPage', function () {
             expect(page.classList).toContain(_FormPage.DEFAULT_CLASS);
             heading = page.childNodes[0];
             expect(heading.classList).toContain('govuk-heading-l');
-            expect(heading.textContent).toEqual(PAGE.title);
+            expect(heading.textContent).toEqual(_utils.default.FormPage.getTitle(PAGE.title, PAGE.formData));
             checkInputField(page.childNodes[1], TEXT.fieldId, "".concat(TEXT.label, " (optional)"), TEXT.hint, VALUE);
             checkFormButtonGroup(page.childNodes[2], [_ActionButton.DEFAULT_LABEL]);
           case 9:

package/dist/utils/FormPage/getPageTitle.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+var _meetsAllConditions = _interopRequireDefault(require("../Condition/meetsAllConditions"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// Global imports.
+
+// Local imports.
+
+var getPageTitle = function getPageTitle(title, formData) {
+  if (typeof title === 'string') {
+    return _copReactComponents.Utils.interpolateString(title, formData);
+  }
+  if (!Array.isArray(title)) {
+    return null;
+  }
+  var shownOption = title.find(function (option) {
+    if (typeof option === 'string') {
+      // This is intended to allow a plain string 'fallback' option in the array.
+      // As such, it should be the last option in the array as any options after
+      // it will not be considered.
+      return true;
+    }
+    return (0, _meetsAllConditions.default)(option.show_when, formData);
+  });
+  return typeof shownOption === 'string' ? _copReactComponents.Utils.interpolateString(shownOption, formData) : _copReactComponents.Utils.interpolateString(shownOption.title, formData);
+};
+var _default = getPageTitle;
+exports.default = _default;

package/dist/utils/FormPage/getPageTitle.test.js

@@ -0,0 +1,116 @@
+"use strict";
+
+var _getPageTitle = _interopRequireDefault(require("./getPageTitle"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe('utils.FormPage.getPageTitle', function () {
+  var FORM_DATA = {
+    testField: 'Alpha',
+    testField2: 'yes'
+  };
+  it('should return null if title is not defined', function () {
+    var result = (0, _getPageTitle.default)(null, FORM_DATA);
+    expect(result).toEqual(null);
+  });
+  it('should return the defined page title if it\'s just a string', function () {
+    var PAGE = {
+      title: 'Page title'
+    };
+    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
+    expect(result).toEqual('Page title');
+  });
+  it('should return a correctly interpolated title', function () {
+    // eslint-disable-next-line no-template-curly-in-string
+    var PAGE = {
+      title: '${testField} title'
+    };
+    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
+    expect(result).toEqual("".concat(FORM_DATA.testField, " title"));
+  });
+  it('should return the title that has it\'s conditions met', function () {
+    var PAGE = {
+      title: [{
+        title: 'First title',
+        show_when: [{
+          field: 'testField2',
+          op: '=',
+          value: 'no'
+        }]
+      }, {
+        title: 'Second title',
+        show_when: [{
+          field: 'testField2',
+          op: '=',
+          value: 'yes'
+        }]
+      }]
+    };
+    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
+    expect(result).toEqual('Second title');
+  });
+  it('should return a plain string title if one is encountered in the array', function () {
+    var PAGE = {
+      title: [{
+        title: 'First title',
+        show_when: [{
+          field: 'testField2',
+          op: '=',
+          value: 'notTheValue'
+        }]
+      }, {
+        title: 'Second title',
+        show_when: [{
+          field: 'testField2',
+          op: '=',
+          value: 'notTheValue'
+        }]
+      }, "Default title"]
+    };
+    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
+    expect(result).toEqual('Default title');
+  });
+  it('should correctly interpolate a plain string option in the title array', function () {
+    var PAGE = {
+      title: [{
+        title: 'First title',
+        show_when: [{
+          field: 'testField2',
+          op: '=',
+          value: 'notTheValue'
+        }]
+      }, {
+        title: 'Second title',
+        show_when: [{
+          field: 'testField2',
+          op: '=',
+          value: 'notTheValue'
+        }]
+      },
+      // eslint-disable-next-line no-template-curly-in-string
+      "${testField} title"]
+    };
+    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
+    expect(result).toEqual("".concat(FORM_DATA.testField, " title"));
+  });
+  it('should correctly interpolate a conditional title', function () {
+    var PAGE = {
+      title: [{
+        title: 'First title',
+        show_when: [{
+          field: 'testField2',
+          op: '=',
+          value: 'no'
+        }]
+      }, {
+        // eslint-disable-next-line no-template-curly-in-string
+        title: '${testField} title',
+        show_when: [{
+          field: 'testField2',
+          op: '=',
+          value: 'yes'
+        }]
+      }]
+    };
+    var result = (0, _getPageTitle.default)(PAGE.title, FORM_DATA);
+    expect(result).toEqual("".concat(FORM_DATA.testField, " title"));
+  });
+});

package/dist/utils/FormPage/index.js

@@ -7,6 +7,7 @@ exports.default = void 0;
 var _applyConditionalProperties = _interopRequireDefault(require("./applyConditionalProperties"));
 var _getFormPage = _interopRequireDefault(require("./getFormPage"));
 var _getFormPages = _interopRequireDefault(require("./getFormPages"));
+var _getPageTitle = _interopRequireDefault(require("./getPageTitle"));
 var _showFormPage = _interopRequireDefault(require("./showFormPage"));
 var _showFormPageCYA = _interopRequireDefault(require("./showFormPageCYA"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -14,6 +15,7 @@ var FormPage = {
   applyConditionalProperties: _applyConditionalProperties.default,
   get: _getFormPage.default,
   getAll: _getFormPages.default,
+  getTitle: _getPageTitle.default,
   show: _showFormPage.default,
   showCYA: _showFormPageCYA.default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "5.26.1",
+  "version": "5.27.0",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",