@ukhomeoffice/cop-react-form-renderer 5.0.0-alpha → 5.0.0

package/dist/components/FormPage/FormPage.js

@@ -6,33 +6,37 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = exports.DEFAULT_CLASS = void 0;
 var _copReactComponents = require("@ukhomeoffice/cop-react-components");
-var _propTypes = _interopRequireDefault(require("prop-types"));
 var _react = _interopRequireWildcard(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
 var _hooks = require("../../hooks");
 var _utils = _interopRequireDefault(require("../../utils"));
 var _FormComponent = _interopRequireDefault(require("../FormComponent"));
 var _PageActions = _interopRequireDefault(require("../PageActions"));
 require("./FormPage.scss");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 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); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-var DEFAULT_CLASS = 'hods-form';
+var DEFAULT_CLASS = 'hods-form__page';
 exports.DEFAULT_CLASS = DEFAULT_CLASS;
 var FormPage = function FormPage(_ref) {
-  var _page$actions, _page$actions2;
+  var _formPage$actions, _page$actions;
   var page = _ref.page,
     _onAction = _ref.onAction,
     onWrapperChange = _ref.onWrapperChange,
     onTopLevelChange = _ref.onTopLevelChange,
+    onChange = _ref.onChange,
+    hashLink = _ref.hashLink,
     classBlock = _ref.classBlock,
     classModifiers = _ref.classModifiers,
     className = _ref.className;
@@ -54,27 +58,38 @@ var FormPage = function FormPage(_ref) {
   */
   var onPageChange = function onPageChange(_ref2) {
     var target = _ref2.target;
-    page.formData[target.name] = target.value;
+    var formPage = page;
+    formPage.formData[target.name] = target.value;
     setPatch(function (prev) {
       return _objectSpread(_objectSpread({}, prev), {}, _defineProperty({}, target.name, target.value));
     });
     setPatchLabel(function (prev) {
       return _objectSpread(_objectSpread({}, prev), {}, _defineProperty({}, target.component, target.label));
     });
+    if (typeof onChange === 'function') {
+      onChange(page.formData);
+    }
   };
+  (0, _react.useEffect)(function () {
+    // eslint-disable-next-line no-useless-concat
+    var coreDocTitle = document.title.replace('Error: ', '');
+    // eslint-disable-next-line prefer-template
+    document.title = errors.length > 0 ? 'Error: ' + coreDocTitle : coreDocTitle;
+  }, [errors]);
   var classes = _utils.default.classBuilder(classBlock, classModifiers, className);
-  page.actions = (_page$actions = page.actions) === null || _page$actions === void 0 ? void 0 : _page$actions.map(function (action) {
+  var formPage = page;
+  formPage.actions = (_formPage$actions = formPage.actions) === null || _formPage$actions === void 0 ? void 0 : _formPage$actions.map(function (action) {
     return action.label ? _objectSpread(_objectSpread({}, action), {}, {
-      label: _utils.default.interpolateString(action.label, page.formData)
+      label: _utils.default.interpolateString(action.label, formPage.formData)
     }) : action;
   });
-  page.formData = _utils.default.Operate.runPageOperations(page, _objectSpread(_objectSpread({}, page.formData), patch), onWrapperChange || onPageChange);
-  return /*#__PURE__*/_react.default.createElement("div", {
-    className: classes('page'),
-    key: page.id
-  }, page.title && /*#__PURE__*/_react.default.createElement(_copReactComponents.LargeHeading, null, _utils.default.interpolateString(page.title, page.formData)), (errors === null || errors === void 0 ? void 0 : errors.length) > 0 && /*#__PURE__*/_react.default.createElement(_copReactComponents.ErrorSummary, {
-    errors: errors
-  }), page.components.filter(function (c) {
+  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, {
+    id: page.id,
+    required: page.required,
+    hideOptionalSuffix: page.hideOptionalSuffix
+  }, page.label);
+  var formComponentContent = page.components.filter(function (c) {
     return _utils.default.Component.show(c, page.formData);
   }).map(function (component, index) {
     return /*#__PURE__*/_react.default.createElement(_FormComponent.default, {
@@ -85,8 +100,19 @@ var FormPage = function FormPage(_ref) {
       value: page.formData[component.fieldId] || patch[component.fieldId],
       formData: page.formData
     });
-  }), /*#__PURE__*/_react.default.createElement(_PageActions.default, {
-    actions: (_page$actions2 = page.actions) === null || _page$actions2 === void 0 ? void 0 : _page$actions2.filter(function (action) {
+  });
+  return /*#__PURE__*/_react.default.createElement("div", {
+    className: classes(),
+    key: page.id
+  }, (errors === null || errors === void 0 ? void 0 : errors.length) > 0 && /*#__PURE__*/_react.default.createElement(_copReactComponents.ErrorSummary, {
+    errors: errors,
+    hashLink: hashLink
+  }), page.fieldset && /*#__PURE__*/_react.default.createElement("fieldset", {
+    className: "govuk-fieldset"
+  }, /*#__PURE__*/_react.default.createElement("legend", {
+    className: "govuk-fieldset__legend"
+  }, headingContent), formComponentContent), !page.fieldset && /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, headingContent, formComponentContent), /*#__PURE__*/_react.default.createElement(_PageActions.default, {
+    actions: (_page$actions = page.actions) === null || _page$actions === void 0 ? void 0 : _page$actions.filter(function (action) {
       return _utils.default.Component.show(action, page.formData);
     }),
     onAction: function onAction(action) {
@@ -95,25 +121,38 @@ var FormPage = function FormPage(_ref) {
   }));
 };
 FormPage.propTypes = {
-  page: _propTypes.default.shape({
-    id: _propTypes.default.string.isRequired,
-    title: _propTypes.default.string,
-    components: _propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.object])).isRequired,
-    actions: _propTypes.default.array,
-    formData: _propTypes.default.object.isRequired
-  }).isRequired,
+  classBlock: _propTypes.default.string,
+  classModifiers: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)]),
+  className: _propTypes.default.string,
+  hashLink: _propTypes.default.bool,
   onAction: _propTypes.default.func.isRequired,
   // If passed in, this function will override the default
   // onPageChange functionality. Useful for anything that
   // wants to wrap FormPage.
   onWrapperChange: _propTypes.default.func,
-  classBlock: _propTypes.default.string,
-  classModifiers: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)]),
-  className: _propTypes.default.string
+  onChange: _propTypes.default.func,
+  onTopLevelChange: _propTypes.default.func,
+  // eslint-disable-next-line react/require-default-props
+  page: _propTypes.default.shape({
+    id: _propTypes.default.string.isRequired,
+    title: _propTypes.default.string,
+    components: _propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.shape({})])).isRequired,
+    fieldset: _propTypes.default.bool,
+    hideOptionalSuffix: _propTypes.default.bool,
+    label: _propTypes.default.string,
+    required: _propTypes.default.bool,
+    actions: _propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.shape({}), _propTypes.default.string])),
+    formData: _propTypes.default.shape({}).isRequired
+  }).isRequired
 };
 FormPage.defaultProps = {
   classBlock: DEFAULT_CLASS,
-  classModifiers: []
+  classModifiers: [],
+  className: '',
+  hashLink: false,
+  onChange: undefined,
+  onTopLevelChange: undefined,
+  onWrapperChange: undefined
 };
 var _default = FormPage;
 exports.default = _default;

package/dist/components/FormPage/FormPage.stories.mdx

@@ -0,0 +1,155 @@
+<!-- Global imports -->
+import { ArgsTable, Canvas, Meta, Story } from '@storybook/addon-docs';
+import { Details, Heading, Link } from '@ukhomeoffice/cop-react-components';
+import withMock from 'storybook-addon-mock';
+
+<!-- Local imports -->
+import { HooksContextProvider, ValidationContextProvider } from '../../context';
+import Utils from '../../utils';
+import FormPage from './FormPage';
+
+<!-- JSON documents -->
+import ADDRESS from '../../json/addressDetails.json'
+import CIVIL_SERVANT from '../../json/areYouACivilServant.json';
+import GRADE from '../../json/grade.json';
+import TEAMS from '../../json/team.json';
+import USER_PROFILE_DATA from '../../json/userProfile.data.json';
+import USER_PROFILE from '../../json/userProfile.json';
+
+<Meta title="Components/Form page" id="D-FormPage" component={ FormPage } decorators={[withMock]} />
+
+<Heading size="xl" caption="Components">Form page</Heading>
+
+Renders a page on a form with <Link href="https://ukhomeoffice.github.io/cop-react-components/?path=/docs/d-alert--default-story">COP React components</Link>,
+on the basis of a <Link href="/?path=/docs/f-json-page">JSON</Link> configuration.
+
+<Canvas withToolbar>
+  <Story name="Default" parameters={{
+    mockData: [
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/areYouACivilServant`,
+        method: 'GET',
+        status: 200,
+        response: CIVIL_SERVANT
+      },
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/grade`,
+        method: 'GET',
+        status: 200,
+        response: GRADE
+      },
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/team`,
+        method: 'GET',
+        status: 200,
+        response: TEAMS
+      }
+    ]
+  }}>
+    {() => {
+      const PAGE_JSON = USER_PROFILE.pages.find(p => p.id === 'civil-servant-status');
+      const PAGE = Utils.FormPage.get(PAGE_JSON, USER_PROFILE.components, { ...USER_PROFILE_DATA });
+      const ON_ACTION = (action, patch, onError) => {
+        console.log('action invoked', action, patch);
+      };
+      return (
+        <HooksContextProvider>
+          <ValidationContextProvider>
+            <FormPage page={PAGE} onAction={ON_ACTION} />
+          </ValidationContextProvider>
+        </HooksContextProvider>
+      );
+    }}
+  </Story>
+</Canvas>
+
+<Details summary="Properties" className="no-indent">
+  <ArgsTable of={ FormPage } />
+</Details>
+
+
+## Variants
+### With `autocomplete`
+<Canvas>
+  <Story name="With autocomplete" parameters={{
+    mockData: [
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/areYouACivilServant`,
+        method: 'GET',
+        status: 200,
+        response: CIVIL_SERVANT
+      },
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/grade`,
+        method: 'GET',
+        status: 200,
+        response: GRADE
+      },
+      {
+        url: `${USER_PROFILE_DATA.urls.refData}/team`,
+        method: 'GET',
+        status: 200,
+        response: TEAMS
+      }
+    ]
+  }}>
+    {() => {
+      const PAGE_JSON = USER_PROFILE.pages.find(p => p.id === 'team-name');
+      const PAGE = Utils.FormPage.get(PAGE_JSON, USER_PROFILE.components, { ...USER_PROFILE_DATA });
+      const ON_ACTION = (action, patch, onError) => {
+        console.log('action invoked', action, patch);
+      };
+      return (
+        <HooksContextProvider>
+          <ValidationContextProvider>
+            <FormPage page={PAGE} onAction={ON_ACTION} />
+          </ValidationContextProvider>
+        </HooksContextProvider>
+      );
+    }}
+  </Story>
+</Canvas>
+
+### Without editable controls
+
+<Canvas>
+  <Story name="Without editable controls">
+    {() => {
+      const PAGE_JSON = USER_PROFILE.pages.find(p => p.id === 'add-or-change-line-manager');
+      const PAGE = Utils.FormPage.get(PAGE_JSON, USER_PROFILE.components, { ...USER_PROFILE_DATA });
+      const ON_ACTION = (action, patch, onError) => {
+        console.log('action invoked', action, patch);
+      };
+      return (
+        <HooksContextProvider>
+          <ValidationContextProvider>
+            <FormPage page={PAGE} onAction={ON_ACTION} />
+          </ValidationContextProvider>
+        </HooksContextProvider>
+      );
+    }}
+  </Story>
+</Canvas>
+
+### Grouping fields together in a `<fieldset />`
+
+Fieldset tags can be used to group related fields together in a way that makes forms more accesible for users of screen readers. This can be achieved by passing a `fieldSet` prop to the `<FormPage />` component.
+
+<Canvas>
+  <Story name="With fieldSet">
+    {() => {
+      const PAGE_JSON = ADDRESS.pages.find(p => p.id === 'address-details');
+      const PAGE = Utils.FormPage.get(PAGE_JSON, ADDRESS.components, { ...USER_PROFILE_DATA });
+      const ON_ACTION = (action, patch) => {
+        console.log('action invoked', action, patch);
+      };
+      return (
+        <HooksContextProvider>
+          <ValidationContextProvider>
+            <FormPage page={PAGE} onAction={ON_ACTION} />
+          </ValidationContextProvider>
+        </HooksContextProvider>
+      );
+    }}
+  </Story>
+</Canvas>