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

package/dist/components/SummaryList/GroupAction.js

@@ -16,8 +16,8 @@ function _extends() { _extends = Object.assign ? Object.assign.bind() : function
 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 GroupAction = function GroupAction(_ref) {
   var group = _ref.group;

package/dist/components/SummaryList/GroupAction.test.js

@@ -0,0 +1,80 @@
+"use strict";
+
+var _react = require("@testing-library/react");
+var _react2 = _interopRequireDefault(require("react"));
+var _GroupAction = _interopRequireDefault(require("./GroupAction"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// Global imports
+
+// Local imports
+
+describe('components', function () {
+  describe('SummaryList.GroupAction', function () {
+    it('should handle a group row without an action', function () {
+      var ROW = {};
+      var _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_GroupAction.default, {
+          group: ROW
+        })),
+        container = _render.container;
+      expect(container.childNodes.length).toEqual(0);
+    });
+    it('should handle a row with an href in the action', function () {
+      var PAGE = 'alpha';
+      var ROW = {
+        action: {
+          page: PAGE,
+          label: 'Change'
+        }
+      };
+      var _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_GroupAction.default, {
+          group: ROW
+        })),
+        container = _render2.container;
+      var link = container.childNodes[0];
+      expect(link.tagName).toEqual('A');
+      expect(link.getAttribute('href')).toEqual("/".concat(PAGE));
+      expect(link.textContent).toEqual(ROW.action.label);
+    });
+    it('should render an aria_suffix appropriately', function () {
+      var PAGE = 'alpha';
+      var ROW = {
+        action: {
+          page: PAGE,
+          label: 'Change',
+          aria_suffix: 'the thing'
+        }
+      };
+      var _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_GroupAction.default, {
+          group: ROW
+        })),
+        container = _render3.container;
+      var link = container.childNodes[0];
+      expect(link.tagName).toEqual('A');
+      expect(link.getAttribute('href')).toEqual("/".concat(PAGE));
+      expect(link.textContent).toEqual("".concat(ROW.action.label, " ").concat(ROW.action.aria_suffix));
+    });
+    it('should handle a row with an onAction in the action', function () {
+      var ON_ACTION_CALLS = [];
+      var ON_ACTION = function ON_ACTION(row) {
+        ON_ACTION_CALLS.push(row);
+      };
+      var ROW = {
+        action: {
+          onAction: ON_ACTION,
+          label: 'Change'
+        }
+      };
+      var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_GroupAction.default, {
+          group: ROW
+        })),
+        container = _render4.container;
+      var link = container.childNodes[0];
+      expect(link.tagName).toEqual('A');
+      expect(link.getAttribute('onClick')).toBeDefined();
+      expect(link.textContent).toEqual(ROW.action.label);
+      _react.fireEvent.click(link, {});
+      expect(ON_ACTION_CALLS.length).toEqual(1);
+      expect(ON_ACTION_CALLS[0]).toEqual(ROW);
+    });
+  });
+});

package/dist/components/SummaryList/RowAction.js

@@ -15,8 +15,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 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 RowAction = function RowAction(_ref) {
   var row = _ref.row;

package/dist/components/SummaryList/RowAction.test.js

@@ -0,0 +1,80 @@
+"use strict";
+
+var _react = require("@testing-library/react");
+var _react2 = _interopRequireDefault(require("react"));
+var _RowAction = _interopRequireDefault(require("./RowAction"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// Global imports
+
+// Local imports
+
+describe('components', function () {
+  describe('SummaryList.RowAction', function () {
+    it('should handle a row without an action', function () {
+      var ROW = {};
+      var _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
+          row: ROW
+        })),
+        container = _render.container;
+      expect(container.childNodes.length).toEqual(0);
+    });
+    it('should handle a row with an href in the action', function () {
+      var PAGE = 'alpha';
+      var ROW = {
+        action: {
+          page: PAGE,
+          label: 'Change'
+        }
+      };
+      var _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
+          row: ROW
+        })),
+        container = _render2.container;
+      var link = container.childNodes[0];
+      expect(link.tagName).toEqual('A');
+      expect(link.getAttribute('href')).toEqual("/".concat(PAGE));
+      expect(link.textContent).toEqual(ROW.action.label);
+    });
+    it('should render an aria_suffix appropriately', function () {
+      var PAGE = 'alpha';
+      var ROW = {
+        action: {
+          page: PAGE,
+          label: 'Change',
+          aria_suffix: 'the thing'
+        }
+      };
+      var _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
+          row: ROW
+        })),
+        container = _render3.container;
+      var link = container.childNodes[0];
+      expect(link.tagName).toEqual('A');
+      expect(link.getAttribute('href')).toEqual("/".concat(PAGE));
+      expect(link.textContent).toEqual("".concat(ROW.action.label, " ").concat(ROW.action.aria_suffix));
+    });
+    it('should handle a row with an onAction in the action', function () {
+      var ON_ACTION_CALLS = [];
+      var ON_ACTION = function ON_ACTION(row) {
+        ON_ACTION_CALLS.push(row);
+      };
+      var ROW = {
+        action: {
+          onAction: ON_ACTION,
+          label: 'Change'
+        }
+      };
+      var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
+          row: ROW
+        })),
+        container = _render4.container;
+      var link = container.childNodes[0];
+      expect(link.tagName).toEqual('A');
+      expect(link.getAttribute('onClick')).toBeDefined();
+      expect(link.textContent).toEqual(ROW.action.label);
+      _react.fireEvent.click(link, {});
+      expect(ON_ACTION_CALLS.length).toEqual(1);
+      expect(ON_ACTION_CALLS[0]).toEqual(ROW);
+    });
+  });
+});

package/dist/components/SummaryList/SummaryList.js

@@ -9,9 +9,10 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _react = _interopRequireDefault(require("react"));
 var _GroupAction = _interopRequireDefault(require("./GroupAction"));
 var _SummaryListRow = _interopRequireDefault(require("./SummaryListRow"));
+var _SummaryListHeadingRow = _interopRequireDefault(require("./SummaryListHeadingRow"));
 var _SummaryListTitleRow = _interopRequireDefault(require("./SummaryListTitleRow"));
 require("./SummaryList.scss");
-var _excluded = ["rows", "noChangeAction", "isGroup", "classBlock", "classModifiers", "className"];
+var _excluded = ["rows", "noChangeAction", "noGroupAction", "isGroup", "classBlock", "classModifiers", "className"];
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
@@ -21,6 +22,7 @@ exports.DEFAULT_CLASS = DEFAULT_CLASS;
 var SummaryList = function SummaryList(_ref) {
   var rows = _ref.rows,
     noChangeAction = _ref.noChangeAction,
+    noGroupAction = _ref.noGroupAction,
     isGroup = _ref.isGroup,
     classBlock = _ref.classBlock,
     classModifiers = _ref.classModifiers,
@@ -32,7 +34,7 @@ var SummaryList = function SummaryList(_ref) {
     var rowActions = rows.filter(function (r) {
       return !!r.action;
     });
-    groupActionRow = rowActions.length > 0 ? rowActions[0] : null;
+    groupActionRow = rowActions !== null && rowActions !== void 0 && rowActions.length ? rowActions[0] : null;
   }
   return /*#__PURE__*/_react.default.createElement("div", {
     className: "group-of-rows"
@@ -47,8 +49,16 @@ var SummaryList = function SummaryList(_ref) {
         classes: classes
       });
     }
+    if (row.type === 'heading') {
+      return /*#__PURE__*/_react.default.createElement(_SummaryListHeadingRow.default, {
+        key: key,
+        title: row.key,
+        size: row.size || 's',
+        classes: classes
+      });
+    }
     if (row.type === 'action') {
-      return /*#__PURE__*/_react.default.createElement("div", {
+      return noChangeAction ? null : /*#__PURE__*/_react.default.createElement("div", {
         key: "".concat(key, "-actions")
       }, /*#__PURE__*/_react.default.createElement(_GroupAction.default, {
         group: row
@@ -60,35 +70,42 @@ var SummaryList = function SummaryList(_ref) {
       classes: classes,
       showAction: !noChangeAction
     });
-  }), isGroup && /*#__PURE__*/_react.default.createElement("div", {
+  }).filter(function (r) {
+    return !!r;
+  }), isGroup && !noGroupAction && /*#__PURE__*/_react.default.createElement("div", {
     className: "change-group-button"
   }, /*#__PURE__*/_react.default.createElement(_GroupAction.default, {
     group: groupActionRow
   }))));
 };
 SummaryList.propTypes = {
+  classBlock: _propTypes.default.string,
+  classModifiers: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)]),
+  className: _propTypes.default.string,
+  isGroup: _propTypes.default.bool,
+  noChangeAction: _propTypes.default.bool,
+  noGroupAction: _propTypes.default.bool,
   rows: _propTypes.default.arrayOf(_propTypes.default.shape({
     pageId: _propTypes.default.string.isRequired,
     fieldId: _propTypes.default.string.isRequired,
     full_path: _propTypes.default.string,
     key: _propTypes.default.string.isRequired,
-    value: _propTypes.default.any,
+    value: _propTypes.default.node,
     action: _propTypes.default.shape({
       page: _propTypes.default.string,
       label: _propTypes.default.string,
       aria_suffix: _propTypes.default.string,
       onAction: _propTypes.default.func
     })
-  })).isRequired,
-  noChangeAction: _propTypes.default.bool,
-  isGroup: _propTypes.default.bool,
-  classBlock: _propTypes.default.string,
-  classModifiers: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)]),
-  className: _propTypes.default.string
+  })).isRequired
 };
 SummaryList.defaultProps = {
   classBlock: DEFAULT_CLASS,
-  noChangeAction: false
+  classModifiers: [],
+  className: '',
+  isGroup: false,
+  noChangeAction: false,
+  noGroupAction: false
 };
 var _default = SummaryList;
 exports.default = _default;

package/dist/components/SummaryList/SummaryList.scss

@@ -14,6 +14,25 @@
   }
 }
 
+.govuk-summary-list__heading {
+  width: 100%;
+  white-space: nowrap;
+  .govuk-heading-s {
+    margin-bottom: 10px;
+  }
+  .govuk-heading-m {
+    margin-bottom: 10px;
+  }
+  &:not(:first-child) {
+    .govuk-heading-s {
+      margin-top: 20px;
+    }
+    .govuk-heading-m {
+      margin-top: 30px;
+    }
+  }
+}
+
 .changeRow {
   .govuk-link {
     float: right;

package/dist/components/SummaryList/SummaryList.stories.mdx

@@ -0,0 +1,90 @@
+<!-- Global imports -->
+
+import { ArgsTable, Canvas, Meta, Story } from '@storybook/addon-docs';
+import { Details, Heading } from '@ukhomeoffice/cop-react-components';
+
+<!-- Local imports -->
+
+import Utils from '../../utils';
+import SummaryList from './SummaryList';
+
+<Meta
+  title='Components/Summary list'
+  id='D-SummaryList'
+  component={SummaryList}
+/>
+
+<Heading size='xl' caption='Components'>
+  Summary list
+</Heading>
+
+Renders a list of key-value pairs, most commonly on the **Check your answers** screen, and optionally
+display action links.
+
+<Canvas withToolbar>
+  <Story name='Default'>
+    {() => {
+      const onAction = (row) => {
+        console.log('action clicked', row);
+      };
+      const ROWS = [
+        {
+          pageId: 'p1',
+          fieldId: 'forename',
+          key: 'Forename(s)',
+          value: 'John',
+        },
+        { pageId: 'p1', fieldId: 'surname', key: 'Surname', value: 'Smith' },
+        {
+          pageId: 'p2',
+          fieldId: 'dob',
+          key: 'Date of birth',
+          value: '29/08/1993',
+          action: { label: 'Change', onAction },
+        },
+      ];
+      return <SummaryList rows={ROWS} />;
+    }}
+  </Story>
+</Canvas>
+
+<Details summary='Properties' className='no-indent'>
+  <ArgsTable of={SummaryList} />
+</Details>
+
+## Variant
+
+### Read-only style
+
+<Canvas>
+  <Story name='Read-only style'>
+    {() => {
+      const onAction = (row) => {
+        console.log('action clicked', row);
+      };
+      const ROWS = [
+        {
+          pageId: 'p1',
+          fieldId: 'forename',
+          key: 'Forename(s)',
+          value: 'John',
+        },
+        { pageId: 'p1', fieldId: 'surname', key: 'Surname', value: 'Smith' },
+        {
+          pageId: 'p2',
+          fieldId: 'dob',
+          key: 'Date of birth',
+          value: '29/08/1993',
+          action: { label: 'Change', onAction },
+        },
+      ];
+      return (
+        <SummaryList
+          classModifiers='no-border'
+          rows={ROWS}
+          noChangeAction={true}
+        />
+      );
+    }}
+  </Story>
+</Canvas>