@ukhomeoffice/cop-react-form-renderer 2.0.0 → 2.5.0
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.
- package/LICENSE +21 -0
- package/README.md +12 -0
- package/dist/components/CheckYourAnswers/CheckYourAnswers.js +16 -5
- package/dist/components/CheckYourAnswers/CheckYourAnswers.stories.mdx +199 -79
- package/dist/components/CheckYourAnswers/CheckYourAnswers.test.js +44 -0
- package/dist/components/FormComponent/FormComponent.js +6 -1
- package/dist/components/FormComponent/FormComponent.test.js +67 -0
- package/dist/components/FormRenderer/FormRenderer.js +122 -11
- package/dist/components/FormRenderer/FormRenderer.stories.mdx +115 -49
- package/dist/components/FormRenderer/FormRenderer.test.js +275 -0
- package/dist/components/FormRenderer/helpers/getNextPageId.js +3 -0
- package/dist/components/FormRenderer/helpers/getNextPageId.test.js +6 -0
- package/dist/components/FormRenderer/helpers/getPage.js +1 -1
- package/dist/components/FormRenderer/helpers/getSubmissionStatus.js +18 -1
- package/dist/components/FormRenderer/helpers/getSubmissionStatus.test.js +44 -6
- package/dist/components/FormRenderer/helpers/getUpdatedSectionStates.js +50 -0
- package/dist/components/FormRenderer/helpers/getUpdatedSectionStates.test.js +122 -0
- package/dist/components/FormRenderer/helpers/index.js +7 -1
- package/dist/components/SummaryList/SummaryList.js +7 -4
- package/dist/components/SummaryList/SummaryList.scss +10 -2
- package/dist/components/SummaryList/SummaryList.stories.mdx +64 -10
- package/dist/components/SummaryList/SummaryList.test.js +54 -0
- package/dist/components/TaskList/Task.js +83 -0
- package/dist/components/TaskList/Task.test.js +112 -0
- package/dist/components/TaskList/TaskList.js +112 -0
- package/dist/components/TaskList/TaskList.scss +70 -0
- package/dist/components/TaskList/TaskList.stories.mdx +57 -0
- package/dist/components/TaskList/TaskList.test.js +223 -0
- package/dist/components/TaskList/TaskState.js +42 -0
- package/dist/components/TaskList/TaskState.test.js +99 -0
- package/dist/components/TaskList/index.js +13 -0
- package/dist/hooks/useHooks.js +5 -1
- package/dist/index.js +8 -0
- package/dist/json/taskList.json +228 -0
- package/dist/json/userProfile.data.json +2 -1
- package/dist/models/ComponentTypes.js +3 -1
- package/dist/models/FormTypes.js +2 -0
- package/dist/models/HubFormats.js +3 -1
- package/dist/models/PageAction.js +5 -0
- package/dist/models/TaskStates.js +41 -0
- package/dist/models/index.js +8 -0
- package/dist/utils/Component/cleanAttributes.js +1 -1
- package/dist/utils/Component/getComponent.js +26 -0
- package/dist/utils/Component/isEditable.js +1 -1
- package/dist/utils/FormPage/getPageActions.js +6 -0
- package/dist/utils/Hub/getFormHub.js +4 -0
- package/dist/utils/Hub/getFormHub.test.js +10 -2
- package/dist/utils/Validate/additional/index.js +55 -0
- package/dist/utils/Validate/additional/index.test.js +69 -0
- package/dist/utils/Validate/additional/mustBeAfter.js +37 -0
- package/dist/utils/Validate/additional/mustBeAfter.test.js +98 -0
- package/dist/utils/Validate/additional/mustBeBefore.js +35 -0
- package/dist/utils/Validate/additional/mustBeBefore.test.js +66 -0
- package/dist/utils/Validate/additional/mustBeInTheFuture.js +42 -0
- package/dist/utils/Validate/additional/mustBeInTheFuture.test.js +34 -0
- package/dist/utils/Validate/additional/mustBeInThePast.js +44 -0
- package/dist/utils/Validate/additional/mustBeInThePast.test.js +34 -0
- package/dist/utils/Validate/additional/utils.js +66 -0
- package/dist/utils/Validate/validateComponent.js +38 -1
- package/dist/utils/Validate/validateComponent.test.js +48 -2
- package/dist/utils/Validate/validateDate.js +144 -0
- package/dist/utils/Validate/validateDate.test.js +112 -0
- package/dist/utils/Validate/validateRequired.js +11 -0
- package/dist/utils/Validate/validateRequired.test.js +12 -0
- package/dist/utils/Validate/validateTime.js +76 -0
- package/dist/utils/Validate/validateTime.test.js +55 -0
- package/package.json +3 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
@import
|
|
2
|
-
@import
|
|
1
|
+
@import 'node_modules/govuk-frontend/govuk/_base';
|
|
2
|
+
@import 'node_modules/govuk-frontend/govuk/components/summary-list/_summary-list';
|
|
3
3
|
|
|
4
4
|
.govuk-summary-list__actions {
|
|
5
5
|
.govuk-link {
|
|
@@ -7,3 +7,11 @@
|
|
|
7
7
|
cursor: pointer;
|
|
8
8
|
}
|
|
9
9
|
}
|
|
10
|
+
|
|
11
|
+
.caseview__key {
|
|
12
|
+
font-weight: normal;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
.caseview__value {
|
|
16
|
+
@include govuk-typography-weight-bold;
|
|
17
|
+
}
|
|
@@ -1,36 +1,90 @@
|
|
|
1
1
|
<!-- Global imports -->
|
|
2
|
+
|
|
2
3
|
import { ArgsTable, Canvas, Meta, Story } from '@storybook/addon-docs';
|
|
3
4
|
import { Details, Heading } from '@ukhomeoffice/cop-react-components';
|
|
4
5
|
|
|
5
6
|
<!-- Local imports -->
|
|
7
|
+
|
|
6
8
|
import Utils from '../../utils';
|
|
7
9
|
import SummaryList from './SummaryList';
|
|
8
10
|
|
|
9
|
-
<Meta
|
|
11
|
+
<Meta
|
|
12
|
+
title='Components/Summary list'
|
|
13
|
+
id='D-SummaryList'
|
|
14
|
+
component={SummaryList}
|
|
15
|
+
/>
|
|
10
16
|
|
|
11
|
-
<Heading size=
|
|
17
|
+
<Heading size='xl' caption='Components'>
|
|
18
|
+
Summary list
|
|
19
|
+
</Heading>
|
|
12
20
|
|
|
13
21
|
Renders a list of key-value pairs, most commonly on the **Check your answers** screen, and optionally
|
|
14
22
|
display action links.
|
|
15
23
|
|
|
16
24
|
<Canvas withToolbar>
|
|
17
|
-
<Story name=
|
|
25
|
+
<Story name='Default'>
|
|
18
26
|
{() => {
|
|
19
27
|
const onAction = (row) => {
|
|
20
28
|
console.log('action clicked', row);
|
|
21
29
|
};
|
|
22
30
|
const ROWS = [
|
|
23
|
-
{
|
|
31
|
+
{
|
|
32
|
+
pageId: 'p1',
|
|
33
|
+
fieldId: 'forename',
|
|
34
|
+
key: 'Forename(s)',
|
|
35
|
+
value: 'John',
|
|
36
|
+
},
|
|
24
37
|
{ pageId: 'p1', fieldId: 'surname', key: 'Surname', value: 'Smith' },
|
|
25
|
-
{
|
|
38
|
+
{
|
|
39
|
+
pageId: 'p2',
|
|
40
|
+
fieldId: 'dob',
|
|
41
|
+
key: 'Date of birth',
|
|
42
|
+
value: '29/08/1993',
|
|
43
|
+
action: { label: 'Change', onAction },
|
|
44
|
+
},
|
|
26
45
|
];
|
|
27
|
-
return
|
|
28
|
-
<SummaryList rows={ROWS} />
|
|
29
|
-
);
|
|
46
|
+
return <SummaryList rows={ROWS} />;
|
|
30
47
|
}}
|
|
31
48
|
</Story>
|
|
32
49
|
</Canvas>
|
|
33
50
|
|
|
34
|
-
<Details summary=
|
|
35
|
-
<ArgsTable of={
|
|
51
|
+
<Details summary='Properties' className='no-indent'>
|
|
52
|
+
<ArgsTable of={SummaryList} />
|
|
36
53
|
</Details>
|
|
54
|
+
|
|
55
|
+
## Variant
|
|
56
|
+
|
|
57
|
+
### Read-only style
|
|
58
|
+
|
|
59
|
+
<Canvas>
|
|
60
|
+
<Story name='Read-only style'>
|
|
61
|
+
{() => {
|
|
62
|
+
const onAction = (row) => {
|
|
63
|
+
console.log('action clicked', row);
|
|
64
|
+
};
|
|
65
|
+
const ROWS = [
|
|
66
|
+
{
|
|
67
|
+
pageId: 'p1',
|
|
68
|
+
fieldId: 'forename',
|
|
69
|
+
key: 'Forename(s)',
|
|
70
|
+
value: 'John',
|
|
71
|
+
},
|
|
72
|
+
{ pageId: 'p1', fieldId: 'surname', key: 'Surname', value: 'Smith' },
|
|
73
|
+
{
|
|
74
|
+
pageId: 'p2',
|
|
75
|
+
fieldId: 'dob',
|
|
76
|
+
key: 'Date of birth',
|
|
77
|
+
value: '29/08/1993',
|
|
78
|
+
action: { label: 'Change', onAction },
|
|
79
|
+
},
|
|
80
|
+
];
|
|
81
|
+
return (
|
|
82
|
+
<SummaryList
|
|
83
|
+
classModifiers='no-border'
|
|
84
|
+
rows={ROWS}
|
|
85
|
+
noChangeAction={true}
|
|
86
|
+
/>
|
|
87
|
+
);
|
|
88
|
+
}}
|
|
89
|
+
</Story>
|
|
90
|
+
</Canvas>
|
|
@@ -54,6 +54,23 @@ describe('components', function () {
|
|
|
54
54
|
return [key, value, actions];
|
|
55
55
|
};
|
|
56
56
|
|
|
57
|
+
var checkRowNoChangeActions = function checkRowNoChangeActions(summaryList, index) {
|
|
58
|
+
var row = summaryList.childNodes[index];
|
|
59
|
+
expect(row.tagName).toEqual('DIV');
|
|
60
|
+
expect(row.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__row"));
|
|
61
|
+
|
|
62
|
+
var _row$childNodes2 = _slicedToArray(row.childNodes, 2),
|
|
63
|
+
key = _row$childNodes2[0],
|
|
64
|
+
value = _row$childNodes2[1];
|
|
65
|
+
|
|
66
|
+
expect(key.tagName).toEqual('DT');
|
|
67
|
+
expect(key.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__key"));
|
|
68
|
+
expect(value.tagName).toEqual('DD');
|
|
69
|
+
expect(value.classList).toContain("".concat(_SummaryList.DEFAULT_CLASS, "__value"));
|
|
70
|
+
expect(row.childNodes.length).toEqual(2);
|
|
71
|
+
return [key, value];
|
|
72
|
+
};
|
|
73
|
+
|
|
57
74
|
it('should handle an empty rows array', function () {
|
|
58
75
|
var ID = 'test-id';
|
|
59
76
|
var ROWS = [];
|
|
@@ -193,5 +210,42 @@ describe('components', function () {
|
|
|
193
210
|
expect(ON_ACTION_CALLS[index]).toEqual(row);
|
|
194
211
|
});
|
|
195
212
|
});
|
|
213
|
+
it('should handle rows with component values and actions set to hidden', function () {
|
|
214
|
+
var ID = 'test-id';
|
|
215
|
+
var VALUES = ['Alpha component value', 'Bravo component value'];
|
|
216
|
+
var ROWS = [{
|
|
217
|
+
pageId: 'p1',
|
|
218
|
+
fieldId: 'a',
|
|
219
|
+
key: 'Alpha',
|
|
220
|
+
value: /*#__PURE__*/_react2.default.createElement("div", null, VALUES[0])
|
|
221
|
+
}, {
|
|
222
|
+
pageId: 'p2',
|
|
223
|
+
fieldId: 'b',
|
|
224
|
+
key: 'Bravo',
|
|
225
|
+
value: /*#__PURE__*/_react2.default.createElement("div", null, VALUES[1])
|
|
226
|
+
}];
|
|
227
|
+
|
|
228
|
+
var _render5 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
|
|
229
|
+
"data-testid": ID,
|
|
230
|
+
rows: ROWS,
|
|
231
|
+
noChangeAction: true
|
|
232
|
+
})),
|
|
233
|
+
container = _render5.container;
|
|
234
|
+
|
|
235
|
+
var summaryList = checkSummaryList(container, ID);
|
|
236
|
+
expect(summaryList.childNodes.length).toEqual(ROWS.length);
|
|
237
|
+
ROWS.forEach(function (row, index) {
|
|
238
|
+
var _checkRowNoChangeActi = checkRowNoChangeActions(summaryList, index),
|
|
239
|
+
_checkRowNoChangeActi2 = _slicedToArray(_checkRowNoChangeActi, 2),
|
|
240
|
+
key = _checkRowNoChangeActi2[0],
|
|
241
|
+
value = _checkRowNoChangeActi2[1];
|
|
242
|
+
|
|
243
|
+
expect(key.textContent).toEqual(row.key);
|
|
244
|
+
expect(value.childNodes.length).toEqual(1);
|
|
245
|
+
var valueDiv = value.childNodes[0];
|
|
246
|
+
expect(valueDiv.tagName).toEqual('DIV');
|
|
247
|
+
expect(valueDiv.textContent).toEqual(VALUES[index]);
|
|
248
|
+
});
|
|
249
|
+
});
|
|
196
250
|
});
|
|
197
251
|
});
|
|
@@ -0,0 +1,83 @@
|
|
|
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
|
+
Object.defineProperty(exports, "__esModule", {
|
|
6
|
+
value: true
|
|
7
|
+
});
|
|
8
|
+
exports.default = exports.DEFAULT_CLASS = void 0;
|
|
9
|
+
|
|
10
|
+
var _propTypes = _interopRequireDefault(require("prop-types"));
|
|
11
|
+
|
|
12
|
+
var _react = _interopRequireWildcard(require("react"));
|
|
13
|
+
|
|
14
|
+
var _copReactComponents = require("@ukhomeoffice/cop-react-components");
|
|
15
|
+
|
|
16
|
+
var _models = require("../../models");
|
|
17
|
+
|
|
18
|
+
var _TaskState = _interopRequireDefault(require("./TaskState"));
|
|
19
|
+
|
|
20
|
+
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); }
|
|
21
|
+
|
|
22
|
+
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; }
|
|
23
|
+
|
|
24
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
25
|
+
|
|
26
|
+
function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
|
|
27
|
+
|
|
28
|
+
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."); }
|
|
29
|
+
|
|
30
|
+
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); }
|
|
31
|
+
|
|
32
|
+
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; }
|
|
33
|
+
|
|
34
|
+
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; }
|
|
35
|
+
|
|
36
|
+
function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
|
|
37
|
+
|
|
38
|
+
var DEFAULT_CLASS = 'hods-task-list';
|
|
39
|
+
exports.DEFAULT_CLASS = DEFAULT_CLASS;
|
|
40
|
+
|
|
41
|
+
var Task = function Task(_ref) {
|
|
42
|
+
var task = _ref.task,
|
|
43
|
+
_onClick = _ref.onClick;
|
|
44
|
+
|
|
45
|
+
var classes = _copReactComponents.Utils.classBuilder(DEFAULT_CLASS, undefined, undefined);
|
|
46
|
+
|
|
47
|
+
var _useState = (0, _react.useState)(task.state !== _models.TaskStates.TYPES.CANNOT_START_YET),
|
|
48
|
+
_useState2 = _slicedToArray(_useState, 2),
|
|
49
|
+
linkActive = _useState2[0],
|
|
50
|
+
setLinkActive = _useState2[1];
|
|
51
|
+
|
|
52
|
+
var _useState3 = (0, _react.useState)(task.state),
|
|
53
|
+
_useState4 = _slicedToArray(_useState3, 2),
|
|
54
|
+
currentState = _useState4[0],
|
|
55
|
+
setCurrentState = _useState4[1];
|
|
56
|
+
|
|
57
|
+
(0, _react.useEffect)(function () {
|
|
58
|
+
setLinkActive(task.state !== _models.TaskStates.TYPES.CANNOT_START_YET);
|
|
59
|
+
setCurrentState(task.state);
|
|
60
|
+
}, [task.state, setLinkActive, setCurrentState]);
|
|
61
|
+
return /*#__PURE__*/_react.default.createElement("li", {
|
|
62
|
+
className: classes('item')
|
|
63
|
+
}, /*#__PURE__*/_react.default.createElement("span", {
|
|
64
|
+
className: classes('task-name')
|
|
65
|
+
}, linkActive ? /*#__PURE__*/_react.default.createElement(_copReactComponents.Link, {
|
|
66
|
+
onClick: function onClick() {
|
|
67
|
+
return _onClick(task);
|
|
68
|
+
}
|
|
69
|
+
}, task.name) : task.name), /*#__PURE__*/_react.default.createElement(_TaskState.default, {
|
|
70
|
+
state: currentState
|
|
71
|
+
}));
|
|
72
|
+
};
|
|
73
|
+
|
|
74
|
+
Task.propTypes = {
|
|
75
|
+
task: _propTypes.default.shape({
|
|
76
|
+
name: _propTypes.default.string.isRequired,
|
|
77
|
+
pages: _propTypes.default.array.isRequired,
|
|
78
|
+
state: _propTypes.default.string.isRequired
|
|
79
|
+
}).isRequired,
|
|
80
|
+
onClick: _propTypes.default.func.isRequired
|
|
81
|
+
};
|
|
82
|
+
var _default = Task;
|
|
83
|
+
exports.default = _default;
|
|
@@ -0,0 +1,112 @@
|
|
|
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 _Task = _interopRequireDefault(require("./Task"));
|
|
10
|
+
|
|
11
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
12
|
+
|
|
13
|
+
// Global imports
|
|
14
|
+
// Local imports
|
|
15
|
+
describe('components', function () {
|
|
16
|
+
describe('TaskList.Task', function () {
|
|
17
|
+
it('should render a task', function () {
|
|
18
|
+
var STATE = _models.TaskStates.TYPES.COMPLETE;
|
|
19
|
+
var TASK = {
|
|
20
|
+
name: 'taskName',
|
|
21
|
+
pages: ['pageName'],
|
|
22
|
+
state: STATE
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
var ON_CLICK = function ON_CLICK() {};
|
|
26
|
+
|
|
27
|
+
var _render = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Task.default, {
|
|
28
|
+
task: TASK,
|
|
29
|
+
onClick: ON_CLICK
|
|
30
|
+
})),
|
|
31
|
+
container = _render.container;
|
|
32
|
+
|
|
33
|
+
expect(container.childNodes.length).toEqual(1);
|
|
34
|
+
expect(container.childNodes[0].classList).toContain('hods-task-list__item');
|
|
35
|
+
var span = container.childNodes[0].childNodes[0];
|
|
36
|
+
var state = container.childNodes[0].childNodes[1];
|
|
37
|
+
expect(span.classList).toContain('hods-task-list__task-name');
|
|
38
|
+
expect(state.textContent).toEqual('Completed');
|
|
39
|
+
});
|
|
40
|
+
it('should render a task with inactive link if state is cannotStartYet', function () {
|
|
41
|
+
var NAME = 'taskName';
|
|
42
|
+
var STATE = _models.TaskStates.TYPES.CANNOT_START_YET;
|
|
43
|
+
var TASK = {
|
|
44
|
+
name: 'taskName',
|
|
45
|
+
pages: ['pageName'],
|
|
46
|
+
state: STATE
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
var ON_CLICK = function ON_CLICK() {};
|
|
50
|
+
|
|
51
|
+
var _render2 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Task.default, {
|
|
52
|
+
task: TASK,
|
|
53
|
+
onClick: ON_CLICK
|
|
54
|
+
})),
|
|
55
|
+
container = _render2.container;
|
|
56
|
+
|
|
57
|
+
var span = container.childNodes[0].childNodes[0];
|
|
58
|
+
expect(span.childNodes[0].tagName).toEqual(undefined);
|
|
59
|
+
expect(span.textContent).toEqual(NAME);
|
|
60
|
+
});
|
|
61
|
+
it('should render a task with a link if state is not cannotStartYet', function () {
|
|
62
|
+
var STATE = _models.TaskStates.TYPES.IN_PROGRESS;
|
|
63
|
+
var TASK = {
|
|
64
|
+
name: 'taskName',
|
|
65
|
+
pages: ['pageName'],
|
|
66
|
+
state: STATE
|
|
67
|
+
};
|
|
68
|
+
|
|
69
|
+
var ON_CLICK = function ON_CLICK() {};
|
|
70
|
+
|
|
71
|
+
var _render3 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Task.default, {
|
|
72
|
+
task: TASK,
|
|
73
|
+
onClick: ON_CLICK
|
|
74
|
+
})),
|
|
75
|
+
container = _render3.container;
|
|
76
|
+
|
|
77
|
+
var span = container.childNodes[0].childNodes[0];
|
|
78
|
+
expect(span.childNodes.length).toEqual(1);
|
|
79
|
+
expect(span.childNodes[0].tagName).toEqual('A');
|
|
80
|
+
});
|
|
81
|
+
it('should call then given onClick function when the link is clicked', function () {
|
|
82
|
+
var STATE = _models.TaskStates.TYPES.IN_PROGRESS;
|
|
83
|
+
var TASK = {
|
|
84
|
+
name: 'taskName',
|
|
85
|
+
pages: ['pageName'],
|
|
86
|
+
state: STATE
|
|
87
|
+
};
|
|
88
|
+
var ON_CLICK_CALLS = [];
|
|
89
|
+
|
|
90
|
+
var ON_CLICK = function ON_CLICK(value) {
|
|
91
|
+
ON_CLICK_CALLS.push(value);
|
|
92
|
+
};
|
|
93
|
+
|
|
94
|
+
var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_Task.default, {
|
|
95
|
+
task: TASK,
|
|
96
|
+
onClick: ON_CLICK
|
|
97
|
+
})),
|
|
98
|
+
container = _render4.container;
|
|
99
|
+
|
|
100
|
+
var link = container.childNodes[0].childNodes[0].childNodes[0];
|
|
101
|
+
|
|
102
|
+
_react.fireEvent.click(link);
|
|
103
|
+
|
|
104
|
+
expect(ON_CLICK_CALLS.length).toEqual(1);
|
|
105
|
+
expect(ON_CLICK_CALLS[0]).toEqual({
|
|
106
|
+
pages: ['pageName'],
|
|
107
|
+
name: "taskName",
|
|
108
|
+
state: STATE
|
|
109
|
+
});
|
|
110
|
+
});
|
|
111
|
+
});
|
|
112
|
+
});
|
|
@@ -0,0 +1,112 @@
|
|
|
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
|
+
Object.defineProperty(exports, "__esModule", {
|
|
6
|
+
value: true
|
|
7
|
+
});
|
|
8
|
+
exports.default = exports.DEFAULT_CLASS = void 0;
|
|
9
|
+
|
|
10
|
+
var _propTypes = _interopRequireDefault(require("prop-types"));
|
|
11
|
+
|
|
12
|
+
var _react = _interopRequireWildcard(require("react"));
|
|
13
|
+
|
|
14
|
+
var _copReactComponents = require("@ukhomeoffice/cop-react-components");
|
|
15
|
+
|
|
16
|
+
var _models = require("../../models");
|
|
17
|
+
|
|
18
|
+
var _Task = _interopRequireDefault(require("./Task"));
|
|
19
|
+
|
|
20
|
+
require("./TaskList.scss");
|
|
21
|
+
|
|
22
|
+
var _excluded = ["refTitle", "refNumber", "sections", "fieldId", "onTaskAction", "classBlock", "classModifiers", "className"];
|
|
23
|
+
|
|
24
|
+
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); }
|
|
25
|
+
|
|
26
|
+
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; }
|
|
27
|
+
|
|
28
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
29
|
+
|
|
30
|
+
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); }
|
|
31
|
+
|
|
32
|
+
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
|
+
|
|
34
|
+
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; }
|
|
35
|
+
|
|
36
|
+
var DEFAULT_CLASS = 'hods-task-list';
|
|
37
|
+
exports.DEFAULT_CLASS = DEFAULT_CLASS;
|
|
38
|
+
|
|
39
|
+
var TaskList = function TaskList(_ref) {
|
|
40
|
+
var refTitle = _ref.refTitle,
|
|
41
|
+
refNumber = _ref.refNumber,
|
|
42
|
+
sections = _ref.sections,
|
|
43
|
+
fieldId = _ref.fieldId,
|
|
44
|
+
onTaskAction = _ref.onTaskAction,
|
|
45
|
+
classBlock = _ref.classBlock,
|
|
46
|
+
classModifiers = _ref.classModifiers,
|
|
47
|
+
className = _ref.className,
|
|
48
|
+
attrs = _objectWithoutProperties(_ref, _excluded);
|
|
49
|
+
|
|
50
|
+
var classes = _copReactComponents.Utils.classBuilder(classBlock, classModifiers, className); //TODO state will be retrieved from a document in S3 rather than given in the component definition, covered under COP-9885
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
var numberOfCompleteSections = sections.reduce(function (totalComplete, currentSection) {
|
|
54
|
+
return totalComplete + currentSection.tasks.filter(function (t) {
|
|
55
|
+
return t.state === _models.TaskStates.TYPES.COMPLETE;
|
|
56
|
+
}).length;
|
|
57
|
+
}, 0);
|
|
58
|
+
var numberOfSections = sections.reduce(function (totalSections, current) {
|
|
59
|
+
return totalSections + current.tasks.length;
|
|
60
|
+
}, 0);
|
|
61
|
+
|
|
62
|
+
var onClick = function onClick(task) {
|
|
63
|
+
if (typeof onTaskAction === 'function') {
|
|
64
|
+
onTaskAction(task);
|
|
65
|
+
}
|
|
66
|
+
};
|
|
67
|
+
|
|
68
|
+
return /*#__PURE__*/_react.default.createElement("div", _extends({}, attrs, {
|
|
69
|
+
className: classes()
|
|
70
|
+
}), /*#__PURE__*/_react.default.createElement("h2", {
|
|
71
|
+
className: "govuk-heading-s govuk-!-margin-bottom-2"
|
|
72
|
+
}, "".concat(refTitle, " ").concat(refNumber)), numberOfSections !== numberOfCompleteSections && /*#__PURE__*/_react.default.createElement("h2", {
|
|
73
|
+
className: "govuk-heading-s govuk-!-margin-bottom-2"
|
|
74
|
+
}, "Incomplete form"), /*#__PURE__*/_react.default.createElement("p", {
|
|
75
|
+
className: "govuk-body govuk-!-margin-bottom-7"
|
|
76
|
+
}, "You have completed ".concat(numberOfCompleteSections, " of ").concat(numberOfSections, " sections")), sections.map(function (section, index) {
|
|
77
|
+
return /*#__PURE__*/_react.default.createElement(_react.Fragment, {
|
|
78
|
+
key: "".concat(section.name)
|
|
79
|
+
}, /*#__PURE__*/_react.default.createElement("h2", {
|
|
80
|
+
className: classes('section')
|
|
81
|
+
}, sections.length > 1 ? "".concat(index + 1, ". ") : '', section.name), /*#__PURE__*/_react.default.createElement("ol", {
|
|
82
|
+
className: classes('items')
|
|
83
|
+
}, section.tasks.map(function (task) {
|
|
84
|
+
return /*#__PURE__*/_react.default.createElement(_Task.default, {
|
|
85
|
+
key: "".concat(section.name, "-").concat(task.name),
|
|
86
|
+
task: task,
|
|
87
|
+
onClick: onClick
|
|
88
|
+
});
|
|
89
|
+
})));
|
|
90
|
+
}));
|
|
91
|
+
};
|
|
92
|
+
|
|
93
|
+
TaskList.propTypes = {
|
|
94
|
+
refNumber: _propTypes.default.string,
|
|
95
|
+
refTitle: _propTypes.default.string,
|
|
96
|
+
sections: _propTypes.default.arrayOf(_propTypes.default.shape({
|
|
97
|
+
name: _propTypes.default.string.isRequired,
|
|
98
|
+
tasks: _propTypes.default.arrayOf(_propTypes.default.shape({
|
|
99
|
+
name: _propTypes.default.string.isRequired,
|
|
100
|
+
pages: _propTypes.default.array.isRequired,
|
|
101
|
+
state: _propTypes.default.string.isRequired
|
|
102
|
+
})).isRequired
|
|
103
|
+
})).isRequired,
|
|
104
|
+
classBlock: _propTypes.default.string,
|
|
105
|
+
classModifiers: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)]),
|
|
106
|
+
className: _propTypes.default.string
|
|
107
|
+
};
|
|
108
|
+
TaskList.defaultProps = {
|
|
109
|
+
classBlock: DEFAULT_CLASS
|
|
110
|
+
};
|
|
111
|
+
var _default = TaskList;
|
|
112
|
+
exports.default = _default;
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
@import 'node_modules/govuk-frontend/govuk/_base';
|
|
2
|
+
|
|
3
|
+
// Task list pattern
|
|
4
|
+
|
|
5
|
+
.hods-task-list {
|
|
6
|
+
list-style-type: none;
|
|
7
|
+
padding-left: 0;
|
|
8
|
+
margin-top: 0;
|
|
9
|
+
margin-bottom: 0;
|
|
10
|
+
@include govuk-media-query($from: tablet) {
|
|
11
|
+
min-width: 550px;
|
|
12
|
+
}
|
|
13
|
+
.hods-task-list__items {
|
|
14
|
+
@include govuk-font($size: 19);
|
|
15
|
+
@include govuk-responsive-margin(9, 'bottom');
|
|
16
|
+
list-style: none;
|
|
17
|
+
padding-left: 0;
|
|
18
|
+
@include govuk-media-query($from: tablet) {
|
|
19
|
+
padding-left: govuk-spacing(6);
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
.hods-task-list__section {
|
|
25
|
+
display: table;
|
|
26
|
+
@include govuk-font($size: 24, $weight: bold);
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
.hods-task-list__section-number {
|
|
30
|
+
display: table-cell;
|
|
31
|
+
|
|
32
|
+
@include govuk-media-query($from: tablet) {
|
|
33
|
+
min-width: govuk-spacing(6);
|
|
34
|
+
padding-right: 0;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
.hods-task-list__item {
|
|
39
|
+
border-bottom: 1px solid $govuk-border-colour;
|
|
40
|
+
margin-bottom: 0 !important;
|
|
41
|
+
padding-top: govuk-spacing(2);
|
|
42
|
+
padding-bottom: govuk-spacing(2);
|
|
43
|
+
@include govuk-clearfix;
|
|
44
|
+
&:first-child {
|
|
45
|
+
border-top: 1px solid $govuk-border-colour;
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
.hods-task-list__task-name {
|
|
50
|
+
display: block;
|
|
51
|
+
cursor: pointer;
|
|
52
|
+
@include govuk-media-query($from: 450px) {
|
|
53
|
+
float: left;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
// The `hods-task-list__task-completed` class was previously used on the task
|
|
58
|
+
// list for the completed tag (changed in 86c90ec) – it's still included here to
|
|
59
|
+
// avoid breaking task lists in existing prototypes.
|
|
60
|
+
.hods-task-list__tag,
|
|
61
|
+
.hods-task-list__task-completed {
|
|
62
|
+
margin-top: govuk-spacing(2);
|
|
63
|
+
margin-bottom: govuk-spacing(1);
|
|
64
|
+
|
|
65
|
+
@include govuk-media-query($from: 450px) {
|
|
66
|
+
float: right;
|
|
67
|
+
margin-top: 0;
|
|
68
|
+
margin-bottom: 0;
|
|
69
|
+
}
|
|
70
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
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 TaskList from './TaskList';
|
|
8
|
+
|
|
9
|
+
<Meta title="Components/Task list" id="D-TaskList" component={ TaskList } />
|
|
10
|
+
|
|
11
|
+
<Heading size="xl" caption="Components">Task list</Heading>
|
|
12
|
+
|
|
13
|
+
Renders a list of tasks along with the current status for each. Each task that is not in the `Cannot start yet` state can be
|
|
14
|
+
selected to navigate to that task.
|
|
15
|
+
|
|
16
|
+
<Canvas withToolbar>
|
|
17
|
+
<Story name="Default">
|
|
18
|
+
{() => {
|
|
19
|
+
const onAction = (row) => {
|
|
20
|
+
console.log('action clicked', row);
|
|
21
|
+
};
|
|
22
|
+
const COP_REF = '123';
|
|
23
|
+
const REF_TITLE = 'COP reference number';
|
|
24
|
+
const SECTIONS = [
|
|
25
|
+
{
|
|
26
|
+
name: 'Add event details',
|
|
27
|
+
tasks: [
|
|
28
|
+
{ name: 'Date, location and mode details', state: 'complete' },
|
|
29
|
+
{ name: 'Officer and agency details', state: 'inProgress' },
|
|
30
|
+
],
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
name: 'Add people details',
|
|
34
|
+
tasks: [
|
|
35
|
+
{ name: 'People details', state: 'complete' },
|
|
36
|
+
{ name: 'Immigration details', state: 'inProgress' },
|
|
37
|
+
{ name: 'Journey details', state: 'notStarted' },
|
|
38
|
+
],
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
name: 'Add item details',
|
|
42
|
+
tasks: [
|
|
43
|
+
{ name: 'Item details', state: 'cannotStartYet' },
|
|
44
|
+
{ name: 'Search and interception details', state: 'cannotStartYet' },
|
|
45
|
+
],
|
|
46
|
+
},
|
|
47
|
+
];
|
|
48
|
+
return (
|
|
49
|
+
<TaskList refNumber={COP_REF} refTitle={REF_TITLE} sections={SECTIONS} />
|
|
50
|
+
);
|
|
51
|
+
}}
|
|
52
|
+
</Story>
|
|
53
|
+
</Canvas>
|
|
54
|
+
|
|
55
|
+
<Details summary="Properties" className="no-indent">
|
|
56
|
+
<ArgsTable of={ TaskList } />
|
|
57
|
+
</Details>
|