UNPKG

@uplink-protocol/form-controller

Version:

Reactive multi-step form controller with dynamic validation and state management

github.com/jmkcoder/uplink-protocol-form-controller

jmkcoder/uplink-protocol-form-controller

170 lines (85 loc) • 3.55 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
[**@uplink-protocol/form-controller v0.2.6**](../README.md) *** [@uplink-protocol/form-controller](../globals.md) / FieldService # Class: FieldService Defined in: [services/field.service.ts:9](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/services/field.service.ts#L9) Service for managing field validation and errors ## Constructors ### Constructor > **new FieldService**(`configService`, `formService`, `fieldErrorsService`, `stepsValidityService`): `FieldService` Defined in: [services/field.service.ts:15](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/services/field.service.ts#L15) #### Parameters ##### configService [`ConfigService`](ConfigService.md) ##### formService [`FormService`](FormService.md) ##### fieldErrorsService [`BaseService`](BaseService.md)\<`Record`\<`string`, `Record`\<`string`, `string`\>\>\> ##### stepsValidityService [`BaseService`](BaseService.md)\<`Record`\<`string`, `boolean`\>\> #### Returns `FieldService` ## Methods ### getFieldErrorsService() > **getFieldErrorsService**(): [`BaseService`](BaseService.md)\<`Record`\<`string`, `Record`\<`string`, `string`\>\>\> Defined in: [services/field.service.ts:184](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/services/field.service.ts#L184) Get the field errors service #### Returns [`BaseService`](BaseService.md)\<`Record`\<`string`, `Record`\<`string`, `string`\>\>\> Field errors service *** ### getStepsValidityService() > **getStepsValidityService**(): [`BaseService`](BaseService.md)\<`Record`\<`string`, `boolean`\>\> Defined in: [services/field.service.ts:192](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/services/field.service.ts#L192) Get the steps validity service #### Returns [`BaseService`](BaseService.md)\<`Record`\<`string`, `boolean`\>\> Steps validity service *** ### validateField() > **validateField**(`stepId`, `fieldId`, `value?`, `showErrors?`): `boolean` Defined in: [services/field.service.ts:35](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/services/field.service.ts#L35) Validate a single field #### Parameters ##### stepId `string` Step ID ##### fieldId `string` Field ID ##### value? `any` Optional value to validate (defaults to current value in form data) ##### showErrors? `boolean` = `true` Whether to update the error state #### Returns `boolean` Validation result *** ### validateForm() > **validateForm**(`showErrors`): `boolean` Defined in: [services/field.service.ts:165](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/services/field.service.ts#L165) Validate all steps in the form #### Parameters ##### showErrors `boolean` = `true` Whether to update the error state #### Returns `boolean` Validation result *** ### validateStep() > **validateStep**(`stepId`, `showErrors`): `boolean` Defined in: [services/field.service.ts:107](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/services/field.service.ts#L107) Validate all fields in a step #### Parameters ##### stepId `string` Step ID ##### showErrors `boolean` = `true` Whether to update the error state #### Returns `boolean` Validation result