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

79 lines (41 loc) • 2.28 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
[**@uplink-protocol/form-controller v0.2.6**](../README.md) *** [@uplink-protocol/form-controller](../globals.md) / FormStep # Interface: FormStep Defined in: [interfaces/form-step.interface.ts:7](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/interfaces/form-step.interface.ts#L7) Step configuration for dynamic multi-step forms. Each step contains a set of related fields and optional validation. ## Properties ### description? > `optional` **description**: `string` Defined in: [interfaces/form-step.interface.ts:15](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/interfaces/form-step.interface.ts#L15) Optional description text for the step *** ### fields > **fields**: `Record`\<`string`, [`Field`](Field.md)\> Defined in: [interfaces/form-step.interface.ts:21](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/interfaces/form-step.interface.ts#L21) Map of fields contained in this step. Keys are field IDs, values are field configurations. *** ### id > **id**: `string` Defined in: [interfaces/form-step.interface.ts:9](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/interfaces/form-step.interface.ts#L9) Unique identifier for the step *** ### title > **title**: `string` Defined in: [interfaces/form-step.interface.ts:12](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/interfaces/form-step.interface.ts#L12) Display title for the step *** ### validation()? > `optional` **validation**: (`formData`) => `string` \| `boolean` Defined in: [interfaces/form-step.interface.ts:30](https://github.com/jmkcoder/uplink-protocol-form-controller/blob/b4197b802291c2a362dd28d04ee111d1534495f5/src/interfaces/form-step.interface.ts#L30) Optional custom validation function for the entire step. Called after all individual field validations have passed. #### Parameters ##### formData `Record`\<`string`, `any`\> The current form data for all steps #### Returns `string` \| `boolean` true if valid, or an error message string if invalid