@ukhomeoffice/cop-react-form-renderer 0.1.0-beta → 1.0.0-delta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/dist/components/CheckYourAnswers/Answer.js +48 -0
  2. package/dist/components/CheckYourAnswers/Answer.test.js +94 -0
  3. package/dist/components/CheckYourAnswers/CheckYourAnswers.js +64 -19
  4. package/dist/components/CheckYourAnswers/CheckYourAnswers.scss +0 -7
  5. package/dist/components/CheckYourAnswers/CheckYourAnswers.stories.mdx +100 -0
  6. package/dist/components/CheckYourAnswers/CheckYourAnswers.test.js +317 -0
  7. package/dist/components/FormComponent/FormComponent.js +7 -7
  8. package/dist/components/FormComponent/FormComponent.stories.mdx +167 -0
  9. package/dist/components/FormComponent/FormComponent.test.js +137 -0
  10. package/dist/components/FormPage/FormPage.js +12 -11
  11. package/dist/components/FormPage/FormPage.stories.mdx +118 -0
  12. package/dist/components/FormPage/FormPage.test.js +255 -0
  13. package/dist/components/FormRenderer/FormRenderer.js +70 -58
  14. package/dist/components/FormRenderer/FormRenderer.stories.mdx +90 -0
  15. package/dist/components/FormRenderer/FormRenderer.test.js +469 -0
  16. package/dist/components/FormRenderer/handlers/cyaAction.js +28 -0
  17. package/dist/components/FormRenderer/handlers/getPageId.js +28 -0
  18. package/dist/components/FormRenderer/handlers/getPageId.test.js +61 -0
  19. package/dist/components/FormRenderer/handlers/handlers.test.js +97 -0
  20. package/dist/components/FormRenderer/handlers/index.js +23 -0
  21. package/dist/components/FormRenderer/handlers/navigate.js +28 -0
  22. package/dist/components/FormRenderer/handlers/submissionError.js +20 -0
  23. package/dist/components/FormRenderer/helpers/canActionProceed.js +35 -0
  24. package/dist/components/FormRenderer/helpers/canActionProceed.test.js +73 -0
  25. package/dist/components/FormRenderer/helpers/canCYASubmit.js +42 -0
  26. package/dist/components/FormRenderer/helpers/canCYASubmit.test.js +155 -0
  27. package/dist/components/FormRenderer/helpers/getCYA.js +31 -0
  28. package/dist/components/FormRenderer/helpers/getCYA.test.js +38 -0
  29. package/dist/components/FormRenderer/helpers/getFormState.js +32 -0
  30. package/dist/components/FormRenderer/helpers/getFormState.test.js +61 -0
  31. package/dist/components/FormRenderer/helpers/getNextPageId.js +65 -0
  32. package/dist/components/FormRenderer/helpers/getNextPageId.test.js +90 -0
  33. package/dist/components/FormRenderer/helpers/getPage.js +34 -0
  34. package/dist/components/FormRenderer/helpers/getPage.test.js +46 -0
  35. package/dist/components/FormRenderer/helpers/index.js +27 -0
  36. package/dist/components/PageActions/ActionButton.js +58 -0
  37. package/dist/components/PageActions/ActionButton.test.js +116 -0
  38. package/dist/components/PageActions/PageActions.js +18 -25
  39. package/dist/components/PageActions/PageActions.stories.mdx +74 -0
  40. package/dist/components/PageActions/PageActions.test.js +157 -0
  41. package/dist/components/SummaryList/RowAction.js +13 -22
  42. package/dist/components/SummaryList/RowAction.test.js +94 -0
  43. package/dist/components/SummaryList/SummaryList.js +6 -20
  44. package/dist/components/SummaryList/SummaryList.scss +7 -0
  45. package/dist/components/SummaryList/SummaryList.stories.mdx +36 -0
  46. package/dist/components/SummaryList/SummaryList.test.js +197 -0
  47. package/dist/components/SummaryList/helpers/getRowActionAttributes.js +27 -0
  48. package/dist/components/SummaryList/helpers/getRowActionAttributes.test.js +77 -0
  49. package/dist/components/SummaryList/helpers/index.js +15 -0
  50. package/dist/components/index.js +8 -0
  51. package/dist/hooks/useGetRequest.js +16 -1
  52. package/dist/hooks/useHooks.js +16 -5
  53. package/dist/index.js +3 -1
  54. package/dist/models/EventTypes.js +14 -0
  55. package/dist/models/FormPages.js +14 -0
  56. package/dist/models/PageAction.js +40 -0
  57. package/dist/models/index.js +24 -0
  58. package/dist/utils/CheckYourAnswers/getCYAAction.js +9 -0
  59. package/dist/utils/CheckYourAnswers/getCYARow.js +10 -0
  60. package/dist/utils/CheckYourAnswers/getCYARowsForPage.js +9 -0
  61. package/dist/utils/CheckYourAnswers/showComponentCYA.js +6 -5
  62. package/dist/utils/Component/getComponent.js +2 -2
  63. package/dist/utils/Component/getComponent.test.js +1 -1
  64. package/dist/utils/Data/setupFormData.js +3 -3
  65. package/dist/utils/Data/setupFormData.test.js +6 -6
  66. package/dist/utils/Data/setupRefDataUrlForComponent.test.js +4 -4
  67. package/dist/utils/FormPage/getFormPage.js +12 -1
  68. package/dist/utils/FormPage/getFormPage.test.js +178 -0
  69. package/dist/utils/FormPage/getFormPages.js +11 -6
  70. package/dist/utils/FormPage/getFormPages.test.js +95 -0
  71. package/dist/utils/FormPage/getParagraphFromText.js +6 -0
  72. package/dist/utils/FormPage/getParagraphFromText.test.js +29 -0
  73. package/dist/utils/FormPage/useComponent.js +9 -2
  74. package/dist/utils/FormPage/useComponent.test.js +82 -0
  75. package/dist/utils/Format/formatData.js +32 -0
  76. package/dist/utils/Format/formatData.test.js +46 -0
  77. package/dist/utils/Format/formatDataForComponent.js +41 -0
  78. package/dist/utils/Format/formatDataForComponent.test.js +161 -0
  79. package/dist/utils/Format/formatDataForForm.js +33 -0
  80. package/dist/utils/Format/formatDataForForm.test.js +78 -0
  81. package/dist/utils/Format/formatDataForPage.js +37 -0
  82. package/dist/utils/Format/formatDataForPage.test.js +96 -0
  83. package/dist/utils/Format/index.js +26 -0
  84. package/dist/utils/Hub/getFormHub.js +18 -4
  85. package/dist/utils/Hub/getFormHub.test.js +96 -0
  86. package/dist/utils/Hub/index.js +0 -3
  87. package/dist/utils/Validate/validatePage.test.js +1 -1
  88. package/dist/utils/index.js +3 -0
  89. package/package.json +13 -9
  90. package/dist/components/FormRenderer/helpers.js +0 -66
  91. package/dist/components/FormRenderer/helpers.test.js +0 -158
@@ -0,0 +1,157 @@
1
+ "use strict";
2
+
3
+ var _react = require("@testing-library/react");
4
+
5
+ var _react2 = _interopRequireDefault(require("react"));
6
+
7
+ var _models = require("../../models");
8
+
9
+ var _ActionButton = require("./ActionButton");
10
+
11
+ var _PageActions = _interopRequireDefault(require("./PageActions"));
12
+
13
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
14
+
15
+ function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
16
+
17
+ function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
18
+
19
+ describe('components', function () {
20
+ describe('PageActions', function () {
21
+ var ON_ACTION_CALLS = [];
22
+
23
+ var ON_ACTION = function ON_ACTION(action) {
24
+ ON_ACTION_CALLS.push(action);
25
+ };
26
+
27
+ beforeEach(function () {
28
+ ON_ACTION_CALLS.length = 0;
29
+ });
30
+ it('should handle an empty array of actions', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
31
+ var ACTIONS, _render, container;
32
+
33
+ return regeneratorRuntime.wrap(function _callee$(_context) {
34
+ while (1) {
35
+ switch (_context.prev = _context.next) {
36
+ case 0:
37
+ ACTIONS = [];
38
+ _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_PageActions.default, {
39
+ actions: ACTIONS,
40
+ onAction: ON_ACTION
41
+ })), container = _render.container;
42
+ expect(container.childNodes.length).toEqual(0);
43
+
44
+ case 3:
45
+ case "end":
46
+ return _context.stop();
47
+ }
48
+ }
49
+ }, _callee);
50
+ })));
51
+ it('should appropriately display a single submit action', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
52
+ var ACTIONS, _render2, container, buttonGroup, submit;
53
+
54
+ return regeneratorRuntime.wrap(function _callee2$(_context2) {
55
+ while (1) {
56
+ switch (_context2.prev = _context2.next) {
57
+ case 0:
58
+ ACTIONS = ['submit'];
59
+ _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_PageActions.default, {
60
+ actions: ACTIONS,
61
+ onAction: ON_ACTION
62
+ })), container = _render2.container;
63
+ buttonGroup = container.childNodes[0];
64
+ expect(buttonGroup.childNodes.length).toEqual(ACTIONS.length);
65
+ submit = buttonGroup.childNodes[0];
66
+ expect(submit.tagName).toEqual('BUTTON');
67
+ expect(submit.textContent).toEqual(_ActionButton.DEFAULT_LABEL); // Click the button and make sure it fires the onAction handler.
68
+
69
+ _react.fireEvent.click(submit, {});
70
+
71
+ expect(ON_ACTION_CALLS.length).toEqual(1);
72
+ expect(ON_ACTION_CALLS[0]).toEqual(_models.PageAction.DEFAULTS.submit);
73
+
74
+ case 10:
75
+ case "end":
76
+ return _context2.stop();
77
+ }
78
+ }
79
+ }, _callee2);
80
+ })));
81
+ it('should appropriately display a custom action', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3() {
82
+ var ACTIONS, _render3, container, buttonGroup, navigate;
83
+
84
+ return regeneratorRuntime.wrap(function _callee3$(_context3) {
85
+ while (1) {
86
+ switch (_context3.prev = _context3.next) {
87
+ case 0:
88
+ ACTIONS = [{
89
+ type: 'navigate',
90
+ url: '/alpha',
91
+ label: 'Alpha'
92
+ }];
93
+ _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_PageActions.default, {
94
+ actions: ACTIONS,
95
+ onAction: ON_ACTION
96
+ })), container = _render3.container;
97
+ buttonGroup = container.childNodes[0];
98
+ expect(buttonGroup.childNodes.length).toEqual(1);
99
+ navigate = buttonGroup.childNodes[0];
100
+ expect(navigate.tagName).toEqual('BUTTON');
101
+ expect(buttonGroup.childNodes.length).toEqual(ACTIONS.length); // Click the button and make sure it fires the onAction handler.
102
+
103
+ _react.fireEvent.click(navigate, {});
104
+
105
+ expect(ON_ACTION_CALLS.length).toEqual(1);
106
+ expect(ON_ACTION_CALLS[0]).toEqual(ACTIONS[0]);
107
+
108
+ case 10:
109
+ case "end":
110
+ return _context3.stop();
111
+ }
112
+ }
113
+ }, _callee3);
114
+ })));
115
+ it('should appropriately display multiple actions', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee4() {
116
+ var NAVIGATE, ACTIONS, _render4, container, buttonGroup, navigate, submit;
117
+
118
+ return regeneratorRuntime.wrap(function _callee4$(_context4) {
119
+ while (1) {
120
+ switch (_context4.prev = _context4.next) {
121
+ case 0:
122
+ NAVIGATE = {
123
+ type: 'navigate',
124
+ url: '/alpha',
125
+ label: 'Alpha'
126
+ };
127
+ ACTIONS = [NAVIGATE, 'submit'];
128
+ _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_PageActions.default, {
129
+ actions: ACTIONS,
130
+ onAction: ON_ACTION
131
+ })), container = _render4.container;
132
+ buttonGroup = container.childNodes[0];
133
+ expect(buttonGroup.childNodes.length).toEqual(ACTIONS.length);
134
+ navigate = buttonGroup.childNodes[0];
135
+ expect(navigate.tagName).toEqual('BUTTON');
136
+ expect(navigate.textContent).toEqual(NAVIGATE.label);
137
+ submit = buttonGroup.childNodes[1];
138
+ expect(submit.tagName).toEqual('BUTTON');
139
+ expect(submit.textContent).toEqual(_ActionButton.DEFAULT_LABEL); // Click each button in turn button and make sure it fires the onAction handler.
140
+
141
+ _react.fireEvent.click(navigate, {});
142
+
143
+ _react.fireEvent.click(submit, {});
144
+
145
+ expect(ON_ACTION_CALLS.length).toEqual(2);
146
+ expect(ON_ACTION_CALLS[0]).toEqual(NAVIGATE);
147
+ expect(ON_ACTION_CALLS[1]).toEqual(_models.PageAction.DEFAULTS.submit);
148
+
149
+ case 16:
150
+ case "end":
151
+ return _context4.stop();
152
+ }
153
+ }
154
+ }, _callee4);
155
+ })));
156
+ });
157
+ });
@@ -7,18 +7,20 @@ Object.defineProperty(exports, "__esModule", {
7
7
  });
8
8
  exports.default = void 0;
9
9
 
10
- var _react = _interopRequireWildcard(require("react"));
10
+ var _copReactComponents = require("@ukhomeoffice/cop-react-components");
11
11
 
12
12
  var _propTypes = _interopRequireDefault(require("prop-types"));
13
13
 
14
- var _copReactComponents = require("@ukhomeoffice/cop-react-components");
14
+ var _react = _interopRequireWildcard(require("react"));
15
15
 
16
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
16
+ var _helpers = require("./helpers");
17
17
 
18
18
  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); }
19
19
 
20
20
  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; }
21
21
 
22
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
23
+
22
24
  function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
23
25
 
24
26
  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."); }
@@ -40,32 +42,21 @@ var RowAction = function RowAction(_ref) {
40
42
  setAttrs = _useState2[1];
41
43
 
42
44
  (0, _react.useEffect)(function () {
43
- var value = {};
44
-
45
- if (row.action) {
46
- if (typeof row.action.onAction === 'function') {
47
- value = {
48
- onClick: function onClick() {
49
- return row.action.onAction(row);
50
- }
51
- };
52
- } else {
53
- value = {
54
- href: row.action.href
55
- };
56
- }
57
- }
58
-
59
- setAttrs(value);
45
+ setAttrs((0, _helpers.getRowActionAttributes)(row));
60
46
  }, [row, setAttrs]);
61
- return /*#__PURE__*/_react.default.createElement(_copReactComponents.Link, attrs, row.action.label, row.action.aria_suffix && /*#__PURE__*/_react.default.createElement(_copReactComponents.VisuallyHidden, null, row.action.aria_suffix));
47
+
48
+ if (!row.action) {
49
+ return null;
50
+ }
51
+
52
+ return /*#__PURE__*/_react.default.createElement(_copReactComponents.Link, attrs, row.action.label, row.action.aria_suffix && /*#__PURE__*/_react.default.createElement(_copReactComponents.VisuallyHidden, null, " ", row.action.aria_suffix));
62
53
  };
63
54
 
64
55
  RowAction.propTypes = {
65
56
  row: _propTypes.default.shape({
66
57
  action: _propTypes.default.shape({
58
+ label: _propTypes.default.string.isRequired,
67
59
  href: _propTypes.default.string,
68
- label: _propTypes.default.string,
69
60
  aria_suffix: _propTypes.default.string,
70
61
  onAction: _propTypes.default.func
71
62
  })
@@ -0,0 +1,94 @@
1
+ "use strict";
2
+
3
+ var _react = require("@testing-library/react");
4
+
5
+ var _react2 = _interopRequireDefault(require("react"));
6
+
7
+ var _RowAction = _interopRequireDefault(require("./RowAction"));
8
+
9
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
10
+
11
+ // Global imports
12
+ // Local imports
13
+ describe('components', function () {
14
+ describe('SummaryList.RowAction', function () {
15
+ it('should handle a row without an action', function () {
16
+ var ROW = {};
17
+
18
+ var _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
19
+ row: ROW
20
+ })),
21
+ container = _render.container;
22
+
23
+ expect(container.childNodes.length).toEqual(0);
24
+ });
25
+ it('should handle a row with an href in the action', function () {
26
+ var HREF = 'http://alpha.homeoffice.gov.uk';
27
+ var ROW = {
28
+ action: {
29
+ href: HREF,
30
+ label: 'Change'
31
+ }
32
+ };
33
+
34
+ var _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
35
+ row: ROW
36
+ })),
37
+ container = _render2.container;
38
+
39
+ var link = container.childNodes[0];
40
+ expect(link.tagName).toEqual('A');
41
+ expect(link.getAttribute('href')).toEqual(HREF);
42
+ expect(link.textContent).toEqual(ROW.action.label);
43
+ });
44
+ it('should render an aria_suffix appropriately', function () {
45
+ var HREF = 'http://alpha.homeoffice.gov.uk';
46
+ var ROW = {
47
+ action: {
48
+ href: HREF,
49
+ label: 'Change',
50
+ aria_suffix: 'the thing'
51
+ }
52
+ };
53
+
54
+ var _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
55
+ row: ROW
56
+ })),
57
+ container = _render3.container;
58
+
59
+ var link = container.childNodes[0];
60
+ expect(link.tagName).toEqual('A');
61
+ expect(link.getAttribute('href')).toEqual(HREF);
62
+ expect(link.textContent).toEqual("".concat(ROW.action.label, " ").concat(ROW.action.aria_suffix));
63
+ });
64
+ it('should handle a row with an onAction in the action', function () {
65
+ var ON_ACTION_CALLS = [];
66
+
67
+ var ON_ACTION = function ON_ACTION(row) {
68
+ ON_ACTION_CALLS.push(row);
69
+ };
70
+
71
+ var ROW = {
72
+ action: {
73
+ onAction: ON_ACTION,
74
+ label: 'Change'
75
+ }
76
+ };
77
+
78
+ var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_RowAction.default, {
79
+ row: ROW
80
+ })),
81
+ container = _render4.container;
82
+
83
+ var link = container.childNodes[0];
84
+ expect(link.tagName).toEqual('A');
85
+ expect(link.getAttribute('onClick')).toBeDefined();
86
+ expect(link.textContent).toEqual(ROW.action.label);
87
+
88
+ _react.fireEvent.click(link, {});
89
+
90
+ expect(ON_ACTION_CALLS.length).toEqual(1);
91
+ expect(ON_ACTION_CALLS[0]).toEqual(ROW);
92
+ });
93
+ });
94
+ });
@@ -5,30 +5,22 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.default = exports.DEFAULT_CLASS = void 0;
7
7
 
8
- var _react = _interopRequireDefault(require("react"));
8
+ var _copReactComponents = require("@ukhomeoffice/cop-react-components");
9
9
 
10
10
  var _propTypes = _interopRequireDefault(require("prop-types"));
11
11
 
12
- var _copReactComponents = require("@ukhomeoffice/cop-react-components");
12
+ var _react = _interopRequireDefault(require("react"));
13
13
 
14
14
  var _RowAction = _interopRequireDefault(require("./RowAction"));
15
15
 
16
16
  require("./SummaryList.scss");
17
17
 
18
- var _FormComponent = _interopRequireDefault(require("../FormComponent"));
19
-
20
18
  var _excluded = ["rows", "classBlock", "classModifiers", "className"];
21
19
 
22
20
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
23
21
 
24
22
  function _extends() { _extends = Object.assign || 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); }
25
23
 
26
- function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
27
-
28
- function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
29
-
30
- 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; }
31
-
32
24
  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; }
33
25
 
34
26
  function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
@@ -47,23 +39,17 @@ var SummaryList = function SummaryList(_ref) {
47
39
 
48
40
  return /*#__PURE__*/_react.default.createElement("dl", _extends({}, attrs, {
49
41
  className: classes()
50
- }), rows.map(function (row, index) {
42
+ }), rows.map(function (row) {
51
43
  return /*#__PURE__*/_react.default.createElement("div", {
52
- key: index,
44
+ key: "".concat(row.pageId, "_").concat(row.fieldId),
53
45
  className: classes('row')
54
46
  }, /*#__PURE__*/_react.default.createElement("dt", {
55
47
  className: classes('key')
56
48
  }, row.key), /*#__PURE__*/_react.default.createElement("dd", {
57
49
  className: classes('value')
58
- }, row.component && row.value ? /*#__PURE__*/_react.default.createElement(_FormComponent.default, {
59
- component: _objectSpread(_objectSpread({}, row.component), {}, {
60
- readonly: true
61
- }),
62
- noWrap: true,
63
- value: row.value
64
- }) : row.value), row.action && /*#__PURE__*/_react.default.createElement("dd", {
50
+ }, row.value), /*#__PURE__*/_react.default.createElement("dd", {
65
51
  className: classes('actions')
66
- }, /*#__PURE__*/_react.default.createElement(_RowAction.default, {
52
+ }, row.action && /*#__PURE__*/_react.default.createElement(_RowAction.default, {
67
53
  row: row
68
54
  })));
69
55
  }));
@@ -1,2 +1,9 @@
1
1
  @import "node_modules/govuk-frontend/govuk/_base";
2
2
  @import "node_modules/govuk-frontend/govuk/components/summary-list/_summary-list";
3
+
4
+ .govuk-summary-list__actions {
5
+ .govuk-link {
6
+ color: govuk-colour('blue');
7
+ cursor: pointer;
8
+ }
9
+ }
@@ -0,0 +1,36 @@
1
+ <!-- Global imports -->
2
+ import { ArgsTable, Canvas, Meta, Story } from '@storybook/addon-docs';
3
+ import { Details, Heading } from '@ukhomeoffice/cop-react-components';
4
+
5
+ <!-- Local imports -->
6
+ import Utils from '../../utils';
7
+ import SummaryList from './SummaryList';
8
+
9
+ <Meta title="Components/Summary list" id="D-SummaryList" component={ SummaryList } />
10
+
11
+ <Heading size="xl" caption="Components">Summary list</Heading>
12
+
13
+ Renders a list of key-value pairs, most commonly on the **Check your answers** screen, and optionally
14
+ display action links.
15
+
16
+ <Canvas withToolbar>
17
+ <Story name="Default">
18
+ {() => {
19
+ const onAction = (row) => {
20
+ console.log('action clicked', row);
21
+ };
22
+ const ROWS = [
23
+ { pageId: 'p1', fieldId: 'forename', key: 'Forename(s)', value: 'John' },
24
+ { pageId: 'p1', fieldId: 'surname', key: 'Surname', value: 'Smith' },
25
+ { pageId: 'p2', fieldId: 'dob', key: 'Date of birth', value: '29/08/1993', action: { label: 'Change', onAction } },
26
+ ];
27
+ return (
28
+ <SummaryList rows={ROWS} />
29
+ );
30
+ }}
31
+ </Story>
32
+ </Canvas>
33
+
34
+ <Details summary="Properties" className="no-indent">
35
+ <ArgsTable of={ SummaryList } />
36
+ </Details>
@@ -0,0 +1,197 @@
1
+ "use strict";
2
+
3
+ function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
4
+
5
+ var _react = require("@testing-library/react");
6
+
7
+ var _react2 = _interopRequireDefault(require("react"));
8
+
9
+ var _SummaryList = _interopRequireWildcard(require("./SummaryList"));
10
+
11
+ 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); }
12
+
13
+ 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; }
14
+
15
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
16
+
17
+ function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
18
+
19
+ 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."); }
20
+
21
+ 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); }
22
+
23
+ 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; }
24
+
25
+ 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; }
26
+
27
+ function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
28
+
29
+ describe('components', function () {
30
+ describe('SummaryList', function () {
31
+ var checkSummaryList = function checkSummaryList(container, id) {
32
+ var summaryList = (0, _react.getByTestId)(container, id);
33
+ expect(summaryList.tagName).toEqual('DL');
34
+ expect(summaryList.classList).toContain(_SummaryList.DEFAULT_CLASS);
35
+ return summaryList;
36
+ };
37
+
38
+ var checkRow = function checkRow(summaryList, index) {
39
+ var row = summaryList.childNodes[index];
40
+ expect(row.tagName).toEqual('DIV');
41
+ expect(row.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__row"));
42
+
43
+ var _row$childNodes = _slicedToArray(row.childNodes, 3),
44
+ key = _row$childNodes[0],
45
+ value = _row$childNodes[1],
46
+ actions = _row$childNodes[2];
47
+
48
+ expect(key.tagName).toEqual('DT');
49
+ expect(key.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__key"));
50
+ expect(value.tagName).toEqual('DD');
51
+ expect(value.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__value"));
52
+ expect(actions.tagName).toEqual('DD');
53
+ expect(actions.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__actions"));
54
+ return [key, value, actions];
55
+ };
56
+
57
+ it('should handle an empty rows array', function () {
58
+ var ID = 'test-id';
59
+ var ROWS = [];
60
+
61
+ var _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
62
+ "data-testid": ID,
63
+ rows: ROWS
64
+ })),
65
+ container = _render.container;
66
+
67
+ var summaryList = checkSummaryList(container, ID);
68
+ expect(summaryList.childNodes.length).toEqual(0);
69
+ });
70
+ it('should handle rows with no actions and string values', function () {
71
+ var ID = 'test-id';
72
+ var ROWS = [{
73
+ pageId: 'p1',
74
+ fieldId: 'a',
75
+ key: 'Alpha',
76
+ value: 'Alpha value'
77
+ }, {
78
+ pageId: 'p2',
79
+ fieldId: 'b',
80
+ key: 'Bravo',
81
+ value: 'Bravo value'
82
+ }];
83
+
84
+ var _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
85
+ "data-testid": ID,
86
+ rows: ROWS
87
+ })),
88
+ container = _render2.container;
89
+
90
+ var summaryList = checkSummaryList(container, ID);
91
+ expect(summaryList.childNodes.length).toEqual(ROWS.length);
92
+ ROWS.forEach(function (row, index) {
93
+ var _checkRow = checkRow(summaryList, index),
94
+ _checkRow2 = _slicedToArray(_checkRow, 3),
95
+ key = _checkRow2[0],
96
+ value = _checkRow2[1],
97
+ actions = _checkRow2[2];
98
+
99
+ expect(key.textContent).toEqual(row.key);
100
+ expect(value.textContent).toEqual(row.value);
101
+ expect(actions.childNodes.length).toEqual(0);
102
+ });
103
+ });
104
+ it('should handle rows with no actions and component values', function () {
105
+ var ID = 'test-id';
106
+ var VALUES = ['Alpha component value', 'Bravo component value'];
107
+ var ROWS = [{
108
+ pageId: 'p1',
109
+ fieldId: 'a',
110
+ key: 'Alpha',
111
+ value: /*#__PURE__*/_react2.default.createElement("div", null, VALUES[0])
112
+ }, {
113
+ pageId: 'p2',
114
+ fieldId: 'b',
115
+ key: 'Bravo',
116
+ value: /*#__PURE__*/_react2.default.createElement("div", null, VALUES[1])
117
+ }];
118
+
119
+ var _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
120
+ "data-testid": ID,
121
+ rows: ROWS
122
+ })),
123
+ container = _render3.container;
124
+
125
+ var summaryList = checkSummaryList(container, ID);
126
+ expect(summaryList.childNodes.length).toEqual(ROWS.length);
127
+ ROWS.forEach(function (row, index) {
128
+ var _checkRow3 = checkRow(summaryList, index),
129
+ _checkRow4 = _slicedToArray(_checkRow3, 3),
130
+ key = _checkRow4[0],
131
+ value = _checkRow4[1],
132
+ actions = _checkRow4[2];
133
+
134
+ expect(key.textContent).toEqual(row.key);
135
+ expect(value.childNodes.length).toEqual(1);
136
+ var valueDiv = value.childNodes[0];
137
+ expect(valueDiv.tagName).toEqual('DIV');
138
+ expect(valueDiv.textContent).toEqual(VALUES[index]);
139
+ expect(actions.childNodes.length).toEqual(0);
140
+ });
141
+ });
142
+ it('should handle rows with actions', function () {
143
+ var ID = 'test-id';
144
+ var ON_ACTION_CALLS = [];
145
+
146
+ var ON_ACTION = function ON_ACTION(row) {
147
+ ON_ACTION_CALLS.push(row);
148
+ };
149
+
150
+ var ROWS = [{
151
+ pageId: 'p1',
152
+ fieldId: 'a',
153
+ key: 'Alpha',
154
+ value: 'Alpha value',
155
+ action: {
156
+ label: 'Change A',
157
+ onAction: ON_ACTION
158
+ }
159
+ }, {
160
+ pageId: 'p2',
161
+ fieldId: 'b',
162
+ key: 'Bravo',
163
+ value: 'Bravo value',
164
+ action: {
165
+ label: 'Change B',
166
+ onAction: ON_ACTION
167
+ }
168
+ }];
169
+
170
+ var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
171
+ "data-testid": ID,
172
+ rows: ROWS
173
+ })),
174
+ container = _render4.container;
175
+
176
+ var summaryList = checkSummaryList(container, ID);
177
+ expect(summaryList.childNodes.length).toEqual(ROWS.length);
178
+ ROWS.forEach(function (row, index) {
179
+ var _checkRow5 = checkRow(summaryList, index),
180
+ _checkRow6 = _slicedToArray(_checkRow5, 3),
181
+ key = _checkRow6[0],
182
+ value = _checkRow6[1],
183
+ actions = _checkRow6[2];
184
+
185
+ expect(key.textContent).toEqual(row.key);
186
+ expect(value.textContent).toEqual(row.value);
187
+ var a = actions.childNodes[0];
188
+ expect(a.textContent).toEqual(row.action.label);
189
+
190
+ _react.fireEvent.click(a, {});
191
+
192
+ expect(ON_ACTION_CALLS.length).toEqual(index + 1);
193
+ expect(ON_ACTION_CALLS[index]).toEqual(row);
194
+ });
195
+ });
196
+ });
197
+ });
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+
8
+ var getRowActionAttributes = function getRowActionAttributes(row) {
9
+ if (row && row.action) {
10
+ if (typeof row.action.onAction === 'function') {
11
+ return {
12
+ onClick: function onClick() {
13
+ return row.action.onAction(row);
14
+ }
15
+ };
16
+ } else {
17
+ return {
18
+ href: row.action.href
19
+ };
20
+ }
21
+ }
22
+
23
+ return {};
24
+ };
25
+
26
+ var _default = getRowActionAttributes;
27
+ exports.default = _default;