@genesislcap/foundation-forms 14.302.1-alpha-475e82d.0 → 14.302.1-alpha-ecc0cfb.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.
Files changed (39) hide show
  1. package/dist/dts/filters/filters.template.d.ts.map +1 -1
  2. package/dist/dts/form.d.ts +226 -272
  3. package/dist/dts/form.d.ts.map +1 -1
  4. package/dist/dts/form.styles.d.ts.map +1 -1
  5. package/dist/dts/form.template.d.ts.map +1 -1
  6. package/dist/dts/jsonforms/json-forms.d.ts.map +1 -1
  7. package/dist/dts/jsonforms/renderers/ArrayListWrapperRenderer.d.ts.map +1 -1
  8. package/dist/dts/jsonforms/renderers/BooleanControlRenderer.d.ts.map +1 -1
  9. package/dist/dts/jsonforms/renderers/CategorizationWrapperRenderer.d.ts.map +1 -1
  10. package/dist/dts/jsonforms/renderers/ConnectedMultiselectControlRenderer.d.ts.map +1 -1
  11. package/dist/dts/jsonforms/renderers/ConnectedSelectControlRenderer.d.ts.map +1 -1
  12. package/dist/dts/jsonforms/renderers/DateControlRenderer.d.ts.map +1 -1
  13. package/dist/dts/jsonforms/renderers/EnumControlRenderer.d.ts.map +1 -1
  14. package/dist/dts/jsonforms/renderers/FilterDateControlRenderer.d.ts.map +1 -1
  15. package/dist/dts/jsonforms/renderers/FilterNumberControlRenderer.d.ts.map +1 -1
  16. package/dist/dts/jsonforms/renderers/FilterTimeControlRenderer.d.ts.map +1 -1
  17. package/dist/dts/jsonforms/renderers/NumberControlRenderer.d.ts.map +1 -1
  18. package/dist/dts/jsonforms/renderers/StepperWrapperRenderer.d.ts.map +1 -1
  19. package/dist/dts/jsonforms/renderers/StringArrayControlRenderer.d.ts.map +1 -1
  20. package/dist/dts/jsonforms/renderers/StringControlRenderer.d.ts.map +1 -1
  21. package/dist/dts/jsonforms/testers/isArray.d.ts.map +1 -1
  22. package/dist/dts/jsonforms/testers/optionIs.d.ts.map +1 -1
  23. package/dist/dts/tsdoc-metadata.json +1 -1
  24. package/dist/dts/utils/filters.d.ts.map +1 -1
  25. package/dist/dts/utils/validation.d.ts.map +1 -1
  26. package/dist/esm/filters/filters.js +1 -1
  27. package/dist/esm/form.js +1 -1
  28. package/dist/foundation-forms.api.json +11 -29
  29. package/dist/foundation-forms.d.ts +226 -272
  30. package/docs/api/foundation-forms.filters.filternamechanged.md +4 -45
  31. package/docs/api/foundation-forms.filters.loadfilterdata.md +3 -31
  32. package/docs/api/foundation-forms.filters.md +21 -314
  33. package/docs/api/foundation-forms.form.md +14 -224
  34. package/docs/api/foundation-forms.form.reset.md +3 -33
  35. package/docs/api/foundation-forms.md +28 -293
  36. package/docs/api/foundation-forms.mustmatch.md +1 -44
  37. package/docs/api/index.md +3 -21
  38. package/package.json +19 -17
  39. package/docs/api-report.md.api.md +0 -302
package/docs/api/foundation-forms.filters.filternamechanged.md CHANGED
@@ -12,51 +12,10 @@ filterNameChanged(oldValue: string, newValue: string): void;
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- oldValue
34
-
35
-
36
- </td><td>
37
-
38
- string
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- <tr><td>
46
-
47
- newValue
48
-
49
-
50
- </td><td>
51
-
52
- string
53
-
54
-
55
- </td><td>
56
-
57
-
58
- </td></tr>
59
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | oldValue | string | |
18
+ | newValue | string | |
60
19
 
61
20
  **Returns:**
62
21
 
package/docs/api/foundation-forms.filters.loadfilterdata.md CHANGED
@@ -12,37 +12,9 @@ loadFilterData(filterKey: string): Promise<void>;
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- filterKey
34
-
35
-
36
- </td><td>
37
-
38
- string
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | filterKey | string | |
46
18
 
47
19
  **Returns:**
48
20
 
package/docs/api/foundation-forms.filters.md CHANGED
@@ -15,321 +15,28 @@ export declare class Filters extends FoundationElement
15
15
 
16
16
  ## Properties
17
17
 
18
- <table><thead><tr><th>
19
-
20
- Property
21
-
22
-
23
- </th><th>
24
-
25
- Modifiers
26
-
27
-
28
- </th><th>
29
-
30
- Type
31
-
32
-
33
- </th><th>
34
-
35
- Description
36
-
37
-
38
- </th></tr></thead>
39
- <tbody><tr><td>
40
-
41
- [allSavedFilters](./foundation-forms.filters.allsavedfilters.md)
42
-
43
-
44
- </td><td>
45
-
46
-
47
- </td><td>
48
-
49
- any\[\]
50
-
51
-
52
- </td><td>
53
-
54
-
55
- </td></tr>
56
- <tr><td>
57
-
58
- [data](./foundation-forms.filters.data.md)
59
-
60
-
61
- </td><td>
62
-
63
-
64
- </td><td>
65
-
66
- any
67
-
68
-
69
- </td><td>
70
-
71
- Initial data for the filters.
72
-
73
-
74
- </td></tr>
75
- <tr><td>
76
-
77
- [filterName](./foundation-forms.filters.filtername.md)
78
-
79
-
80
- </td><td>
81
-
82
-
83
- </td><td>
84
-
85
- string
86
-
87
-
88
- </td><td>
89
-
90
-
91
- </td></tr>
92
- <tr><td>
93
-
94
- [jsonSchema](./foundation-forms.filters.jsonschema.md)
95
-
96
-
97
- </td><td>
98
-
99
-
100
- </td><td>
101
-
102
- JSONSchema7
103
-
104
-
105
- </td><td>
106
-
107
- Alternatively to providing [Form.resourceName](./foundation-forms.form.resourcename.md) you can hardcode the JSON schema on the client.
108
-
109
-
110
- </td></tr>
111
- <tr><td>
112
-
113
- [kvStorage](./foundation-forms.filters.kvstorage.md)
114
-
115
-
116
- </td><td>
117
-
118
-
119
- </td><td>
120
-
121
- KVStorage
122
-
123
-
124
- </td><td>
125
-
126
-
127
- </td></tr>
128
- <tr><td>
129
-
130
- [prefix](./foundation-forms.filters.prefix.md)
131
-
132
-
133
- </td><td>
134
-
135
-
136
- </td><td>
137
-
138
- string
139
-
140
-
141
- </td><td>
142
-
143
- Name of the design system prefix that will be used in renderers.
144
-
145
-
146
- </td></tr>
147
- <tr><td>
148
-
149
- [renderers](./foundation-forms.filters.renderers.md)
150
-
151
-
152
- </td><td>
153
-
154
-
155
- </td><td>
156
-
157
- [RendererEntry](./foundation-forms.rendererentry.md)<!-- -->\[\]
158
-
159
-
160
- </td><td>
161
-
162
- Allows to provide the main set of renderers used by the form. If not provided, the built-in renderers will be used by default.
163
-
164
-
165
- </td></tr>
166
- <tr><td>
167
-
168
- [resourceName](./foundation-forms.filters.resourcename.md)
169
-
170
-
171
- </td><td>
172
-
173
-
174
- </td><td>
175
-
176
- string
177
-
178
-
179
- </td><td>
180
-
181
- Name of the backend resource which will provide metadata used to generate filters.
182
-
183
-
184
- </td></tr>
185
- <tr><td>
186
-
187
- [showFilterPersistenceControls](./foundation-forms.filters.showfilterpersistencecontrols.md)
188
-
189
-
190
- </td><td>
191
-
192
-
193
- </td><td>
194
-
195
- boolean
196
-
197
-
198
- </td><td>
199
-
200
- Controls the visibility of the filter persistence controls UI.
201
-
202
-
203
- </td></tr>
204
- <tr><td>
205
-
206
- [uischema](./foundation-forms.filters.uischema.md)
207
-
208
-
209
- </td><td>
210
-
211
-
212
- </td><td>
213
-
214
- [UiSchema](./foundation-forms.uischema.md)
215
-
216
-
217
- </td><td>
218
-
219
- UI schema used to define configuration of the layout and elements in the filters Check [UiSchema](./foundation-forms.uischema.md) for possible options.
220
-
221
-
222
- </td></tr>
223
- <tr><td>
224
-
225
- [value](./foundation-forms.filters.value.md)
226
-
227
-
228
- </td><td>
229
-
230
-
231
- </td><td>
232
-
233
- string
234
-
235
-
236
- </td><td>
237
-
238
- Created criteria based on the given data that can be used to filter the data.
239
-
240
-
241
- </td></tr>
242
- </tbody></table>
18
+ | Property | Modifiers | Type | Description |
19
+ | --- | --- | --- | --- |
20
+ | [allSavedFilters](./foundation-forms.filters.allsavedfilters.md) | | any\[\] | |
21
+ | [data](./foundation-forms.filters.data.md) | | any | Initial data for the filters. |
22
+ | [filterName](./foundation-forms.filters.filtername.md) | | string | |
23
+ | [jsonSchema](./foundation-forms.filters.jsonschema.md) | | JSONSchema7 | Alternatively to providing [Form.resourceName](./foundation-forms.form.resourcename.md) you can hardcode the JSON schema on the client. |
24
+ | [kvStorage](./foundation-forms.filters.kvstorage.md) | | KVStorage | |
25
+ | [prefix](./foundation-forms.filters.prefix.md) | | string | Name of the design system prefix that will be used in renderers. |
26
+ | [renderers](./foundation-forms.filters.renderers.md) | | [RendererEntry](./foundation-forms.rendererentry.md)<!-- -->\[\] | Allows to provide the main set of renderers used by the form. If not provided, the built-in renderers will be used by default. |
27
+ | [resourceName](./foundation-forms.filters.resourcename.md) | | string | Name of the backend resource which will provide metadata used to generate filters. |
28
+ | [showFilterPersistenceControls](./foundation-forms.filters.showfilterpersistencecontrols.md) | | boolean | Controls the visibility of the filter persistence controls UI. |
29
+ | [uischema](./foundation-forms.filters.uischema.md) | | [UiSchema](./foundation-forms.uischema.md) | UI schema used to define configuration of the layout and elements in the filters Check [UiSchema](./foundation-forms.uischema.md) for possible options. |
30
+ | [value](./foundation-forms.filters.value.md) | | string | Created criteria based on the given data that can be used to filter the data. |
243
31
 
244
32
  ## Methods
245
33
 
246
- <table><thead><tr><th>
247
-
248
- Method
249
-
250
-
251
- </th><th>
252
-
253
- Modifiers
254
-
255
-
256
- </th><th>
257
-
258
- Description
259
-
260
-
261
- </th></tr></thead>
262
- <tbody><tr><td>
263
-
264
- [connectedCallback()](./foundation-forms.filters.connectedcallback.md)
265
-
266
-
267
- </td><td>
268
-
269
-
270
- </td><td>
271
-
272
-
273
- </td></tr>
274
- <tr><td>
275
-
276
- [deleteFilter()](./foundation-forms.filters.deletefilter.md)
277
-
278
-
279
- </td><td>
280
-
281
-
282
- </td><td>
283
-
284
-
285
- </td></tr>
286
- <tr><td>
287
-
288
- [filterNameChanged(oldValue, newValue)](./foundation-forms.filters.filternamechanged.md)
289
-
290
-
291
- </td><td>
292
-
293
-
294
- </td><td>
295
-
296
-
297
- </td></tr>
298
- <tr><td>
299
-
300
- [loadAllSavedFilters()](./foundation-forms.filters.loadallsavedfilters.md)
301
-
302
-
303
- </td><td>
304
-
305
-
306
- </td><td>
307
-
308
-
309
- </td></tr>
310
- <tr><td>
311
-
312
- [loadFilterData(filterKey)](./foundation-forms.filters.loadfilterdata.md)
313
-
314
-
315
- </td><td>
316
-
317
-
318
- </td><td>
319
-
320
-
321
- </td></tr>
322
- <tr><td>
323
-
324
- [saveFilter()](./foundation-forms.filters.savefilter.md)
325
-
326
-
327
- </td><td>
328
-
329
-
330
- </td><td>
331
-
332
-
333
- </td></tr>
334
- </tbody></table>
34
+ | Method | Modifiers | Description |
35
+ | --- | --- | --- |
36
+ | [connectedCallback()](./foundation-forms.filters.connectedcallback.md) | | |
37
+ | [deleteFilter()](./foundation-forms.filters.deletefilter.md) | | |
38
+ | [filterNameChanged(oldValue, newValue)](./foundation-forms.filters.filternamechanged.md) | | |
39
+ | [loadAllSavedFilters()](./foundation-forms.filters.loadallsavedfilters.md) | | |
40
+ | [loadFilterData(filterKey)](./foundation-forms.filters.loadfilterdata.md) | | |
41
+ | [saveFilter()](./foundation-forms.filters.savefilter.md) | | |
335
42
 
package/docs/api/foundation-forms.form.md CHANGED
@@ -15,231 +15,21 @@ export declare class Form extends Form_base
15
15
 
16
16
  ## Properties
17
17
 
18
- <table><thead><tr><th>
19
-
20
- Property
21
-
22
-
23
- </th><th>
24
-
25
- Modifiers
26
-
27
-
28
- </th><th>
29
-
30
- Type
31
-
32
-
33
- </th><th>
34
-
35
- Description
36
-
37
-
38
- </th></tr></thead>
39
- <tbody><tr><td>
40
-
41
- [additionalRenderers](./foundation-forms.form.additionalrenderers.md)
42
-
43
-
44
- </td><td>
45
-
46
-
47
- </td><td>
48
-
49
- [RendererEntry](./foundation-forms.rendererentry.md)<!-- -->\[\]
50
-
51
-
52
- </td><td>
53
-
54
- Allows to provide set of additional renderers used by the form.
55
-
56
-
57
- </td></tr>
58
- <tr><td>
59
-
60
- [data](./foundation-forms.form.data.md)
61
-
62
-
63
- </td><td>
64
-
65
-
66
- </td><td>
67
-
68
- any
69
-
70
-
71
- </td><td>
72
-
73
- Initial data for the form.
74
-
75
-
76
- </td></tr>
77
- <tr><td>
78
-
79
- [hideSubmit](./foundation-forms.form.hidesubmit.md)
80
-
81
-
82
- </td><td>
83
-
84
-
85
- </td><td>
86
-
87
- boolean
88
-
89
-
90
- </td><td>
91
-
92
- Controls the visibility of the submit button.
93
-
94
-
95
- </td></tr>
96
- <tr><td>
97
-
98
- [jsonSchema](./foundation-forms.form.jsonschema.md)
99
-
100
-
101
- </td><td>
102
-
103
-
104
- </td><td>
105
-
106
- JSONSchema7
107
-
108
-
109
- </td><td>
110
-
111
- Alternatively to providing [Form.resourceName](./foundation-forms.form.resourcename.md) you can hardcode the JSON schema on the client.
112
-
113
-
114
- </td></tr>
115
- <tr><td>
116
-
117
- [prefix](./foundation-forms.form.prefix.md)
118
-
119
-
120
- </td><td>
121
-
122
-
123
- </td><td>
124
-
125
- string
126
-
127
-
128
- </td><td>
129
-
130
- Name of the design system prefix that will be used in renderers.
131
-
132
-
133
- </td></tr>
134
- <tr><td>
135
-
136
- [readonly](./foundation-forms.form.readonly.md)
137
-
138
-
139
- </td><td>
140
-
141
-
142
- </td><td>
143
-
144
- boolean
145
-
146
-
147
- </td><td>
148
-
149
- Allows you to enable read-only mode, which disables all input on the form and hides the submit button.
150
-
151
-
152
- </td></tr>
153
- <tr><td>
154
-
155
- [renderers](./foundation-forms.form.renderers.md)
156
-
157
-
158
- </td><td>
159
-
160
-
161
- </td><td>
162
-
163
- [RendererEntry](./foundation-forms.rendererentry.md)<!-- -->\[\]
164
-
165
-
166
- </td><td>
167
-
168
- Allows to provide the main set of renderers used by the form. If not provided, the built-in renderers will be used by default.
169
-
170
-
171
- </td></tr>
172
- <tr><td>
173
-
174
- [resourceName](./foundation-forms.form.resourcename.md)
175
-
176
-
177
- </td><td>
178
-
179
-
180
- </td><td>
181
-
182
- string
183
-
184
-
185
- </td><td>
186
-
187
- Name of the backend resource which will provide metadata used to generate form and later used for submitting data
188
-
189
-
190
- </td></tr>
191
- <tr><td>
192
-
193
- [uischema](./foundation-forms.form.uischema.md)
194
-
195
-
196
- </td><td>
197
-
198
-
199
- </td><td>
200
-
201
- [UiSchema](./foundation-forms.uischema.md)
202
-
203
-
204
- </td><td>
205
-
206
- UI schema used to define configuration of the layout and elements in the form Check [UiSchema](./foundation-forms.uischema.md) for possible options
207
-
208
-
209
- </td></tr>
210
- </tbody></table>
18
+ | Property | Modifiers | Type | Description |
19
+ | --- | --- | --- | --- |
20
+ | [additionalRenderers](./foundation-forms.form.additionalrenderers.md) | | [RendererEntry](./foundation-forms.rendererentry.md)<!-- -->\[\] | Allows to provide set of additional renderers used by the form. |
21
+ | [data](./foundation-forms.form.data.md) | | any | Initial data for the form. |
22
+ | [hideSubmit](./foundation-forms.form.hidesubmit.md) | | boolean | Controls the visibility of the submit button. |
23
+ | [jsonSchema](./foundation-forms.form.jsonschema.md) | | JSONSchema7 | Alternatively to providing [Form.resourceName](./foundation-forms.form.resourcename.md) you can hardcode the JSON schema on the client. |
24
+ | [prefix](./foundation-forms.form.prefix.md) | | string | Name of the design system prefix that will be used in renderers. |
25
+ | [readonly](./foundation-forms.form.readonly.md) | | boolean | Allows you to enable read-only mode, which disables all input on the form and hides the submit button. |
26
+ | [renderers](./foundation-forms.form.renderers.md) | | [RendererEntry](./foundation-forms.rendererentry.md)<!-- -->\[\] | Allows to provide the main set of renderers used by the form. If not provided, the built-in renderers will be used by default. |
27
+ | [resourceName](./foundation-forms.form.resourcename.md) | | string | Name of the backend resource which will provide metadata used to generate form and later used for submitting data |
28
+ | [uischema](./foundation-forms.form.uischema.md) | | [UiSchema](./foundation-forms.uischema.md) | UI schema used to define configuration of the layout and elements in the form Check [UiSchema](./foundation-forms.uischema.md) for possible options |
211
29
 
212
30
  ## Methods
213
31
 
214
- <table><thead><tr><th>
215
-
216
- Method
217
-
218
-
219
- </th><th>
220
-
221
- Modifiers
222
-
223
-
224
- </th><th>
225
-
226
- Description
227
-
228
-
229
- </th></tr></thead>
230
- <tbody><tr><td>
231
-
232
- [reset(clearData)](./foundation-forms.form.reset.md)
233
-
234
-
235
- </td><td>
236
-
237
-
238
- </td><td>
239
-
240
- Reset the form state
241
-
242
-
243
- </td></tr>
244
- </tbody></table>
32
+ | Method | Modifiers | Description |
33
+ | --- | --- | --- |
34
+ | [reset(clearData)](./foundation-forms.form.reset.md) | | Reset the form state |
245
35
 
package/docs/api/foundation-forms.form.reset.md CHANGED
@@ -14,39 +14,9 @@ reset(clearData?: boolean): void;
14
14
 
15
15
  ## Parameters
16
16
 
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- clearData
36
-
37
-
38
- </td><td>
39
-
40
- boolean
41
-
42
-
43
- </td><td>
44
-
45
- _(Optional)_
46
-
47
-
48
- </td></tr>
49
- </tbody></table>
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | clearData | boolean | _(Optional)_ |
50
20
 
51
21
  **Returns:**
52
22