@kms-ngx-ui/presentational 20.1.15 → 20.2.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 (2) hide show
  1. package/package.json +1 -1
  2. package/src/assets/llms.txt +1040 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kms-ngx-ui/presentational",
3
- "version": "20.1.15",
3
+ "version": "20.2.0",
4
4
  "peerDependencies": {
5
5
  "@angular/cdk": "^20.2.14",
6
6
  "@angular/common": "^20.3.15",
@@ -0,0 +1,1040 @@
1
+ # @kms-ngx-ui/presentational
2
+
3
+ > Angular UI component library following Atomic Design (Atoms, Molecules, Organisms).
4
+ > Components use OnPush change detection and follow WCAG accessibility guidelines.
5
+
6
+ ## Import
7
+
8
+ ```typescript
9
+ import { ComponentName } from '@kms-ngx-ui/presentational';
10
+ ```
11
+
12
+ ---
13
+
14
+ ## Atoms
15
+
16
+ ### `<kms-back-to-top>` — BackToTopComponent
17
+
18
+ ### `<kms-card>` — CardComponent
19
+
20
+ **Inputs:**
21
+ | Name | Type | Default | Description |
22
+ |------|------|---------|-------------|
23
+ | `hoverEffect` | `any` | `false` | |
24
+ | `imageUrl` | `any` | `''` | |
25
+
26
+ ### `<kms-checkbox>` — CheckboxComponent
27
+
28
+ **Inputs:**
29
+ | Name | Type | Default | Description |
30
+ |------|------|---------|-------------|
31
+ | `checked` | `boolean` | `false` | |
32
+ | `disabled` | `boolean` | `false` | |
33
+ | `infoText` | `string` | `''` | |
34
+ | `name` | `string` | `''` | Internal description name. All checkboxes with the same name belong to the same group. User can select none, one or all checkboxes with the same name. |
35
+
36
+ **Outputs:**
37
+ | Name | Type |
38
+ |------|------|
39
+ | `change` | `EventEmitter` |
40
+
41
+ ### `<kms-dropdown-from-data>` — DropdownFromDataComponent
42
+ Dropdown from data component {@link https://leaseplan-dev.rentoffice.de/styleguide#ui-elements}
43
+
44
+ **Inputs:**
45
+ | Name | Type | Default | Description |
46
+ |------|------|---------|-------------|
47
+ | `disableOptions` | `any` | `false` | |
48
+ | `errorMessage` | `any` | `''` | |
49
+ | `hasNullOption` | `any` | `false` | |
50
+ | `label` | `any` | `''` | |
51
+ | `mapKey` | `any` | `-` | |
52
+ | `mapValue` | `any` | `-` | |
53
+ | `multiple` | `any` | `false` | |
54
+ | `optionsEnum` | `any` | `-` | |
55
+ | `optionsObjArray` | `any[]` | `-` | |
56
+ | `optionsPlainArray` | `any[]` | `-` | |
57
+ | `placeholder` | `any` | `''` | |
58
+ | `prefix` | `any` | `''` | |
59
+ | `prefixIcon` | `any` | `''` | |
60
+ | `preselectedKeys` | `any` | `-` | |
61
+ | `required` | `any` | `false` | |
62
+ | `searchable` | `any` | `false` | |
63
+ | `selectAllText` | `string` | `-` | |
64
+ | `suffix` | `any` | `''` | |
65
+ | `suffixIcon` | `any` | `''` | |
66
+ | `translation` | `ITranslation` | `-` | |
67
+ | `useEnumIndexAsValue` | `any` | `false` | |
68
+ | `defaultDataOverride` | `string` | `''` | |
69
+ | `disabled` | `boolean` | `false` | |
70
+
71
+ **Outputs:**
72
+ | Name | Type |
73
+ |------|------|
74
+ | `onSelectItemEmitter` | `EventEmitter` |
75
+ | `formDataChanged` | `EventEmitter<UntypedFormGroup>` |
76
+
77
+ ### `<kms-icon>` — IconComponent
78
+
79
+ **Inputs:**
80
+ | Name | Type | Default | Description |
81
+ |------|------|---------|-------------|
82
+ | `color` | `any` | `Color.BLACK` | |
83
+ | `dontUseSprite` | `any` | `false` | |
84
+ | `icon` | `any` | `-` | Required: Name of the SVG icon inside your sprite sheet file with name &#39;icons.svg&#39;. Pass &#39;none&#39; if no icon should be rendered. |
85
+ | `iconClass` | `any` | `''` | Optional: Different appearance via CSS class defined in this component´s style sheet. |
86
+ | `size` | `any` | `IconSizePx.XS` | |
87
+
88
+ ### `<kms-loader>` — LoaderComponent
89
+
90
+ **Inputs:**
91
+ | Name | Type | Default | Description |
92
+ |------|------|---------|-------------|
93
+ | `loading` | `boolean` | `false` | |
94
+
95
+ ### `<kms-map>` — MapComponent
96
+ Component to show marker on google map for specific address
97
+
98
+ **Inputs:**
99
+ | Name | Type | Default | Description |
100
+ |------|------|---------|-------------|
101
+ | `data` | `Address` | `-` | |
102
+
103
+ ### `<kms-radiobutton>` — RadioButtonComponent
104
+
105
+ **Inputs:**
106
+ | Name | Type | Default | Description |
107
+ |------|------|---------|-------------|
108
+ | `checked` | `boolean` | `false` | |
109
+ | `color` | `StylingTheme` | `StylingTheme.PRIMARY` | |
110
+ | `disabled` | `boolean` | `false` | |
111
+ | `label` | `string` | `''` | |
112
+ | `size` | `RadioButtonSize` | `RadioButtonSize.MD` | |
113
+ | `value` | `any` | `-` | |
114
+
115
+ **Outputs:**
116
+ | Name | Type |
117
+ |------|------|
118
+ | `onChange` | `EventEmitter<void>` |
119
+
120
+ ### `<kms-slider>` — SliderComponent
121
+
122
+ **Inputs:**
123
+ | Name | Type | Default | Description |
124
+ |------|------|---------|-------------|
125
+ | `disabled` | `boolean` | `false` | |
126
+ | `max` | `number` | `-` | |
127
+ | `options` | `Options` | `{}` | |
128
+
129
+ **Outputs:**
130
+ | Name | Type |
131
+ |------|------|
132
+ | `change` | `EventEmitter<ChangeContext>` |
133
+
134
+ ### `<kms-slide-toggle>` — SlideToggleComponent
135
+
136
+ **Inputs:**
137
+ | Name | Type | Default | Description |
138
+ |------|------|---------|-------------|
139
+ | `checked` | `boolean` | `false` | |
140
+ | `disabled` | `boolean` | `false` | |
141
+ | `leftLabel` | `string` | `-` | |
142
+ | `name` | `string` | `''` | |
143
+ | `rightLabel` | `string` | `-` | |
144
+
145
+ **Outputs:**
146
+ | Name | Type |
147
+ |------|------|
148
+ | `change` | `EventEmitter` |
149
+
150
+ ---
151
+
152
+ ## Molecules
153
+
154
+ ### `<kms-button>` — ButtonComponent
155
+
156
+ **Inputs:**
157
+ | Name | Type | Default | Description |
158
+ |------|------|---------|-------------|
159
+ | `appearance` | `ButtonAppearance` | `ButtonAppearance.FLAT` | |
160
+ | `color` | `StylingTheme` | `StylingTheme.PRIMARY` | |
161
+ | `disabled` | `any` | `false` | |
162
+ | `icon` | `(typeof icons)[number]` | `-` | |
163
+ | `label` | `any` | `''` | |
164
+ | `loading` | `any` | `false` | |
165
+ | `rounded` | `any` | `false` | |
166
+ | `type` | `"button" | "submit" | "reset"` | `'button'` | |
167
+
168
+ **Outputs:**
169
+ | Name | Type |
170
+ |------|------|
171
+ | `buttonClick` | `Event` |
172
+
173
+ ### `<kms-color-input>` — ColorInputComponent
174
+
175
+ **Inputs:**
176
+ | Name | Type | Default | Description |
177
+ |------|------|---------|-------------|
178
+ | `label` | `string` | `''` | |
179
+ | `placeholder` | `string` | `''` | |
180
+ | `tooltipText` | `string` | `''` | |
181
+ | `defaultDataOverride` | `string` | `''` | |
182
+ | `disabled` | `boolean` | `false` | |
183
+
184
+ **Outputs:**
185
+ | Name | Type |
186
+ |------|------|
187
+ | `onSelectItemEmitter` | `EventEmitter` |
188
+ | `formDataChanged` | `EventEmitter<UntypedFormGroup>` |
189
+
190
+ ### `<kms-confirmation-dialog>` — ConfirmationDialogComponent
191
+ A confirmation dialog component
192
+
193
+ ### `<kms-date-input>` — DateInputComponent
194
+
195
+ **Inputs:**
196
+ | Name | Type | Default | Description |
197
+ |------|------|---------|-------------|
198
+ | `disabled` | `any` | `false` | |
199
+ | `errorMessage` | `any` | `''` | |
200
+ | `hint` | `any` | `''` | |
201
+ | `label` | `any` | `''` | |
202
+ | `maxDate` | `Date | null` | `null` | |
203
+ | `minDate` | `Date | null` | `null` | |
204
+ | `mode` | `"date" | "range"` | `'date'` | |
205
+ | `monthPicker` | `any` | `false` | |
206
+ | `placeholder` | `any` | `''` | |
207
+ | `required` | `any` | `false` | |
208
+ | `startView` | `"month" | "year" | "multi-year"` | `'month'` | |
209
+
210
+ **Outputs:**
211
+ | Name | Type |
212
+ |------|------|
213
+ | `dateChange` | `Date | null` |
214
+ | `rangeChange` | `DateRangeValue` |
215
+
216
+ ### `<kms-enum-radiogroup>` — EnumRadiogroupComponent
217
+
218
+ **Inputs:**
219
+ | Name | Type | Default | Description |
220
+ |------|------|---------|-------------|
221
+ | `header` | `NullAble<String>` | `-` | |
222
+ | `optionsEnum` | `any` | `-` | |
223
+ | `translationPrefix` | `string` | `''` | |
224
+ | `defaultDataOverride` | `string` | `''` | |
225
+ | `disabled` | `boolean` | `false` | |
226
+
227
+ **Outputs:**
228
+ | Name | Type |
229
+ |------|------|
230
+ | `onSelectItemEmitter` | `EventEmitter` |
231
+ | `formDataChanged` | `EventEmitter<UntypedFormGroup>` |
232
+
233
+ ### `<kms-file-input>` — FileInputComponent
234
+
235
+ **Inputs:**
236
+ | Name | Type | Default | Description |
237
+ |------|------|---------|-------------|
238
+ | `acceptedFileMimetypes` | `string` | `'image/jpeg, image/jpg, image/png'` | |
239
+ | `allowRemove` | `boolean` | `true` | |
240
+ | `label` | `string` | `''` | |
241
+ | `maxSizeBytes` | `number` | `MAX_SIZE_BYTES` | |
242
+ | `previewImage` | `boolean` | `true` | |
243
+ | `previewImageText` | `string` | `''` | |
244
+ | `resizePixels` | `number` | `0` | |
245
+
246
+ **Outputs:**
247
+ | Name | Type |
248
+ |------|------|
249
+ | `formDataChanged` | `EventEmitter<UntypedFormGroup>` |
250
+
251
+ ### `<kms-flyout>` — FlyoutComponent
252
+
253
+ **Inputs:**
254
+ | Name | Type | Default | Description |
255
+ |------|------|---------|-------------|
256
+ | `bodyCssClass` | `string` | `''` | |
257
+ | `hasButtonForMore` | `boolean` | `false` | |
258
+ | `headerCssClass` | `string` | `''` | |
259
+ | `headerText` | `string` | `''` | |
260
+ | `headerTitle` | `string` | `''` | |
261
+ | `icon` | `string` | `'filter'` | |
262
+ | `lessText` | `string` | `''` | |
263
+ | `moreText` | `string` | `''` | |
264
+
265
+ ### `<kms-image-slider>` — ImageSliderComponent
266
+
267
+ **Inputs:**
268
+ | Name | Type | Default | Description |
269
+ |------|------|---------|-------------|
270
+ | `editMode` | `boolean` | `false` | |
271
+ | `imagesToSave` | `ImageSnippet[]` | `-` | |
272
+ | `slides` | `string[]` | `-` | |
273
+
274
+ **Outputs:**
275
+ | Name | Type |
276
+ |------|------|
277
+ | `deleteImageEvent` | `EventEmitter<number>` |
278
+ | `orderChanged` | `EventEmitter<ImageSnippet[]>` |
279
+
280
+ ### `<kms-accordion-item>` — KMSAccordionItemComponent
281
+ A generic dialog component
282
+
283
+ **Inputs:**
284
+ | Name | Type | Default | Description |
285
+ |------|------|---------|-------------|
286
+ | `expanded` | `boolean` | `false` | |
287
+ | `isSmall` | `boolean` | `false` | |
288
+ | `itemTitle` | `string` | `-` | |
289
+ | `showAsCard` | `boolean` | `false` | |
290
+
291
+ ### `<kms-numeric-input>` — NumericInputComponent
292
+
293
+ **Inputs:**
294
+ | Name | Type | Default | Description |
295
+ |------|------|---------|-------------|
296
+ | `disabled` | `any` | `false` | |
297
+ | `label` | `any` | `''` | |
298
+ | `min` | `number` | `0` | |
299
+
300
+ **Outputs:**
301
+ | Name | Type |
302
+ |------|------|
303
+ | `disabled` | `EventEmitter` |
304
+
305
+ ### `<kms-password>` — PasswordComponent
306
+
307
+ **Inputs:**
308
+ | Name | Type | Default | Description |
309
+ |------|------|---------|-------------|
310
+ | `disabled` | `any` | `false` | |
311
+ | `label` | `any` | `'Password'` | |
312
+ | `lowerCaseCriteriaMsg` | `any` | `'At least one lowercase letter'` | |
313
+ | `minCharsCriteriaMsg` | `any` | `'At least 10 characters'` | |
314
+ | `numberCriteriaMsg` | `any` | `'At least one number'` | |
315
+ | `specialCharCriteriaMsg` | `any` | ` 'At least one special character (-.!.?,$,&,*,+,#,%)' ` | |
316
+ | `upperCaseCriteriaMsg` | `any` | `'At least one uppercase letter'` | |
317
+ | `withStrength` | `any` | `false` | |
318
+
319
+ **Outputs:**
320
+ | Name | Type |
321
+ |------|------|
322
+ | `change` | `EventEmitter<string>` |
323
+ | `submit` | `EventEmitter<string>` |
324
+
325
+ ### `<kms-radiogroup>` — RadioGroupComponent
326
+
327
+ **Inputs:**
328
+ | Name | Type | Default | Description |
329
+ |------|------|---------|-------------|
330
+ | `color` | `StylingTheme` | `StylingTheme.PRIMARY` | |
331
+ | `direction` | `"row" | "column"` | `'row'` | |
332
+ | `disabled` | `boolean` | `false` | |
333
+ | `infoText` | `string` | `-` | |
334
+ | `options` | `RadiobuttonInterface[]` | `[]` | |
335
+ | `size` | `RadioButtonSize` | `RadioButtonSize.MD` | |
336
+ | `value` | `any` | `null` | |
337
+
338
+ ### `<kms-salutation-dropdown>` — SalutationDropdownComponent
339
+
340
+ **Inputs:**
341
+ | Name | Type | Default | Description |
342
+ |------|------|---------|-------------|
343
+ | `placeholder` | `NullAble<string>` | `-` | |
344
+ | `defaultDataOverride` | `string` | `''` | |
345
+ | `disabled` | `boolean` | `false` | |
346
+
347
+ **Outputs:**
348
+ | Name | Type |
349
+ |------|------|
350
+ | `onSelectItemEmitter` | `EventEmitter` |
351
+ | `formDataChanged` | `EventEmitter<UntypedFormGroup>` |
352
+
353
+ ### `<kms-salutation-radiogroup>` — SalutationRadiogroupComponent
354
+
355
+ **Inputs:**
356
+ | Name | Type | Default | Description |
357
+ |------|------|---------|-------------|
358
+ | `defaultDataOverride` | `string` | `''` | |
359
+ | `disabled` | `boolean` | `false` | |
360
+
361
+ **Outputs:**
362
+ | Name | Type |
363
+ |------|------|
364
+ | `onSelectItemEmitter` | `EventEmitter` |
365
+ | `formDataChanged` | `EventEmitter<UntypedFormGroup>` |
366
+
367
+ ### `<kms-text-input>` — TextInputComponent
368
+
369
+ **Inputs:**
370
+ | Name | Type | Default | Description |
371
+ |------|------|---------|-------------|
372
+ | `autocomplete` | `any` | `''` | |
373
+ | `disabled` | `any` | `false` | |
374
+ | `errorMessage` | `any` | `''` | |
375
+ | `hint` | `any` | `''` | |
376
+ | `label` | `any` | `''` | |
377
+ | `numericOnly` | `any` | `false` | |
378
+ | `placeholder` | `any` | `''` | |
379
+ | `prefix` | `any` | `''` | |
380
+ | `prefixIcon` | `any` | `''` | |
381
+ | `required` | `any` | `false` | |
382
+ | `suffix` | `any` | `''` | |
383
+ | `suffixIcon` | `any` | `''` | |
384
+ | `type` | `"text" | "email" | "tel" | "url"` | `'text'` | |
385
+
386
+ **Outputs:**
387
+ | Name | Type |
388
+ |------|------|
389
+ | `valueChange` | `string` |
390
+
391
+ ### `<kms-time-input>` — TimeInputComponent
392
+
393
+ **Inputs:**
394
+ | Name | Type | Default | Description |
395
+ |------|------|---------|-------------|
396
+ | `allowEmpty` | `boolean` | `false` | |
397
+ | `interval` | `number` | `15` | |
398
+ | `label` | `string` | `''` | |
399
+ | `value` | `string` | `''` | |
400
+
401
+ ### `<kms-tooltip-icon>` — TooltipIconComponent
402
+
403
+ **Inputs:**
404
+ | Name | Type | Default | Description |
405
+ |------|------|---------|-------------|
406
+ | `delay` | `any` | `1000` | |
407
+ | `icon` | `any` | `'ic_info'` | |
408
+ | `iconSize` | `any` | `IconSizePx.XS` | |
409
+ | `placement` | `any` | `-` | |
410
+ | `tooltipAlwaysVisible` | `any` | `false` | |
411
+ | `tooltipText` | `any` | `''` | |
412
+
413
+ ### `<kms-yesno-radiogroup>` — YesNoRadiogroupComponent
414
+
415
+ **Inputs:**
416
+ | Name | Type | Default | Description |
417
+ |------|------|---------|-------------|
418
+ | `disabled` | `boolean` | `false` | |
419
+ | `header` | `NullAble<String>` | `-` | |
420
+ | `textNo` | `string` | `''` | |
421
+ | `textYes` | `string` | `''` | |
422
+
423
+ ---
424
+
425
+ ## Organisms
426
+
427
+ ### `<kms-form-actions>` — FormActionsComponent
428
+
429
+ **Inputs:**
430
+ | Name | Type | Default | Description |
431
+ |------|------|---------|-------------|
432
+ | `actionsConfig` | `FormActionsConfig` | `-` | |
433
+ | `disabled` | `any` | `false` | |
434
+
435
+ **Outputs:**
436
+ | Name | Type |
437
+ |------|------|
438
+ | `submitClick` | `void` |
439
+
440
+ ### `<kms-form-field>` — FormFieldComponent
441
+
442
+ **Inputs:**
443
+ | Name | Type | Default | Description |
444
+ |------|------|---------|-------------|
445
+ | `control` | `FormControl` | `-` | |
446
+ | `fieldConfig` | `FieldConfig` | `-` | |
447
+ | `formDisabledConfig` | `DisabledConfig` | `-` | |
448
+ | `formErrorDisplay` | `ErrorDisplayConfig` | `-` | |
449
+ | `formId` | `any` | `''` | |
450
+ | `submitted` | `any` | `false` | |
451
+
452
+ ### `<kms-form-section>` — FormSectionComponent
453
+
454
+ **Inputs:**
455
+ | Name | Type | Default | Description |
456
+ |------|------|---------|-------------|
457
+ | `formDisabledConfig` | `DisabledConfig` | `-` | |
458
+ | `formErrorDisplay` | `ErrorDisplayConfig` | `-` | |
459
+ | `formGroup` | `FormGroup` | `-` | |
460
+ | `formId` | `any` | `''` | |
461
+ | `sectionConfig` | `FormSectionConfig` | `-` | |
462
+ | `submitted` | `any` | `false` | |
463
+
464
+ ### `<kms-generic-form>` — GenericFormComponent
465
+
466
+ **Inputs:**
467
+ | Name | Type | Default | Description |
468
+ |------|------|---------|-------------|
469
+ | `config` | `GenericFormConfig` | `-` | |
470
+ | `disabled` | `any` | `false` | |
471
+ | `loading` | `any` | `false` | |
472
+ | `value` | `Record<string, any>` | `{}` | |
473
+
474
+ **Outputs:**
475
+ | Name | Type |
476
+ |------|------|
477
+ | `fieldValueChange` | `{ key: string; value: any }` |
478
+ | `formReady` | `FormGroup` |
479
+ | `formStateChange` | `GenericFormState` |
480
+ | `formSubmit` | `Record<string, any>` |
481
+ | `value` | `Record<string, any>` |
482
+
483
+ ---
484
+
485
+ ## Directives
486
+
487
+ ### `[[kmsDynamicField]]` — DynamicFieldDirective
488
+ Creates a library component dynamically and bridges ControlValueAccessor to a FormControl.
489
+
490
+ **Inputs:**
491
+ | Name | Type | Default | Description |
492
+ |------|------|---------|-------------|
493
+ | `control` | `FormControl` | `-` | |
494
+ | `fieldConfig` | `FieldConfig` | `-` | |
495
+
496
+
497
+ ### `[[getMaxHeight]]` — GetMaxHeightDirective
498
+ Directive to calc the height of all inner elements
499
+
500
+ **Inputs:**
501
+ | Name | Type | Default | Description |
502
+ |------|------|---------|-------------|
503
+ | `getMaxHeight` | `string` | `''` | CSS class name of the child items (markup elements) that should be checked for their height. This is mandatory. |
504
+
505
+
506
+ ### `[[swipeDirective]]` — SwipeDirective
507
+
508
+ **Inputs:**
509
+ | Name | Type | Default | Description |
510
+ |------|------|---------|-------------|
511
+ | `swipeDirective` | `SwipeOptions` | `-` | Needed config that defines swipe behaviour. |
512
+
513
+
514
+ ### `[[kmsTime]]` — TimeDirective
515
+
516
+
517
+ ### `[[kmsTooltip]]` — TooltipDirective
518
+
519
+ **Inputs:**
520
+ | Name | Type | Default | Description |
521
+ |------|------|---------|-------------|
522
+ | `alwaysVisible` | `boolean` | `false` | |
523
+ | `delay` | `number` | `0` | |
524
+ | `kmsTooltip` | `HTMLElement` | `-` | |
525
+ | `placement` | `Placement` | `'bottom'` | |
526
+
527
+
528
+ ---
529
+
530
+ ## Pipes
531
+
532
+ ### `kmsIntegerCurrency` — IntegerCurrency
533
+ Usage: `value | kmsIntegerCurrency`
534
+ Parameters: `currencyCode: string` (optional), `display: boolean` (optional), `digitsInfo: string` (optional)
535
+
536
+ ### `kmsSafeHtml` — SafeHtmlPipe
537
+ Usage: `value | kmsSafeHtml`
538
+
539
+ ### `kmsSafeResourceSUrl` — SafeResourceUrlPipe
540
+ Usage: `value | kmsSafeResourceSUrl`
541
+
542
+ ### `kmsSafeSUrl` — SafeUrlPipe
543
+ Usage: `value | kmsSafeSUrl`
544
+
545
+ ### `sanitizeNull` — SanitizeNullPipe
546
+ Usage: `value | sanitizeNull`
547
+
548
+ ### `kmsTrim` — TrimPipe
549
+ Usage: `value | kmsTrim`
550
+
551
+ ### `kmsTypeOf` — TypeofPipe
552
+ Usage: `value | kmsTypeOf`
553
+
554
+ ---
555
+
556
+ ## Enums
557
+
558
+ ### ButtonAppearance
559
+ - `BASIC` = `mat-button`
560
+ - `FLAT` = `mat-flat-button`
561
+ - `RAISED` = `mat-raised-button`
562
+
563
+ ### ButtonDialogType
564
+ - `primary` = `primary`
565
+ - `secondary` = `secondary`
566
+
567
+ ### ButtonResponseType
568
+ - `primary` = `primary`
569
+ - `secondary` = `secondary`
570
+
571
+ ### Color
572
+ - `PRIMARY` = `--kms-primary`
573
+ - `SECONDARY` = `--kms-secondary`
574
+ - `TERTIARY` = `--kms-tertiary`
575
+ - `SUCCESS` = `--kms-success`
576
+ - `ALERT` = `--kms-alert`
577
+ - `ERROR` = `--kms-error`
578
+ - `DISABLED` = `--kms-disabled`
579
+ - `WHITE` = `--kms-white`
580
+ - `BLACK` = `--kms-black`
581
+
582
+ ### FieldType
583
+ - `TEXT` = `text`
584
+ - `TEXTAREA` = `textarea`
585
+ - `PASSWORD` = `password`
586
+ - `NUMBER` = `number`
587
+ - `DATE` = `date`
588
+ - `DATE_RANGE` = `dateRange`
589
+ - `TIME` = `time`
590
+ - `SELECT` = `select`
591
+ - `AUTOCOMPLETE` = `autocomplete`
592
+ - `CHECKBOX` = `checkbox`
593
+ - `RADIO` = `radio`
594
+ - `RADIO_GROUP` = `radioGroup`
595
+ - `SLIDE_TOGGLE` = `slideToggle`
596
+ - `MULTI_SELECT` = `multiSelect`
597
+ - `COLOR` = `color`
598
+ - `COUNTER` = `counter`
599
+ - `MONTH_PICKER` = `monthPicker`
600
+ - `TEMPLATE` = `template`
601
+ - `OFFSET` = `offset`
602
+
603
+ ### FormLayout
604
+ - `VERTICAL` = `vertical`
605
+ - `GRID` = `grid`
606
+ - `INLINE` = `inline`
607
+
608
+ ### IconSizePx
609
+ - `XXS` = `16`
610
+ - `XS` = `20`
611
+ - `SM` = `32`
612
+ - `MD` = `64`
613
+ - `LG` = `128`
614
+ - `XL` = `256`
615
+ - `XXL` = `512`
616
+
617
+ ### ImageSourceType
618
+ - `Ident` = `Idnet`
619
+ - `ByteArray` = `ByteArray`
620
+ - `URL` = `URL`
621
+
622
+ ### RadioButtonSize
623
+ - `SM` = `small`
624
+ - `MD` = `medium`
625
+ - `LG` = `large`
626
+
627
+ ### SalutationEnum
628
+ - `NOT_SPECIFIED` = `Keine Anrede`
629
+ - `MALE` = `Herr`
630
+ - `FEMALE` = `Frau`
631
+
632
+ ### StylingTheme
633
+ - `PRIMARY` = `primary`
634
+ - `SECONDARY` = `accent`
635
+ - `WARN` = `warn`
636
+
637
+ ### VehicleEngineTypeEnumDummy
638
+ - `benzin` = `Benzin`
639
+ - `diesel` = `Diesel`
640
+ - `elektro` = `Elektro`
641
+ - `hybrid` = `Hybrid`
642
+ - `pluginHybrid` = `Plug-in-Hybrid`
643
+ - `erdgas` = `Erdgas`
644
+
645
+ ---
646
+
647
+ ## Interfaces
648
+
649
+ ### AsyncValidatorConfig
650
+ - `errorMessage`: `string`
651
+ - `validator`: `AsyncValidatorFn`
652
+
653
+ ### AutocompleteFieldOptions
654
+ - `items`: `LabelValuePair[] | Observable<LabelValuePair[]>`
655
+ - `minChars`: `number` (optional)
656
+ - `selectFirst`: `boolean` (optional)
657
+
658
+ ### ColorGroup
659
+ - `colors`: `literal type[]`
660
+ - `name`: `string`
661
+
662
+ ### CounterFieldOptions
663
+ - `max`: `number` (optional)
664
+ - `min`: `number` (optional)
665
+ - `step`: `number` (optional)
666
+
667
+ ### DateFieldOptions
668
+ - `max`: `Date | string` (optional)
669
+ - `min`: `Date | string` (optional)
670
+
671
+ ### DateRangeFieldOptions
672
+ - `endKey`: `string`
673
+ - `max`: `Date | string` (optional)
674
+ - `min`: `Date | string` (optional)
675
+ - `startKey`: `string`
676
+
677
+ ### DialogConfig
678
+ - `autoFocus`: `boolean` (optional)
679
+ - `data`: `DialogData`
680
+ - `panelClass`: `string` (optional)
681
+
682
+ ### DialogData
683
+ - `buttons`: `literal type` (optional)
684
+ - `message`: `string` (optional)
685
+ - `panelClass`: `string` (optional)
686
+ - `title`: `string` (optional)
687
+
688
+ ### DisabledConfig
689
+ - `showDisabledBackground`: `boolean` (optional)
690
+
691
+ ### EditorField
692
+ - `_align`: `string`
693
+ - `_autocomplete`: `string`
694
+ - `_autoMinChars`: `number`
695
+ - `_autoSelectFirst`: `boolean`
696
+ - `_dateMax`: `string`
697
+ - `_dateMin`: `string`
698
+ - `_dateRangeEndKey`: `string`
699
+ - `_dateRangeMax`: `string`
700
+ - `_dateRangeMin`: `string`
701
+ - `_dateRangeStartKey`: `string`
702
+ - `_disabled`: `boolean`
703
+ - `_disabledBg`: `boolean`
704
+ - `_errorShowMultiple`: `boolean`
705
+ - `_errorStrategy`: `string`
706
+ - `_hidden`: `boolean`
707
+ - `_id`: `number`
708
+ - `_radioItems`: `literal type[]`
709
+ - `_radioSize`: `string`
710
+ - `_selectDataMode`: `"items" | "objItems"`
711
+ - `_selectItems`: `literal type[]`
712
+ - `_selectMapKey`: `string`
713
+ - `_selectMapValue`: `string`
714
+ - `_selectObjItems`: `any[]`
715
+ - `_selectSearchable`: `boolean`
716
+ - `_textareaAutoResize`: `boolean`
717
+ - `_textareaMaxRows`: `number`
718
+ - `_timeInterval`: `number`
719
+ - `_timeMax`: `string`
720
+ - `_timeMin`: `string`
721
+ - `_validatorFlags`: `literal type`
722
+ - `_withStrength`: `boolean`
723
+
724
+ ### EditorSection
725
+ - `_id`: `number`
726
+ - `align`: `string`
727
+ - `collapsed`: `boolean`
728
+ - `fields`: `EditorField[]`
729
+ - `gap`: `string`
730
+ - `gridColumns`: `number`
731
+ - `gridColumnsMd`: `number`
732
+ - `gridColumnsSm`: `number`
733
+ - `hidden`: `boolean`
734
+ - `key`: `string`
735
+ - `padding`: `string`
736
+ - `title`: `string`
737
+ - `tooltip`: `string`
738
+ - `verticalAlign`: `string`
739
+
740
+ ### ErrorDisplayConfig
741
+ - `matcher`: `ErrorStateMatcher` (optional)
742
+ - `showMultiple`: `boolean` (optional)
743
+ - `showOnSubmit`: `boolean` (optional)
744
+ - `strategy`: `ErrorDisplayStrategy` (optional)
745
+
746
+ ### FieldAffixConfig
747
+ - `type`: `"text" | "icon"`
748
+ - `value`: `string`
749
+
750
+ ### FieldConfig
751
+ - `align`: `GridAlign` (optional)
752
+ - `asyncValidators`: `AsyncValidatorConfig[]` (optional)
753
+ - `autocomplete`: `string` (optional)
754
+ - `columnSize`: `number` (optional)
755
+ - `disabled`: `boolean` (optional)
756
+ - `disabledConfig`: `DisabledConfig` (optional)
757
+ - `errorDisplay`: `ErrorDisplayConfig` (optional)
758
+ - `hidden`: `boolean` (optional)
759
+ - `key`: `string` (optional)
760
+ - `label`: `string` (optional)
761
+ - `options`: `FieldTypeOptions` (optional)
762
+ - `placeholder`: `string` (optional)
763
+ - `prefix`: `FieldAffixConfig` (optional)
764
+ - `suffix`: `FieldAffixConfig` (optional)
765
+ - `templateRef`: `TemplateRef<any>` (optional)
766
+ - `testId`: `string` (optional)
767
+ - `tooltip`: `string` (optional)
768
+ - `type`: `FieldType`
769
+ - `validators`: `(ValidatorFn | ValidatorConfig)[]` (optional)
770
+
771
+ ### FormActionsConfig
772
+ - `position`: `"top" | "bottom" | "both"` (optional)
773
+ - `submitLabel`: `string` (optional)
774
+
775
+ ### FormSectionConfig
776
+ - `align`: `GridAlign` (optional)
777
+ - `fields`: `FieldConfig[]`
778
+ - `gap`: `string` (optional)
779
+ - `gridColumns`: `number` (optional)
780
+ - `gridColumnsMd`: `number` (optional)
781
+ - `gridColumnsSm`: `number` (optional)
782
+ - `hidden`: `boolean` (optional)
783
+ - `key`: `string`
784
+ - `padding`: `string` (optional)
785
+ - `title`: `string` (optional)
786
+ - `tooltip`: `string` (optional)
787
+ - `verticalAlign`: `GridVerticalAlign` (optional)
788
+
789
+ ### GenericFormConfig
790
+ - `disabledConfig`: `DisabledConfig` (optional)
791
+ - `errorDisplay`: `ErrorDisplayConfig` (optional)
792
+ - `formId`: `string`
793
+ - `layout`: `FormLayout` (optional)
794
+ - `sections`: `FormSectionConfig[]`
795
+ - `submitAction`: `FormActionsConfig` (optional)
796
+
797
+ ### GenericFormState
798
+ - `dirty`: `boolean`
799
+ - `errors`: `Record<string | ValidationErrors> | null`
800
+ - `invalid`: `boolean`
801
+ - `pristine`: `boolean`
802
+ - `submitted`: `boolean`
803
+ - `touched`: `boolean`
804
+ - `untouched`: `boolean`
805
+ - `valid`: `boolean`
806
+
807
+ ### ITranslation
808
+ - `isPrefix`: `boolean` (optional)
809
+ - `path`: `string`
810
+ - `service`: `any`
811
+ - `useKeyAsValue`: `boolean` (optional)
812
+
813
+ ### NumberFieldOptions
814
+ - `max`: `number` (optional)
815
+ - `min`: `number` (optional)
816
+
817
+ ### PasswordFieldOptions
818
+ - `withStrength`: `boolean` (optional)
819
+
820
+ ### RadiobuttonInterface
821
+ - `Disabled`: `boolean` (optional)
822
+ - `InfoText`: `string` (optional)
823
+
824
+ ### RadioGroupFieldOptions
825
+ - `items`: `LabelValuePair[] | string[]`
826
+ - `layout`: `"horizontal" | "vertical"` (optional)
827
+ - `size`: `string` (optional)
828
+
829
+ ### SelectFieldOptions
830
+ - `disableOptions`: `boolean` (optional)
831
+ - `enumItems`: `any` (optional)
832
+ - `hasNullOption`: `boolean` (optional)
833
+ - `items`: `LabelValuePair[] | Observable<LabelValuePair[]>` (optional)
834
+ - `multiple`: `boolean` (optional)
835
+ - `objItems`: `literal type` (optional)
836
+ - `plainItems`: `string[]` (optional)
837
+ - `preselectedKeys`: `any` (optional)
838
+ - `searchable`: `boolean` (optional)
839
+ - `selectAllText`: `string` (optional)
840
+ - `translation`: `SelectTranslation` (optional)
841
+ - `useEnumIndexAsValue`: `boolean` (optional)
842
+
843
+ ### SelectTranslation
844
+ - `isPrefix`: `boolean` (optional)
845
+ - `path`: `string`
846
+ - `service`: `any`
847
+ - `useKeyAsValue`: `boolean` (optional)
848
+
849
+ ### SwipeMoveEvent
850
+ - `direction`: `number`
851
+ - `offsetPerFrame`: `number`
852
+ - `position`: `number`
853
+ - `speed`: `number`
854
+ - `swipeDistancePercentage`: `number`
855
+ - `swipeDistanceTotal`: `number`
856
+ - `thresholdWasReached`: `boolean`
857
+
858
+ ### SwipeOptions
859
+ - `swipeLocalPosition`: `boolean`
860
+ - `swipeThreshold`: `number`
861
+ - `swipeThresholdType`: `string`
862
+
863
+ ### SwipeReleaseEvent
864
+ - `direction`: `number`
865
+ - `easingType`: `string`
866
+ - `speed`: `number`
867
+ - `target`: `any`
868
+ - `thresholdWasReached`: `boolean`
869
+
870
+ ### TextareaFieldOptions
871
+ - `autoResize`: `boolean` (optional)
872
+ - `maxRows`: `number` (optional)
873
+ - `rows`: `number` (optional)
874
+
875
+ ### TimeFieldOptions
876
+ - `intervalMinutes`: `number` (optional)
877
+ - `max`: `string` (optional)
878
+ - `min`: `string` (optional)
879
+
880
+ ### ValidatorConfig
881
+ - `errorMessage`: `string`
882
+ - `validator`: `ValidatorFn`
883
+
884
+ ### ValidatorOption
885
+ - `description`: `string`
886
+ - `enabled`: `boolean`
887
+ - `errorKey`: `string`
888
+ - `factory`: `function`
889
+ - `hasParam`: `boolean` (optional)
890
+ - `key`: `string`
891
+ - `label`: `string`
892
+ - `param`: `number` (optional)
893
+ - `paramLabel`: `string` (optional)
894
+ - `paramMax`: `number` (optional)
895
+ - `paramMin`: `number` (optional)
896
+ - `source`: `string`
897
+
898
+ ---
899
+
900
+ ## Models
901
+
902
+ ### Address
903
+ - `City`: `NullAble<string>`
904
+ - `Name1`: `NullAble<string>`
905
+ - `Name2`: `NullAble<string>`
906
+ - `Street`: `NullAble<string>`
907
+ - `Zip`: `NullAble<string>`
908
+
909
+ ### AttachedFileDTO
910
+ - `CreateSmallImage`: `boolean`
911
+ - `Filename`: `string`
912
+ - `ImageAsDataURL`: `string`
913
+ - `ImageIdent`: `string`
914
+ - `ImageLink`: `string`
915
+ - `Text`: `string`
916
+
917
+ ### Breakpoint
918
+ - `High`: `number`
919
+ - `Low`: `number`
920
+ - `Name`: `string`
921
+ - `Number`: `number`
922
+
923
+ ### ImageSnippet
924
+ - `fileName`: `string`
925
+ - `src`: `string`
926
+ - `srcType`: `unknown`
927
+ - `status`: `string`
928
+
929
+ ### ImageSnippet
930
+ - `fileName`: `string`
931
+ - `src`: `string`
932
+ - `srcType`: `unknown`
933
+ - `status`: `string`
934
+
935
+ ### KeyValuePair
936
+ - `Key`: `NullAble<string>`
937
+ - `Value`: `NullAble<string>`
938
+
939
+ ### LabelValuePair
940
+ - `Label`: `NullAble<string>`
941
+ - `Value`: `NullAble<string>`
942
+
943
+ ### Marker
944
+ - `label`: `MarkerLabel`
945
+ - `options`: `MarkerOptions`
946
+ - `position`: `google.maps.LatLngLiteral`
947
+ - `title`: `string`
948
+
949
+ ### MarkerLabel
950
+ - `color`: `string`
951
+ - `text`: `string`
952
+
953
+ ### MarkerOptions
954
+ - `animation`: `number`
955
+
956
+ ### ShowOnDirtyErrorStateMatcher
957
+
958
+ ### SimpleBreakpoint
959
+ - `MaximumPixels`: `number`
960
+ - `Name`: `string`
961
+ - `Number`: `number`
962
+
963
+ ### TextValuePair
964
+ - `Text`: `NullAble<string>`
965
+ - `Value`: `NullAble<any>`
966
+
967
+ ### TextValuePairArray
968
+ - `Items`: `NullAble<TextValuePair[]>`
969
+
970
+ ### WindowDimensions
971
+ - `Height`: `number`
972
+ - `Orientation`: `"landscape" | "portrait"`
973
+ - `Width`: `number`
974
+
975
+ ---
976
+
977
+ ## Services
978
+
979
+ ### FieldRegistryService
980
+ - `resolve(type: FieldType)`: `Type | null`
981
+
982
+ ### GenericFormService
983
+ - `applyVisibility(config: GenericFormConfig)`: `void`
984
+ - `buildDateRangeSubControls(field: FieldConfig, controls: Record<string | FormControl>)`: `void`
985
+ - `buildFieldControl(field: FieldConfig, controls: Record<string | FormControl>)`: `void`
986
+ - `buildForm(config: GenericFormConfig)`: `FormGroup`
987
+ - `cleanup()`: `void`
988
+ - `fieldValueChanges$(key: string)`: `Observable<any>`
989
+ - `getErrors()`: `Record | null`
990
+ - `getFieldConfig(key: string)`: `FieldConfig | undefined`
991
+ - `getFormGroup()`: `FormGroup`
992
+ - `getRawValue()`: `Record<string, any>`
993
+ - `getState()`: `GenericFormState`
994
+ - `getValue()`: `Record<string, any>`
995
+ - `isValidatorConfig(v: ValidatorFn | ValidatorConfig)`: `ValidatorConfig`
996
+ - `ngOnDestroy()`: `void`
997
+ - `patchValue(value: Record<string | any>, options: literal type)`: `void`
998
+ - `registerAsyncValidators(field: FieldConfig)`: `AsyncValidatorFn[]`
999
+ - `registerSyncValidators(field: FieldConfig)`: `ValidatorFn[]`
1000
+ - `resolveErrorMessage(key: string, validatorName: string, validatorMeta: any)`: `string`
1001
+ - `resolveInitialValue(type: FieldType)`: `any`
1002
+ - `setFieldDisabled(key: string, disabled: boolean)`: `void`
1003
+ - `updateFieldOptions(key: string, options: Partial<FieldTypeOptions>)`: `void`
1004
+ - `validateAll()`: `boolean`
1005
+
1006
+ ### KmsUiPresentationalService
1007
+
1008
+ ### ViewportService
1009
+ - `calculateFullscreenElementsheight(id: string, defaultheight: string, extra: number)`: `string`
1010
+ - `calculateFullscreenElementsHeight(id: string, defaultheight: string, extra: number)`: `string`
1011
+ - `convertWidthToMediaQuery(width: number)`: `Breakpoint`
1012
+ - `documentSizeChanged(event: any)`: `void`
1013
+ - `getCurrentViewPort()`: `string`
1014
+ - `getCurrentViewPortDimensions()`: `WindowDimensions`
1015
+ - `getCurrentViewPortHeight()`: `number`
1016
+ - `getCurrentViewPortNumber()`: `number`
1017
+ - `getCurrentViewPortObject()`: `Breakpoint`
1018
+ - `getCurrentViewPortWidth()`: `number`
1019
+ - `getDocumentHeight()`: `number`
1020
+ - `getDocumentWidth()`: `number`
1021
+ - `getOrientationAsString()`: `"portrait" | "landscape"`
1022
+ - `getSimpleBreakpoint(screenSize: number)`: `SimpleBreakpoint`
1023
+ - `getViewportChangedObserver()`: `Observable<string>`
1024
+ - `getViewportResizedObserver()`: `Observable<number>`
1025
+ - `getWindowHeight()`: `number`
1026
+ - `getWindowWidth()`: `number`
1027
+ - `isLandscape()`: `boolean | undefined`
1028
+ - `isMobile()`: `boolean`
1029
+ - `isPortrait()`: `boolean | undefined`
1030
+ - `ngOnDestroy()`: `void`
1031
+ - `scrollToElement(el: HTMLElement, alignCenter: unknown)`: `void`
1032
+ - `scrollToElementId(el: string, alignCenter: unknown)`: `void`
1033
+ - `scrollTop(top: number)`: `void`
1034
+
1035
+ ---
1036
+
1037
+ ## Icons
1038
+
1039
+ 171 icons available for `<kms-icon icon="name">`.
1040
+ See `icons.json` (same directory as this file) for the full list of icon names.