@rippling/pebble-sdui-web 0.4.1 → 0.6.2

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.
@@ -0,0 +1,2509 @@
1
+ <!-- Auto-generated from catalogs/custom-apps.catalog.json; do not edit directly. -->
2
+ # custom-apps Types
3
+
4
+ Nested object types are referenced from component props, action params, and computed function params. Read this file only when another catalog doc links to a nested type.
5
+
6
+ ## Addres
7
+
8
+ Address object with street, city, state, country, and zip
9
+
10
+ ### Fields
11
+
12
+ | Name | Required | Type | Description |
13
+ |---|---:|---|---|
14
+ | `city` | no | string | City name |
15
+ | `country` | yes | string | Country code |
16
+ | `countyName` | no | string | County name |
17
+ | `state` | no | string | State or province code |
18
+ | `streetLine1` | yes | string | Primary street address line |
19
+ | `streetLine2` | no | string | Secondary street address line |
20
+ | `streetLine3` | no | string | Tertiary street address line |
21
+ | `streetLine4` | no | string | Quaternary street address line |
22
+ | `zip` | yes | string | Postal/ZIP code |
23
+
24
+ No additional properties.
25
+
26
+ ## AnimationData
27
+
28
+ Lottie animation JSON object. Required if path not provided
29
+
30
+ ### Fields
31
+
32
+ _No fields._
33
+
34
+ Additional properties: unknown.
35
+
36
+ ## AppGroupSelectArg
37
+
38
+ ### Fields
39
+
40
+ _No fields._
41
+
42
+ Additional properties: unknown.
43
+
44
+ ## AppGroupSelectCheck
45
+
46
+ ### Fields
47
+
48
+ | Name | Required | Type | Description |
49
+ |---|---:|---|---|
50
+ | `args` | no | [AppGroupSelectArg](./types.md#appgroupselectarg) | |
51
+ | `message` | yes | string | |
52
+ | `type` | yes | string | |
53
+
54
+ No additional properties.
55
+
56
+ ## AppGroupSelectFooter
57
+
58
+ Fixed footer at bottom of dropdown menu
59
+
60
+ ### Fields
61
+
62
+ | Name | Required | Type | Description |
63
+ |---|---:|---|---|
64
+ | `label` | yes | string | Footer link text |
65
+ | `onClick` | yes | string | Event name to emit when footer is clicked |
66
+
67
+ No additional properties.
68
+
69
+ ## AppGroupSelectFuseOption
70
+
71
+ Fuse.js search options for customizing fuzzy search behavior
72
+
73
+ ### Fields
74
+
75
+ _No fields._
76
+
77
+ Additional properties: unknown.
78
+
79
+ ## AppNavBarAction
80
+
81
+ ### Fields
82
+
83
+ | Name | Required | Type | Description |
84
+ |---|---:|---|---|
85
+ | `appearance` | no | [AppNavBarActionAppearance](./definitions.md#appnavbaractionappearance) | Button visual style. Default: PRIMARY |
86
+ | `icon` | no | string | Icon name from Icon.TYPES (e.g. ADD, EDIT_OUTLINE) |
87
+ | `id` | yes | string | Unique identifier for the action. Written to actionClickedId state on click |
88
+ | `isDisabled` | no | boolean | Disables the button. Default: false |
89
+ | `label` | yes | string | Button text |
90
+ | `size` | no | [ButtonSize](./definitions.md#buttonsize) | Button size. Default: M |
91
+
92
+ No additional properties.
93
+
94
+ ## AppNavBarBadge
95
+
96
+ Badge shown next to the nav item title
97
+
98
+ ### Fields
99
+
100
+ | Name | Required | Type | Description |
101
+ |---|---:|---|---|
102
+ | `appearance` | no | [BadgeAppearance](./definitions.md#badgeappearance) | Badge visual style |
103
+ | `text` | yes | string | Text to display in the badge |
104
+
105
+ No additional properties.
106
+
107
+ ## AvatarTip
108
+
109
+ Tooltip shown on avatar hover. Object with content string and optional title
110
+
111
+ ### Fields
112
+
113
+ | Name | Required | Type | Description |
114
+ |---|---:|---|---|
115
+ | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
116
+ | `content` | yes | string | Tooltip text content |
117
+ | `title` | no | string | Tooltip title text |
118
+
119
+ No additional properties.
120
+
121
+ ## AvatarValue
122
+
123
+ Avatar configuration to display with the step. Supports image URLs
124
+
125
+ ### Fields
126
+
127
+ | Name | Required | Type | Description |
128
+ |---|---:|---|---|
129
+ | `imageUrl` | no | string | URL of the avatar image |
130
+ | `type` | no | [AvatarValueType](./definitions.md#avatarvaluetype) | Avatar type |
131
+
132
+ No additional properties.
133
+
134
+ ## BadgeTip
135
+
136
+ Tooltip configuration to show on hover
137
+
138
+ ### Fields
139
+
140
+ | Name | Required | Type | Description |
141
+ |---|---:|---|---|
142
+ | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip theme. Default: LIGHT |
143
+ | `content` | yes | string | Tooltip text content |
144
+ | `isDelayed` | no | boolean | Add delay before showing/hiding the tooltip. Default: false |
145
+ | `maxWidth` | no | unknown | Max width of tooltip. Number in px or CSS string |
146
+ | `placement` | no | [BadgeTipPlacement](./definitions.md#badgetipplacement) | Tooltip position relative to badge. Default: bottom |
147
+
148
+ No additional properties.
149
+
150
+ ## BreadcrumbItem
151
+
152
+ ### Fields
153
+
154
+ | Name | Required | Type | Description |
155
+ |---|---:|---|---|
156
+ | `href` | no | string | URL to navigate to when clicked |
157
+ | `isDisabled` | no | boolean | Disables the breadcrumb item |
158
+ | `title` | yes | string | Display label for the breadcrumb item |
159
+ | `value` | yes | string | Unique value identifier for the item |
160
+
161
+ No additional properties.
162
+
163
+ ## CardAction
164
+
165
+ ### Fields
166
+
167
+ | Name | Required | Type | Description |
168
+ |---|---:|---|---|
169
+ | `icon` | no | string | Icon name from Icon.TYPES (e.g. "EDIT", "DELETE") |
170
+ | `id` | yes | string | Unique identifier for the action |
171
+ | `label` | yes | string | Label text for the action |
172
+
173
+ No additional properties.
174
+
175
+ ## CheckboxArg
176
+
177
+ ### Fields
178
+
179
+ _No fields._
180
+
181
+ Additional properties: unknown.
182
+
183
+ ## CheckboxCheck
184
+
185
+ ### Fields
186
+
187
+ | Name | Required | Type | Description |
188
+ |---|---:|---|---|
189
+ | `args` | no | [CheckboxArg](./types.md#checkboxarg) | |
190
+ | `message` | yes | string | |
191
+ | `type` | yes | string | |
192
+
193
+ No additional properties.
194
+
195
+ ## CheckboxGroupArg
196
+
197
+ ### Fields
198
+
199
+ _No fields._
200
+
201
+ Additional properties: unknown.
202
+
203
+ ## CheckboxGroupCheck
204
+
205
+ ### Fields
206
+
207
+ | Name | Required | Type | Description |
208
+ |---|---:|---|---|
209
+ | `args` | no | [CheckboxGroupArg](./types.md#checkboxgrouparg) | |
210
+ | `message` | yes | string | |
211
+ | `type` | yes | string | |
212
+
213
+ No additional properties.
214
+
215
+ ## CheckboxGroupOption
216
+
217
+ ### Fields
218
+
219
+ | Name | Required | Type | Description |
220
+ |---|---:|---|---|
221
+ | `isDisabled` | no | boolean | Disables this specific checkbox |
222
+ | `label` | yes | string | Display text for the checkbox option |
223
+ | `secondaryLabel` | no | string | Secondary text below the option label |
224
+ | `tag` | no | unknown | Optional tag/label displayed with the option |
225
+ | `tip` | no | string | Tooltip text shown on hover |
226
+ | `value` | yes | unknown | Value stored when option is selected |
227
+
228
+ No additional properties.
229
+
230
+ ## CheckListList
231
+
232
+ ### Fields
233
+
234
+ | Name | Required | Type | Description |
235
+ |---|---:|---|---|
236
+ | `branches` | no | [CheckListList](./types.md#checklistlist)[] | Nested child items |
237
+ | `checkListOptions` | no | [CheckListOption](./types.md#checklistoption) | Per-item input type overrides |
238
+ | `isChecked` | yes | boolean | Whether this item is checked |
239
+ | `isDefaultOpen` | no | boolean | If true, nested items are expanded by default |
240
+ | `isDisabled` | no | boolean | Disables interaction for this item |
241
+ | `label` | yes | string | Display text for this item |
242
+ | `showMoreSize` | no | number | Number of child items shown before "show more" toggle |
243
+ | `value` | yes | string | Unique identifier for this item |
244
+
245
+ No additional properties.
246
+
247
+ ## CheckListOption
248
+
249
+ Per-item input type overrides
250
+
251
+ ### Fields
252
+
253
+ | Name | Required | Type | Description |
254
+ |---|---:|---|---|
255
+ | `shouldHaveNegativeCheckbox` | no | boolean | Override negative checkbox for this item |
256
+ | `type` | no | [CheckListType](./definitions.md#checklisttype) | Override input type for this item |
257
+
258
+ No additional properties.
259
+
260
+ ## ChipTip
261
+
262
+ Tooltip configuration. Chip has default overflow tooltip behavior
263
+
264
+ ### Fields
265
+
266
+ | Name | Required | Type | Description |
267
+ |---|---:|---|---|
268
+ | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance (LIGHT, DARK). Default: LIGHT |
269
+ | `content` | yes | string | Tooltip content text |
270
+ | `isVisible` | no | boolean | Control tooltip visibility from parent |
271
+ | `maxHeight` | no | unknown | Tooltip max height (number in px or CSS string) |
272
+ | `maxWidth` | no | unknown | Tooltip max width (number in px or CSS string) |
273
+ | `placement` | no | [ChipTipPlacement](./definitions.md#chiptipplacement) | Tooltip placement relative to chip. Default: TOP_START |
274
+
275
+ No additional properties.
276
+
277
+ ## CollapseBelow
278
+
279
+ Configure when each priority level auto-collapses based on container width. Keys are priority numbers, values are breakpoint tokens. Use false to disable auto-collapse for a priority level
280
+
281
+ ### Fields
282
+
283
+ _No fields._
284
+
285
+ Additional properties: unknown.
286
+
287
+ ## ColorPickerArg
288
+
289
+ ### Fields
290
+
291
+ _No fields._
292
+
293
+ Additional properties: unknown.
294
+
295
+ ## ColorPickerCheck
296
+
297
+ ### Fields
298
+
299
+ | Name | Required | Type | Description |
300
+ |---|---:|---|---|
301
+ | `args` | no | [ColorPickerArg](./types.md#colorpickerarg) | |
302
+ | `message` | yes | string | |
303
+ | `type` | yes | string | |
304
+
305
+ No additional properties.
306
+
307
+ ## Column
308
+
309
+ ### Fields
310
+
311
+ | Name | Required | Type | Description |
312
+ |---|---:|---|---|
313
+ | `align` | no | [HeadingAlign](./definitions.md#headingalign) | Text alignment for this column |
314
+ | `header` | yes | string | Column header text |
315
+ | `key` | yes | string | Key to look up cell value in each row object |
316
+ | `width` | no | unknown | Column width in px (number) or CSS string |
317
+ | `wrapText` | no | boolean | Whether to wrap text in cells of this column. Default: false (nowrap) |
318
+
319
+ No additional properties.
320
+
321
+ ## CurrencyArg
322
+
323
+ ### Fields
324
+
325
+ _No fields._
326
+
327
+ Additional properties: unknown.
328
+
329
+ ## CurrencyCheck
330
+
331
+ ### Fields
332
+
333
+ | Name | Required | Type | Description |
334
+ |---|---:|---|---|
335
+ | `args` | no | [CurrencyArg](./types.md#currencyarg) | |
336
+ | `message` | yes | string | |
337
+ | `type` | yes | string | |
338
+
339
+ No additional properties.
340
+
341
+ ## DateArg
342
+
343
+ ### Fields
344
+
345
+ _No fields._
346
+
347
+ Additional properties: unknown.
348
+
349
+ ## DateCheck
350
+
351
+ ### Fields
352
+
353
+ | Name | Required | Type | Description |
354
+ |---|---:|---|---|
355
+ | `args` | no | [DateArg](./types.md#datearg) | |
356
+ | `message` | yes | string | |
357
+ | `type` | yes | string | |
358
+
359
+ No additional properties.
360
+
361
+ ## DateInlineMultiArg
362
+
363
+ ### Fields
364
+
365
+ _No fields._
366
+
367
+ Additional properties: unknown.
368
+
369
+ ## DateInlineMultiCheck
370
+
371
+ ### Fields
372
+
373
+ | Name | Required | Type | Description |
374
+ |---|---:|---|---|
375
+ | `args` | no | [DateInlineMultiArg](./types.md#dateinlinemultiarg) | |
376
+ | `message` | yes | string | |
377
+ | `type` | yes | string | |
378
+
379
+ No additional properties.
380
+
381
+ ## DateRangeArg
382
+
383
+ ### Fields
384
+
385
+ _No fields._
386
+
387
+ Additional properties: unknown.
388
+
389
+ ## DateRangeCheck
390
+
391
+ ### Fields
392
+
393
+ | Name | Required | Type | Description |
394
+ |---|---:|---|---|
395
+ | `args` | no | [DateRangeArg](./types.md#daterangearg) | |
396
+ | `message` | yes | string | |
397
+ | `type` | yes | string | |
398
+
399
+ No additional properties.
400
+
401
+ ## DaySelectorArg
402
+
403
+ ### Fields
404
+
405
+ _No fields._
406
+
407
+ Additional properties: unknown.
408
+
409
+ ## DaySelectorCheck
410
+
411
+ ### Fields
412
+
413
+ | Name | Required | Type | Description |
414
+ |---|---:|---|---|
415
+ | `args` | no | [DaySelectorArg](./types.md#dayselectorarg) | |
416
+ | `message` | yes | string | |
417
+ | `type` | yes | string | |
418
+
419
+ No additional properties.
420
+
421
+ ## DaySelectorTip
422
+
423
+ ### Fields
424
+
425
+ | Name | Required | Type | Description |
426
+ |---|---:|---|---|
427
+ | `content` | yes | string | |
428
+
429
+ No additional properties.
430
+
431
+ ## DraggableListList
432
+
433
+ ### Fields
434
+
435
+ | Name | Required | Type | Description |
436
+ |---|---:|---|---|
437
+ | `id` | yes | unknown | Unique identifier for the item |
438
+ | `label` | no | string | Display label for the item |
439
+
440
+ No additional properties.
441
+
442
+ ## DropdownList
443
+
444
+ ### Fields
445
+
446
+ | Name | Required | Type | Description |
447
+ |---|---:|---|---|
448
+ | `label` | yes | string | Display text for the dropdown item |
449
+ | `value` | yes | string | Value identifier for the dropdown item |
450
+
451
+ No additional properties.
452
+
453
+ ## DropdownList2
454
+
455
+ ### Fields
456
+
457
+ | Name | Required | Type | Description |
458
+ |---|---:|---|---|
459
+ | `disabledInfo` | no | unknown | Tooltip content shown when the option is disabled |
460
+ | `isDisabled` | no | boolean | Disables this option |
461
+ | `label` | yes | string | Display text for the option |
462
+ | `labelIcon` | no | string | Icon name to show next to the label |
463
+ | `leftIconType` | no | string | Icon name to show on the left side of the item |
464
+ | `quaternaryLabel` | no | string | Quaternary text below the tertiary label |
465
+ | `secondaryLabel` | no | string | Secondary text below the main label |
466
+ | `tag` | no | string | Tag label shown beside the option text |
467
+ | `tertiaryLabel` | no | string | Tertiary text below the secondary label |
468
+ | `type` | no | [DropdownList2Type](./definitions.md#dropdownlist2type) | Visual style type for the option (WARNING or ALERT) |
469
+ | `value` | yes | string | Unique value for the option |
470
+
471
+ No additional properties.
472
+
473
+ ## EmailArg
474
+
475
+ ### Fields
476
+
477
+ _No fields._
478
+
479
+ Additional properties: unknown.
480
+
481
+ ## EmailCheck
482
+
483
+ ### Fields
484
+
485
+ | Name | Required | Type | Description |
486
+ |---|---:|---|---|
487
+ | `args` | no | [EmailArg](./types.md#emailarg) | |
488
+ | `message` | yes | string | |
489
+ | `type` | yes | string | |
490
+
491
+ No additional properties.
492
+
493
+ ## FileDropArg
494
+
495
+ ### Fields
496
+
497
+ _No fields._
498
+
499
+ Additional properties: unknown.
500
+
501
+ ## FileDropCheck
502
+
503
+ ### Fields
504
+
505
+ | Name | Required | Type | Description |
506
+ |---|---:|---|---|
507
+ | `args` | no | [FileDropArg](./types.md#filedroparg) | |
508
+ | `message` | yes | string | |
509
+ | `type` | yes | string | |
510
+
511
+ No additional properties.
512
+
513
+ ## FileDropCropperConfig
514
+
515
+ Cropper configuration
516
+
517
+ ### Fields
518
+
519
+ | Name | Required | Type | Description |
520
+ |---|---:|---|---|
521
+ | `aspectRatio` | no | [FileDropCropperConfigAspectRatio](./definitions.md#filedropcropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
522
+ | `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
523
+ | `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
524
+ | `title` | no | string | Title for the cropper modal |
525
+
526
+ No additional properties.
527
+
528
+ ## FileDropDefaultValue
529
+
530
+ ### Fields
531
+
532
+ | Name | Required | Type | Description |
533
+ |---|---:|---|---|
534
+ | `name` | no | string | File name |
535
+ | `content` | no | string | File content as a base64 data URL |
536
+ | `hasError` | no | boolean | Whether the file has an error |
537
+ | `previewUrl` | no | string | Preview URL for the file |
538
+ | `progress` | no | number | Upload progress 0-100 |
539
+ | `tooltipText` | no | string | Tooltip text shown on error |
540
+ | `type` | no | string | MIME type of the file |
541
+ | `url` | no | string | URL of the uploaded file |
542
+
543
+ No additional properties.
544
+
545
+ ## FileDropValue
546
+
547
+ ### Fields
548
+
549
+ | Name | Required | Type | Description |
550
+ |---|---:|---|---|
551
+ | `name` | no | string | File name |
552
+ | `content` | no | string | File content as a base64 data URL |
553
+ | `hasError` | no | boolean | Whether the file has an error |
554
+ | `previewUrl` | no | string | Preview URL for the file |
555
+ | `progress` | no | number | Upload progress 0-100 |
556
+ | `tooltipText` | no | string | Tooltip text shown on error |
557
+ | `type` | no | string | MIME type of the file |
558
+ | `url` | no | string | URL of the uploaded file |
559
+
560
+ No additional properties.
561
+
562
+ ## FormCheckboxGroupOption
563
+
564
+ ### Fields
565
+
566
+ | Name | Required | Type | Description |
567
+ |---|---:|---|---|
568
+ | `isDisabled` | no | boolean | Disables this specific checkbox |
569
+ | `label` | yes | string | Display text for the checkbox option |
570
+ | `secondaryLabel` | no | string | Secondary text below the option label |
571
+ | `tag` | no | unknown | Optional tag/label displayed with the option |
572
+ | `tip` | no | string | Tooltip text shown on hover |
573
+ | `value` | yes | unknown | Value stored when option is selected |
574
+
575
+ No additional properties.
576
+
577
+ ## FormCheckboxGroupValidationError
578
+
579
+ Map of rule name to error message
580
+
581
+ ### Fields
582
+
583
+ _No fields._
584
+
585
+ Additional properties: string.
586
+
587
+ ## FormCheckboxValidationError
588
+
589
+ Map of rule name to error message
590
+
591
+ ### Fields
592
+
593
+ _No fields._
594
+
595
+ Additional properties: string.
596
+
597
+ ## FormCurrencyValidationError
598
+
599
+ Map of rule name to error message
600
+
601
+ ### Fields
602
+
603
+ _No fields._
604
+
605
+ Additional properties: string.
606
+
607
+ ## FormDateRangeValidationError
608
+
609
+ Map of rule name to error message
610
+
611
+ ### Fields
612
+
613
+ _No fields._
614
+
615
+ Additional properties: string.
616
+
617
+ ## FormDateValidationError
618
+
619
+ Map of rule name to error message
620
+
621
+ ### Fields
622
+
623
+ _No fields._
624
+
625
+ Additional properties: string.
626
+
627
+ ## FormDaySelectorValidationError
628
+
629
+ Map of rule name to error message
630
+
631
+ ### Fields
632
+
633
+ _No fields._
634
+
635
+ Additional properties: string.
636
+
637
+ ## FormEmailValidationError
638
+
639
+ Map of rule name to error message
640
+
641
+ ### Fields
642
+
643
+ _No fields._
644
+
645
+ Additional properties: string.
646
+
647
+ ## FormFileCropperConfig
648
+
649
+ Cropper configuration
650
+
651
+ ### Fields
652
+
653
+ | Name | Required | Type | Description |
654
+ |---|---:|---|---|
655
+ | `aspectRatio` | no | [FileDropCropperConfigAspectRatio](./definitions.md#filedropcropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
656
+ | `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
657
+ | `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
658
+ | `title` | no | string | Title for the cropper modal |
659
+
660
+ No additional properties.
661
+
662
+ ## FormFileDefaultValue
663
+
664
+ ### Fields
665
+
666
+ | Name | Required | Type | Description |
667
+ |---|---:|---|---|
668
+ | `name` | no | string | File name |
669
+ | `content` | no | string | File content as a base64 data URL |
670
+ | `hasError` | no | boolean | Whether the file has an error |
671
+ | `previewUrl` | no | string | Preview URL for the file |
672
+ | `progress` | no | number | Upload progress 0-100 |
673
+ | `tooltipText` | no | string | Tooltip text shown on error |
674
+ | `type` | no | string | MIME type of the file |
675
+ | `url` | no | string | URL of the uploaded file |
676
+
677
+ No additional properties.
678
+
679
+ ## FormFileDropCropperConfig
680
+
681
+ Cropper configuration
682
+
683
+ ### Fields
684
+
685
+ | Name | Required | Type | Description |
686
+ |---|---:|---|---|
687
+ | `aspectRatio` | no | [FileDropCropperConfigAspectRatio](./definitions.md#filedropcropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
688
+ | `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
689
+ | `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
690
+ | `title` | no | string | Title for the cropper modal |
691
+
692
+ No additional properties.
693
+
694
+ ## FormFileDropDefaultValue
695
+
696
+ ### Fields
697
+
698
+ | Name | Required | Type | Description |
699
+ |---|---:|---|---|
700
+ | `name` | no | string | File name |
701
+ | `content` | no | string | File content as a base64 data URL |
702
+ | `hasError` | no | boolean | Whether the file has an error |
703
+ | `previewUrl` | no | string | Preview URL for the file |
704
+ | `progress` | no | number | Upload progress 0-100 |
705
+ | `tooltipText` | no | string | Tooltip text shown on error |
706
+ | `type` | no | string | MIME type of the file |
707
+ | `url` | no | string | URL of the uploaded file |
708
+
709
+ No additional properties.
710
+
711
+ ## FormFileDropValidationError
712
+
713
+ Map of rule name to error message
714
+
715
+ ### Fields
716
+
717
+ _No fields._
718
+
719
+ Additional properties: string.
720
+
721
+ ## FormFileDropValue
722
+
723
+ ### Fields
724
+
725
+ | Name | Required | Type | Description |
726
+ |---|---:|---|---|
727
+ | `name` | no | string | |
728
+ | `content` | no | string | |
729
+ | `hasError` | no | boolean | |
730
+ | `previewUrl` | no | string | |
731
+ | `progress` | no | number | |
732
+ | `tooltipText` | no | string | |
733
+ | `type` | no | string | |
734
+ | `url` | no | string | |
735
+
736
+ No additional properties.
737
+
738
+ ## FormFileValidationError
739
+
740
+ Map of rule name to error message
741
+
742
+ ### Fields
743
+
744
+ _No fields._
745
+
746
+ Additional properties: string.
747
+
748
+ ## FormFileValue
749
+
750
+ ### Fields
751
+
752
+ | Name | Required | Type | Description |
753
+ |---|---:|---|---|
754
+ | `name` | no | string | |
755
+ | `content` | no | string | |
756
+ | `hasError` | no | boolean | |
757
+ | `previewUrl` | no | string | |
758
+ | `progress` | no | number | |
759
+ | `tooltipText` | no | string | |
760
+ | `type` | no | string | |
761
+ | `url` | no | string | |
762
+
763
+ No additional properties.
764
+
765
+ ## FormInputGroupInput
766
+
767
+ Main input configuration with type and inputProps
768
+
769
+ ### Fields
770
+
771
+ | Name | Required | Type | Description |
772
+ |---|---:|---|---|
773
+ | `inputProps` | yes | [FormInputGroupInputProp](./types.md#forminputgroupinputprop) | Props to pass to the input component |
774
+ | `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
775
+
776
+ No additional properties.
777
+
778
+ ## FormInputGroupInputProp
779
+
780
+ Props to pass to the input component
781
+
782
+ ### Fields
783
+
784
+ _No fields._
785
+
786
+ Additional properties: unknown.
787
+
788
+ ## FormInputGroupValidationError
789
+
790
+ Map of rule name to error message
791
+
792
+ ### Fields
793
+
794
+ _No fields._
795
+
796
+ Additional properties: string.
797
+
798
+ ## FormMaskerValidationError
799
+
800
+ Map of rule name to error message
801
+
802
+ ### Fields
803
+
804
+ _No fields._
805
+
806
+ Additional properties: string.
807
+
808
+ ## FormNumberValidationError
809
+
810
+ Map of rule name to error message
811
+
812
+ ### Fields
813
+
814
+ _No fields._
815
+
816
+ Additional properties: string.
817
+
818
+ ## FormPasswordValidationError
819
+
820
+ Map of rule name to error message
821
+
822
+ ### Fields
823
+
824
+ _No fields._
825
+
826
+ Additional properties: string.
827
+
828
+ ## FormPercentageValidationError
829
+
830
+ Map of rule name to error message
831
+
832
+ ### Fields
833
+
834
+ _No fields._
835
+
836
+ Additional properties: string.
837
+
838
+ ## FormPhoneValidationError
839
+
840
+ Map of rule name to error message
841
+
842
+ ### Fields
843
+
844
+ _No fields._
845
+
846
+ Additional properties: string.
847
+
848
+ ## FormRadioOption
849
+
850
+ ### Fields
851
+
852
+ | Name | Required | Type | Description |
853
+ |---|---:|---|---|
854
+ | `isActive` | no | boolean | Controls focus state of the option |
855
+ | `isDisabled` | no | boolean | Disables this specific option |
856
+ | `label` | yes | string | Display text for the option |
857
+ | `secondaryLabel` | no | string | Secondary text below the option label |
858
+ | `tag` | no | unknown | Optional tag/label displayed with the option |
859
+ | `tip` | no | string | Tooltip text shown on hover |
860
+ | `value` | yes | unknown | Value stored when option is selected |
861
+
862
+ No additional properties.
863
+
864
+ ## FormRadioValidationError
865
+
866
+ Map of rule name to error message
867
+
868
+ ### Fields
869
+
870
+ _No fields._
871
+
872
+ Additional properties: string.
873
+
874
+ ## FormSegmentedControlOption
875
+
876
+ ### Fields
877
+
878
+ | Name | Required | Type | Description |
879
+ |---|---:|---|---|
880
+ | `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style for this specific option |
881
+ | `aria-label` | no | string | Accessible label, required if label is not provided (e.g. for icon-only items) |
882
+ | `icon` | no | string | Icon to display for icon-only items. Requires aria-label or label for accessibility |
883
+ | `isDisabled` | no | boolean | Disables this specific option |
884
+ | `label` | no | string | Display text for the option |
885
+ | `tip` | no | [FormSegmentedControlTip](./types.md#formsegmentedcontroltip) | Tooltip to show on hover for this option |
886
+ | `value` | yes | string | Value stored when option is selected |
887
+
888
+ No additional properties.
889
+
890
+ ## FormSegmentedControlTip
891
+
892
+ Tooltip to show on hover for this option
893
+
894
+ ### Fields
895
+
896
+ | Name | Required | Type | Description |
897
+ |---|---:|---|---|
898
+ | `content` | yes | string | Tooltip text content |
899
+
900
+ No additional properties.
901
+
902
+ ## FormSegmentedControlValidationError
903
+
904
+ Map of rule name to error message
905
+
906
+ ### Fields
907
+
908
+ _No fields._
909
+
910
+ Additional properties: string.
911
+
912
+ ## FormSelectableGroupList
913
+
914
+ ### Fields
915
+
916
+ _No fields._
917
+
918
+ Additional properties: unknown.
919
+
920
+ ## FormSelectableGroupValidationError
921
+
922
+ Map of rule name to error message
923
+
924
+ ### Fields
925
+
926
+ _No fields._
927
+
928
+ Additional properties: string.
929
+
930
+ ## FormSelectValidationError
931
+
932
+ Map of rule name to error message
933
+
934
+ ### Fields
935
+
936
+ _No fields._
937
+
938
+ Additional properties: string.
939
+
940
+ ## FormSignatureValidationError
941
+
942
+ Map of rule name to error message
943
+
944
+ ### Fields
945
+
946
+ _No fields._
947
+
948
+ Additional properties: string.
949
+
950
+ ## FormSinValidationError
951
+
952
+ Map of rule name to error message
953
+
954
+ ### Fields
955
+
956
+ _No fields._
957
+
958
+ Additional properties: string.
959
+
960
+ ## FormSliderMark
961
+
962
+ Named marks on the slider track. Keys are numeric positions, values are labels
963
+
964
+ ### Fields
965
+
966
+ _No fields._
967
+
968
+ Additional properties: string.
969
+
970
+ ## FormSliderValidationError
971
+
972
+ Map of rule name to error message
973
+
974
+ ### Fields
975
+
976
+ _No fields._
977
+
978
+ Additional properties: string.
979
+
980
+ ## FormSsnValidationError
981
+
982
+ Map of rule name to error message
983
+
984
+ ### Fields
985
+
986
+ _No fields._
987
+
988
+ Additional properties: string.
989
+
990
+ ## FormSurveyList
991
+
992
+ ### Fields
993
+
994
+ | Name | Required | Type | Description |
995
+ |---|---:|---|---|
996
+ | `isDisabled` | no | boolean | Disable this specific option |
997
+ | `label` | no | unknown | Display label for the option |
998
+ | `selectionColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Override selected surface color token for this option |
999
+ | `value` | yes | unknown | Value when selected |
1000
+
1001
+ No additional properties.
1002
+
1003
+ ## FormSurveyRangeLabel
1004
+
1005
+ Labels for lowest and highest options
1006
+
1007
+ ### Fields
1008
+
1009
+ | Name | Required | Type | Description |
1010
+ |---|---:|---|---|
1011
+ | `lower` | yes | string | Label for the lowest option |
1012
+ | `upper` | yes | string | Label for the highest option |
1013
+
1014
+ No additional properties.
1015
+
1016
+ ## FormSurveyValidationError
1017
+
1018
+ Map of rule name to error message
1019
+
1020
+ ### Fields
1021
+
1022
+ _No fields._
1023
+
1024
+ Additional properties: string.
1025
+
1026
+ ## FormSwitchValidationError
1027
+
1028
+ Map of rule name to error message
1029
+
1030
+ ### Fields
1031
+
1032
+ _No fields._
1033
+
1034
+ Additional properties: string.
1035
+
1036
+ ## FormTextareaValidationError
1037
+
1038
+ Map of rule name to error message
1039
+
1040
+ ### Fields
1041
+
1042
+ _No fields._
1043
+
1044
+ Additional properties: string.
1045
+
1046
+ ## FormTextAutoSuggestSuggestion
1047
+
1048
+ ### Fields
1049
+
1050
+ | Name | Required | Type | Description |
1051
+ |---|---:|---|---|
1052
+ | `label` | yes | string | Display text for the suggestion |
1053
+ | `value` | yes | unknown | Value stored when suggestion is selected |
1054
+
1055
+ No additional properties.
1056
+
1057
+ ## FormTextAutoSuggestValidationError
1058
+
1059
+ Map of rule name to error message
1060
+
1061
+ ### Fields
1062
+
1063
+ _No fields._
1064
+
1065
+ Additional properties: string.
1066
+
1067
+ ## FormTextValidationError
1068
+
1069
+ Map of rule name to error message
1070
+
1071
+ ### Fields
1072
+
1073
+ _No fields._
1074
+
1075
+ Additional properties: string.
1076
+
1077
+ ## FormTimeValidationError
1078
+
1079
+ Map of rule name to error message
1080
+
1081
+ ### Fields
1082
+
1083
+ _No fields._
1084
+
1085
+ Additional properties: string.
1086
+
1087
+ ## FormTimezoneValidationError
1088
+
1089
+ Map of rule name to error message
1090
+
1091
+ ### Fields
1092
+
1093
+ _No fields._
1094
+
1095
+ Additional properties: string.
1096
+
1097
+ ## FormTreeFuseOption
1098
+
1099
+ Fuse.js search options for customizing search behavior
1100
+
1101
+ ### Fields
1102
+
1103
+ _No fields._
1104
+
1105
+ Additional properties: unknown.
1106
+
1107
+ ## FormTreeList
1108
+
1109
+ ### Fields
1110
+
1111
+ | Name | Required | Type | Description |
1112
+ |---|---:|---|---|
1113
+ | `disabledInfo` | no | unknown | Tooltip shown when item is disabled |
1114
+ | `isDisabled` | no | boolean | Disable this item |
1115
+ | `label` | yes | string | Display label for the item |
1116
+ | `parent` | no | string | Parent item value, null for root items |
1117
+ | `secondaryLabel` | no | string | Supporting text below the label |
1118
+ | `tag` | no | unknown | Chip/tag to display next to the label |
1119
+ | `value` | yes | string | Unique identifier for the item |
1120
+
1121
+ No additional properties.
1122
+
1123
+ ## FormTreeSelectFuseOption
1124
+
1125
+ Fuse.js search configuration. Default: { keys: ["label", "name"] }
1126
+
1127
+ ### Fields
1128
+
1129
+ _No fields._
1130
+
1131
+ Additional properties: unknown.
1132
+
1133
+ ## FormTreeSelectList
1134
+
1135
+ ### Fields
1136
+
1137
+ | Name | Required | Type | Description |
1138
+ |---|---:|---|---|
1139
+ | `isDisabled` | no | boolean | Disable this item |
1140
+ | `label` | yes | string | Display label for the item |
1141
+ | `parent` | no | string | Parent item value, null for root items |
1142
+ | `secondaryLabel` | no | string | Supporting text below the label |
1143
+ | `value` | yes | string | Unique identifier for the item |
1144
+
1145
+ No additional properties.
1146
+
1147
+ ## FormTreeSelectValidationError
1148
+
1149
+ Map of rule name to error message
1150
+
1151
+ ### Fields
1152
+
1153
+ _No fields._
1154
+
1155
+ Additional properties: string.
1156
+
1157
+ ## FormTreeValidationError
1158
+
1159
+ Map of rule name to error message
1160
+
1161
+ ### Fields
1162
+
1163
+ _No fields._
1164
+
1165
+ Additional properties: string.
1166
+
1167
+ ## FormValidationError
1168
+
1169
+ External validation errors keyed by input name
1170
+
1171
+ ### Fields
1172
+
1173
+ _No fields._
1174
+
1175
+ Additional properties: string.
1176
+
1177
+ ## FormValue
1178
+
1179
+ Form values model. Written to state on change/submit (read-only — push-only)
1180
+
1181
+ ### Fields
1182
+
1183
+ _No fields._
1184
+
1185
+ Additional properties: unknown.
1186
+
1187
+ ## FormWorkEmailValidationError
1188
+
1189
+ Map of rule name to error message
1190
+
1191
+ ### Fields
1192
+
1193
+ _No fields._
1194
+
1195
+ Additional properties: string.
1196
+
1197
+ ## GridAction
1198
+
1199
+ ### Fields
1200
+
1201
+ | Name | Required | Type | Description |
1202
+ |---|---:|---|---|
1203
+ | `aria-label` | no | string | Accessibility label for the action button |
1204
+ | `aria-labelledby` | no | string | ID of element that labels the action button |
1205
+ | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
1206
+ | `iconType` | yes | string | Icon type name (e.g., "EDIT_OUTLINE", "DELETE") |
1207
+ | `id` | yes | string | Unique identifier for this action. Written to state on click |
1208
+ | `isDisabled` | no | boolean | Disable the action button. Default: false |
1209
+ | `tip` | no | unknown | Tooltip for the action button. Can be a simple string or tooltip configuration object |
1210
+
1211
+ No additional properties.
1212
+
1213
+ ## InputGroupInput
1214
+
1215
+ Main input configuration with type and inputProps
1216
+
1217
+ ### Fields
1218
+
1219
+ | Name | Required | Type | Description |
1220
+ |---|---:|---|---|
1221
+ | `inputProps` | yes | [InputGroupInputProp](./types.md#inputgroupinputprop) | Props to pass to the input component |
1222
+ | `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
1223
+
1224
+ No additional properties.
1225
+
1226
+ ## InputGroupInputProp
1227
+
1228
+ Props to pass to the input component
1229
+
1230
+ ### Fields
1231
+
1232
+ _No fields._
1233
+
1234
+ Additional properties: unknown.
1235
+
1236
+ ## LayoutValue
1237
+
1238
+ ### Fields
1239
+
1240
+ | Name | Required | Type | Description |
1241
+ |---|---:|---|---|
1242
+ | `border` | no | string | CSS border applied to the block wrapper, e.g. "1px solid #E0E0E0". |
1243
+ | `height` | no | number | Height in grid units. Default: 1 |
1244
+ | `identifier` | yes | string | Unique identifier for this layout entry. MUST exactly match the spec id of one of the board's direct child elements — that child is rendered inside this block. |
1245
+ | `maxHeight` | no | number | Maximum height in grid units |
1246
+ | `maxWidth` | no | number | Maximum width in grid units |
1247
+ | `minHeight` | no | number | Minimum height in grid units |
1248
+ | `minWidth` | no | number | Minimum width in grid units |
1249
+ | `shadow` | no | [LayoutValueShadow](./definitions.md#layoutvalueshadow) | Shadow token applied to the block wrapper, e.g. "shadowSm". |
1250
+ | `shapeCorner` | no | [HStackRadius](./definitions.md#hstackradius) | Shape-corner radius token for this block, e.g. "shapeCornerMd". Overrides the parent board `blockShapeCorner` for this entry only. |
1251
+ | `width` | no | number | Width in grid units (1–12). Default: 3 |
1252
+ | `x` | no | number | Horizontal position in grid units. Auto-calculated when omitted. |
1253
+ | `y` | no | number | Vertical position in grid units. Auto-calculated when omitted. |
1254
+
1255
+ No additional properties.
1256
+
1257
+ ## LinkValue
1258
+
1259
+ ### Fields
1260
+
1261
+ | Name | Required | Type | Description |
1262
+ |---|---:|---|---|
1263
+ | `badge` | no | [AppNavBarBadge](./types.md#appnavbarbadge) | Badge shown next to the nav item title |
1264
+ | `icon` | no | string | Icon name from Icon.TYPES (e.g. FOLDER_OUTLINE) |
1265
+ | `isSection` | no | boolean | If true, renders as a non-interactive section header (vertical mode only) |
1266
+ | `links` | no | [LinkValue](./types.md#linkvalue)[] | Nested sub-navigation items |
1267
+ | `path` | no | string | URL path segment for this nav item |
1268
+ | `queryParams` | no | [QueryParam](./types.md#queryparam) | Query parameters to append when navigating to this item |
1269
+ | `title` | yes | string | Display label for this nav item |
1270
+
1271
+ No additional properties.
1272
+
1273
+ ## Location
1274
+
1275
+ Location object with nickname and address. Required for displaying location information
1276
+
1277
+ ### Fields
1278
+
1279
+ | Name | Required | Type | Description |
1280
+ |---|---:|---|---|
1281
+ | `address` | yes | [Addres](./types.md#addres) | Address object with street, city, state, country, and zip |
1282
+ | `nickname` | yes | string | Location nickname or display name |
1283
+
1284
+ No additional properties.
1285
+
1286
+ ## LocationCardAction
1287
+
1288
+ ### Fields
1289
+
1290
+ | Name | Required | Type | Description |
1291
+ |---|---:|---|---|
1292
+ | `icon` | no | string | Icon name from Icon.TYPES (e.g. "EDIT", "DELETE") |
1293
+ | `id` | yes | string | Unique identifier for the action |
1294
+ | `label` | yes | string | Label text for the action |
1295
+
1296
+ No additional properties.
1297
+
1298
+ ## MaskerArg
1299
+
1300
+ ### Fields
1301
+
1302
+ _No fields._
1303
+
1304
+ Additional properties: unknown.
1305
+
1306
+ ## MaskerCheck
1307
+
1308
+ ### Fields
1309
+
1310
+ | Name | Required | Type | Description |
1311
+ |---|---:|---|---|
1312
+ | `args` | no | [MaskerArg](./types.md#maskerarg) | |
1313
+ | `message` | yes | string | |
1314
+ | `type` | yes | string | |
1315
+
1316
+ No additional properties.
1317
+
1318
+ ## MenuListList
1319
+
1320
+ ### Fields
1321
+
1322
+ | Name | Required | Type | Description |
1323
+ |---|---:|---|---|
1324
+ | `description` | no | string | Description text shown inline with the label |
1325
+ | `disabledInfo` | no | string | Tooltip text shown for disabled items |
1326
+ | `isDisabled` | no | boolean | Disables this menu item |
1327
+ | `label` | yes | string | Display text for the menu item |
1328
+ | `leftIconType` | no | string | Icon name to show on the left side of the item |
1329
+ | `quaternaryLabel` | no | string | Quaternary text shown below tertiary label |
1330
+ | `rightLabel` | no | string | Text shown on the right side of the item |
1331
+ | `secondaryLabel` | no | string | Secondary text shown below the label |
1332
+ | `tag` | no | string | Tag label shown beside the item text |
1333
+ | `tertiaryLabel` | no | string | Tertiary text shown below secondary label |
1334
+ | `type` | no | [DropdownList2Type](./definitions.md#dropdownlist2type) | Visual style type for the item (WARNING or ALERT) |
1335
+ | `value` | yes | string | Unique value for the item |
1336
+
1337
+ No additional properties.
1338
+
1339
+ ## Metadata
1340
+
1341
+ Arbitrary key/value context forwarded to the global SnackBar.onTrigger callback. Useful for analytics/logging (e.g. { source: "ProfilePage" })
1342
+
1343
+ ### Fields
1344
+
1345
+ _No fields._
1346
+
1347
+ Additional properties: unknown.
1348
+
1349
+ ## NestedListList
1350
+
1351
+ ### Fields
1352
+
1353
+ | Name | Required | Type | Description |
1354
+ |---|---:|---|---|
1355
+ | `branches` | no | [NestedListList](./types.md#nestedlistlist)[] | Child items |
1356
+ | `isDefaultOpen` | no | boolean | Start expanded |
1357
+ | `label` | yes | string | Display text for the item |
1358
+ | `value` | no | string | Unique value for the item |
1359
+
1360
+ No additional properties.
1361
+
1362
+ ## NumberArg
1363
+
1364
+ ### Fields
1365
+
1366
+ _No fields._
1367
+
1368
+ Additional properties: unknown.
1369
+
1370
+ ## NumberCheck
1371
+
1372
+ ### Fields
1373
+
1374
+ | Name | Required | Type | Description |
1375
+ |---|---:|---|---|
1376
+ | `args` | no | [NumberArg](./types.md#numberarg) | |
1377
+ | `message` | yes | string | |
1378
+ | `type` | yes | string | |
1379
+
1380
+ No additional properties.
1381
+
1382
+ ## NumberStringPadding
1383
+
1384
+ Adds padding characters to the input value
1385
+
1386
+ ### Fields
1387
+
1388
+ | Name | Required | Type | Description |
1389
+ |---|---:|---|---|
1390
+ | `character` | yes | string | Character to use for padding |
1391
+ | `maxLength` | yes | number | Target length after padding |
1392
+ | `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Position to pad (start or end) |
1393
+
1394
+ No additional properties.
1395
+
1396
+ ## ObjectUIAvatarProp
1397
+
1398
+ Avatar configuration for the header
1399
+
1400
+ ### Fields
1401
+
1402
+ | Name | Required | Type | Description |
1403
+ |---|---:|---|---|
1404
+ | `icon` | no | string | Icon type string when type is ICON |
1405
+ | `image` | no | string | Image URL for the avatar |
1406
+ | `imageBackground` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Surface color token for avatar image background |
1407
+ | `isRound` | no | boolean | If false, square avatar is shown. Default: true |
1408
+ | `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
1409
+
1410
+ No additional properties.
1411
+
1412
+ ## ObjectUIHeaderAvatarProp
1413
+
1414
+ Avatar configuration for the header
1415
+
1416
+ ### Fields
1417
+
1418
+ | Name | Required | Type | Description |
1419
+ |---|---:|---|---|
1420
+ | `icon` | no | string | Icon type string when type is ICON |
1421
+ | `image` | no | string | Image URL for the avatar |
1422
+ | `imageBackground` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Surface color token for avatar image background |
1423
+ | `isRound` | no | boolean | If false, square avatar is shown. Default: true |
1424
+ | `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
1425
+
1426
+ No additional properties.
1427
+
1428
+ ## ObjectUIStatsAction
1429
+
1430
+ ### Fields
1431
+
1432
+ | Name | Required | Type | Description |
1433
+ |---|---:|---|---|
1434
+ | `aria-label` | no | string | Accessibility label for the action button |
1435
+ | `aria-labelledby` | no | string | ID of element that labels the action button |
1436
+ | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
1437
+ | `iconType` | yes | string | Icon type name (e.g., "EDIT_OUTLINE", "DELETE") |
1438
+ | `id` | yes | string | Unique identifier for this action. Written to state on click |
1439
+ | `isDisabled` | no | boolean | Disable the action button. Default: false |
1440
+ | `tip` | no | unknown | Tooltip for the action button. Can be a simple string or tooltip configuration object |
1441
+
1442
+ No additional properties.
1443
+
1444
+ ## PageHeaderAction
1445
+
1446
+ ### Fields
1447
+
1448
+ | Name | Required | Type | Description |
1449
+ |---|---:|---|---|
1450
+ | `actionType` | no | [PageHeaderActionActionType](./definitions.md#pageheaderactionactiontype) | Type of action component to render. Default: button |
1451
+ | `appearance` | no | [AppNavBarActionAppearance](./definitions.md#appnavbaractionappearance) | Button visual style. Default: PRIMARY |
1452
+ | `icon` | no | string | Icon name from Icon.TYPES (e.g. ADD, EDIT_OUTLINE) |
1453
+ | `id` | yes | string | Unique identifier for the action. Written to actionClickedId state on click |
1454
+ | `isDisabled` | no | boolean | Disables the button. Default: false |
1455
+ | `label` | yes | string | Button text |
1456
+ | `size` | no | [ButtonSize](./definitions.md#buttonsize) | Button size. Default: M |
1457
+ | `variant` | no | [ButtonVariant](./definitions.md#buttonvariant) | Button variant. Default: NORMAL |
1458
+
1459
+ No additional properties.
1460
+
1461
+ ## PaginateListList
1462
+
1463
+ ### Fields
1464
+
1465
+ | Name | Required | Type | Description |
1466
+ |---|---:|---|---|
1467
+ | `id` | yes | unknown | Unique identifier for the item |
1468
+ | `label` | yes | string | Display text for the item |
1469
+
1470
+ No additional properties.
1471
+
1472
+ ## PartnerCompany
1473
+
1474
+ Partner company data for profile URL routing
1475
+
1476
+ ### Fields
1477
+
1478
+ _No fields._
1479
+
1480
+ Additional properties: unknown.
1481
+
1482
+ ## PasswordArg
1483
+
1484
+ ### Fields
1485
+
1486
+ _No fields._
1487
+
1488
+ Additional properties: unknown.
1489
+
1490
+ ## PasswordCheck
1491
+
1492
+ ### Fields
1493
+
1494
+ | Name | Required | Type | Description |
1495
+ |---|---:|---|---|
1496
+ | `args` | no | [PasswordArg](./types.md#passwordarg) | |
1497
+ | `message` | yes | string | |
1498
+ | `type` | yes | string | |
1499
+
1500
+ No additional properties.
1501
+
1502
+ ## PasswordStringPadding
1503
+
1504
+ Pads input value with character until reaching maxLength
1505
+
1506
+ ### Fields
1507
+
1508
+ | Name | Required | Type | Description |
1509
+ |---|---:|---|---|
1510
+ | `character` | yes | string | Character to use for padding |
1511
+ | `maxLength` | yes | number | Target length after padding |
1512
+ | `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Where to add padding: start or end |
1513
+
1514
+ No additional properties.
1515
+
1516
+ ## PercentageArg
1517
+
1518
+ ### Fields
1519
+
1520
+ _No fields._
1521
+
1522
+ Additional properties: unknown.
1523
+
1524
+ ## PercentageCheck
1525
+
1526
+ ### Fields
1527
+
1528
+ | Name | Required | Type | Description |
1529
+ |---|---:|---|---|
1530
+ | `args` | no | [PercentageArg](./types.md#percentagearg) | |
1531
+ | `message` | yes | string | |
1532
+ | `type` | yes | string | |
1533
+
1534
+ No additional properties.
1535
+
1536
+ ## PhoneArg
1537
+
1538
+ ### Fields
1539
+
1540
+ _No fields._
1541
+
1542
+ Additional properties: unknown.
1543
+
1544
+ ## PhoneCheck
1545
+
1546
+ ### Fields
1547
+
1548
+ | Name | Required | Type | Description |
1549
+ |---|---:|---|---|
1550
+ | `args` | no | [PhoneArg](./types.md#phonearg) | |
1551
+ | `message` | yes | string | |
1552
+ | `type` | yes | string | |
1553
+
1554
+ No additional properties.
1555
+
1556
+ ## PhoneStringPadding
1557
+
1558
+ Pads input value with character until reaching maxLength
1559
+
1560
+ ### Fields
1561
+
1562
+ | Name | Required | Type | Description |
1563
+ |---|---:|---|---|
1564
+ | `character` | yes | string | Character to use for padding |
1565
+ | `maxLength` | yes | number | Target length after padding |
1566
+ | `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Where to add padding: start or end |
1567
+
1568
+ No additional properties.
1569
+
1570
+ ## ProgressStepsStep
1571
+
1572
+ ### Fields
1573
+
1574
+ | Name | Required | Type | Description |
1575
+ |---|---:|---|---|
1576
+ | `hasError` | no | boolean | Marks the step as having an error |
1577
+ | `icon` | no | string | Icon type from Icon.TYPES to display for the step |
1578
+ | `isDisabled` | no | boolean | Disables the step |
1579
+ | `subtitle` | no | string | Subtitle text for the step |
1580
+ | `title` | no | string | Title text for the step |
1581
+
1582
+ No additional properties.
1583
+
1584
+ ## QueryParam
1585
+
1586
+ Query parameters to append when navigating to this item
1587
+
1588
+ ### Fields
1589
+
1590
+ _No fields._
1591
+
1592
+ Additional properties: string.
1593
+
1594
+ ## RadioArg
1595
+
1596
+ ### Fields
1597
+
1598
+ _No fields._
1599
+
1600
+ Additional properties: unknown.
1601
+
1602
+ ## RadioCheck
1603
+
1604
+ ### Fields
1605
+
1606
+ | Name | Required | Type | Description |
1607
+ |---|---:|---|---|
1608
+ | `args` | no | [RadioArg](./types.md#radioarg) | |
1609
+ | `message` | yes | string | |
1610
+ | `type` | yes | string | |
1611
+
1612
+ No additional properties.
1613
+
1614
+ ## RadioOption
1615
+
1616
+ ### Fields
1617
+
1618
+ | Name | Required | Type | Description |
1619
+ |---|---:|---|---|
1620
+ | `isActive` | no | boolean | Controls focus state of the option |
1621
+ | `isDisabled` | no | boolean | Disables this specific option |
1622
+ | `label` | yes | string | Display text for the option |
1623
+ | `secondaryLabel` | no | string | Secondary text below the option label |
1624
+ | `tag` | no | unknown | Optional tag/label displayed with the option |
1625
+ | `tip` | no | string | Tooltip text shown on hover |
1626
+ | `value` | yes | unknown | Value stored when option is selected |
1627
+
1628
+ No additional properties.
1629
+
1630
+ ## RangeSliderArg
1631
+
1632
+ ### Fields
1633
+
1634
+ _No fields._
1635
+
1636
+ Additional properties: unknown.
1637
+
1638
+ ## RangeSliderCheck
1639
+
1640
+ ### Fields
1641
+
1642
+ | Name | Required | Type | Description |
1643
+ |---|---:|---|---|
1644
+ | `args` | no | [RangeSliderArg](./types.md#rangesliderarg) | |
1645
+ | `message` | yes | string | |
1646
+ | `type` | yes | string | |
1647
+
1648
+ No additional properties.
1649
+
1650
+ ## RangeSliderMark
1651
+
1652
+ Marks on slider as {position: label} object (e.g. {10: "10$", 50: "50$"})
1653
+
1654
+ ### Fields
1655
+
1656
+ _No fields._
1657
+
1658
+ Additional properties: string.
1659
+
1660
+ ## RenderProp
1661
+
1662
+ Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string)
1663
+
1664
+ ### Fields
1665
+
1666
+ _No fields._
1667
+
1668
+ Additional properties: [RenderPropValue](./types.md#renderpropvalue).
1669
+
1670
+ ## RenderPropValue
1671
+
1672
+ ### Fields
1673
+
1674
+ | Name | Required | Type | Description |
1675
+ |---|---:|---|---|
1676
+ | `isDisabled` | no | boolean | |
1677
+ | `tip` | no | [DaySelectorTip](./types.md#dayselectortip) | |
1678
+
1679
+ No additional properties.
1680
+
1681
+ ## Role
1682
+
1683
+ ### Fields
1684
+
1685
+ | Name | Required | Type | Description |
1686
+ |---|---:|---|---|
1687
+ | `fullName` | no | string | Display name |
1688
+ | `id` | no | string | Unique identifier |
1689
+ | `image` | no | string | Avatar image URL |
1690
+ | `inviteEmail` | no | string | Invite email (fallback label if fullName/workEmail absent) |
1691
+ | `partnerCompany` | no | [PartnerCompany](./types.md#partnercompany) | Partner company data for profile URL routing |
1692
+ | `user_cache` | no | [User_cache](./types.md#usercache) | User cache data with smallPhoto fallback |
1693
+ | `workEmail` | no | string | Work email |
1694
+
1695
+ No additional properties.
1696
+
1697
+ ## Row
1698
+
1699
+ ### Fields
1700
+
1701
+ _No fields._
1702
+
1703
+ Additional properties: string | number | boolean | null.
1704
+
1705
+ ## Segment
1706
+
1707
+ ### Fields
1708
+
1709
+ | Name | Required | Type | Description |
1710
+ |---|---:|---|---|
1711
+ | `segmentColor` | yes | unknown | Pebble chart color token, or semantic color token for status-related visualizations. |
1712
+ | `value` | yes | number | Numeric value of this segment |
1713
+
1714
+ No additional properties.
1715
+
1716
+ ## SegmentedControlArg
1717
+
1718
+ ### Fields
1719
+
1720
+ _No fields._
1721
+
1722
+ Additional properties: unknown.
1723
+
1724
+ ## SegmentedControlCheck
1725
+
1726
+ ### Fields
1727
+
1728
+ | Name | Required | Type | Description |
1729
+ |---|---:|---|---|
1730
+ | `args` | no | [SegmentedControlArg](./types.md#segmentedcontrolarg) | |
1731
+ | `message` | yes | string | |
1732
+ | `type` | yes | string | |
1733
+
1734
+ No additional properties.
1735
+
1736
+ ## SegmentedControlOption
1737
+
1738
+ ### Fields
1739
+
1740
+ | Name | Required | Type | Description |
1741
+ |---|---:|---|---|
1742
+ | `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style for this specific option |
1743
+ | `aria-label` | no | string | Accessible label, required if label is not provided (e.g. for icon-only items) |
1744
+ | `icon` | no | string | Icon to display for icon-only items. Requires aria-label or label for accessibility |
1745
+ | `isDisabled` | no | boolean | Disables this specific option |
1746
+ | `label` | no | string | Display text for the option |
1747
+ | `tip` | no | [SegmentedControlTip](./types.md#segmentedcontroltip) | Tooltip to show on hover for this option |
1748
+ | `value` | yes | string | Value stored when option is selected |
1749
+
1750
+ No additional properties.
1751
+
1752
+ ## SegmentedControlRangeLabel
1753
+
1754
+ Labels to display at the start and end of the control range
1755
+
1756
+ ### Fields
1757
+
1758
+ | Name | Required | Type | Description |
1759
+ |---|---:|---|---|
1760
+ | `end` | yes | string | Label at the end of the range |
1761
+ | `start` | yes | string | Label at the start of the range |
1762
+
1763
+ No additional properties.
1764
+
1765
+ ## SegmentedControlTip
1766
+
1767
+ Tooltip to show on hover for this option
1768
+
1769
+ ### Fields
1770
+
1771
+ | Name | Required | Type | Description |
1772
+ |---|---:|---|---|
1773
+ | `content` | yes | string | Tooltip text content |
1774
+
1775
+ No additional properties.
1776
+
1777
+ ## SelectableGroupArg
1778
+
1779
+ ### Fields
1780
+
1781
+ _No fields._
1782
+
1783
+ Additional properties: unknown.
1784
+
1785
+ ## SelectableGroupCheck
1786
+
1787
+ ### Fields
1788
+
1789
+ | Name | Required | Type | Description |
1790
+ |---|---:|---|---|
1791
+ | `args` | no | [SelectableGroupArg](./types.md#selectablegrouparg) | |
1792
+ | `message` | yes | string | |
1793
+ | `type` | yes | string | |
1794
+
1795
+ No additional properties.
1796
+
1797
+ ## SelectableGroupList
1798
+
1799
+ ### Fields
1800
+
1801
+ _No fields._
1802
+
1803
+ Additional properties: unknown.
1804
+
1805
+ ## SelectableMenuList
1806
+
1807
+ ### Fields
1808
+
1809
+ | Name | Required | Type | Description |
1810
+ |---|---:|---|---|
1811
+ | `isDisabled` | no | boolean | Disables this option |
1812
+ | `label` | yes | string | Display text for the option |
1813
+ | `value` | yes | string | Unique value for the option |
1814
+
1815
+ No additional properties.
1816
+
1817
+ ## SelectArg
1818
+
1819
+ ### Fields
1820
+
1821
+ _No fields._
1822
+
1823
+ Additional properties: unknown.
1824
+
1825
+ ## SelectAvatarProp
1826
+
1827
+ Avatar configuration for the option
1828
+
1829
+ ### Fields
1830
+
1831
+ | Name | Required | Type | Description |
1832
+ |---|---:|---|---|
1833
+ | `image` | no | string | URL of avatar image |
1834
+ | `title` | no | string | Title/alt text for avatar |
1835
+
1836
+ No additional properties.
1837
+
1838
+ ## SelectCheck
1839
+
1840
+ ### Fields
1841
+
1842
+ | Name | Required | Type | Description |
1843
+ |---|---:|---|---|
1844
+ | `args` | no | [SelectArg](./types.md#selectarg) | |
1845
+ | `message` | yes | string | |
1846
+ | `type` | yes | string | |
1847
+
1848
+ No additional properties.
1849
+
1850
+ ## SelectFooter
1851
+
1852
+ Fixed footer at bottom of dropdown menu
1853
+
1854
+ ### Fields
1855
+
1856
+ | Name | Required | Type | Description |
1857
+ |---|---:|---|---|
1858
+ | `label` | yes | string | Footer link text |
1859
+ | `onClick` | yes | string | Event name to emit when footer is clicked |
1860
+
1861
+ No additional properties.
1862
+
1863
+ ## SelectFuseOption
1864
+
1865
+ Fuse.js search options for customizing fuzzy search behavior
1866
+
1867
+ ### Fields
1868
+
1869
+ _No fields._
1870
+
1871
+ Additional properties: unknown.
1872
+
1873
+ ## SelectOption
1874
+
1875
+ ### Fields
1876
+
1877
+ | Name | Required | Type | Description |
1878
+ |---|---:|---|---|
1879
+ | `avatarProps` | no | [SelectAvatarProp](./types.md#selectavatarprop) | Avatar configuration for the option |
1880
+ | `description` | no | string | Description text shown below the label |
1881
+ | `flag` | no | string | Two-letter country code for flag icon (e.g. "US", "IN") |
1882
+ | `isDisabled` | no | boolean | Disables this specific option |
1883
+ | `isRecommended` | no | boolean | Marks option as recommended with a badge |
1884
+ | `isSeparator` | no | boolean | Renders as a visual separator instead of selectable option |
1885
+ | `label` | yes | string | Display text for the option |
1886
+ | `labelIcon` | no | string | Icon glyph name to show next to the label |
1887
+ | `leftIconType` | no | string | Icon glyph name to show on the left. E.g. "CHECK_CIRCLE_OUTLINE" |
1888
+ | `quaternaryLabel` | no | string | Quaternary label shown below tertiary label |
1889
+ | `rightLabel` | no | string | Label aligned to the right side of the option |
1890
+ | `secondaryLabel` | no | string | Secondary label shown below the main label |
1891
+ | `tertiaryLabel` | no | string | Tertiary label shown below secondary label |
1892
+ | `value` | yes | unknown | Value stored when option is selected |
1893
+
1894
+ No additional properties.
1895
+
1896
+ ## ShowMoreValue
1897
+
1898
+ Configuration for show more behavior
1899
+
1900
+ ### Fields
1901
+
1902
+ | Name | Required | Type | Description |
1903
+ |---|---:|---|---|
1904
+ | `size` | yes | number | Number of items to show initially before "show more" |
1905
+
1906
+ No additional properties.
1907
+
1908
+ ## SignatureArg
1909
+
1910
+ ### Fields
1911
+
1912
+ _No fields._
1913
+
1914
+ Additional properties: unknown.
1915
+
1916
+ ## SignatureCheck
1917
+
1918
+ ### Fields
1919
+
1920
+ | Name | Required | Type | Description |
1921
+ |---|---:|---|---|
1922
+ | `args` | no | [SignatureArg](./types.md#signaturearg) | |
1923
+ | `message` | yes | string | |
1924
+ | `type` | yes | string | |
1925
+
1926
+ No additional properties.
1927
+
1928
+ ## SinArg
1929
+
1930
+ ### Fields
1931
+
1932
+ _No fields._
1933
+
1934
+ Additional properties: unknown.
1935
+
1936
+ ## SinCheck
1937
+
1938
+ ### Fields
1939
+
1940
+ | Name | Required | Type | Description |
1941
+ |---|---:|---|---|
1942
+ | `args` | no | [SinArg](./types.md#sinarg) | |
1943
+ | `message` | yes | string | |
1944
+ | `type` | yes | string | |
1945
+
1946
+ No additional properties.
1947
+
1948
+ ## Size
1949
+
1950
+ Horizontal size constraints for desktop layout. Object with optional default/min/max properties as CSS strings
1951
+
1952
+ ### Fields
1953
+
1954
+ | Name | Required | Type | Description |
1955
+ |---|---:|---|---|
1956
+ | `default` | no | string | Default size as CSS string (e.g., "300px", "30%") |
1957
+ | `max` | no | string | Maximum size as CSS string (e.g., "400px", "50%") |
1958
+ | `min` | no | string | Minimum size as CSS string (e.g., "200px", "20%") |
1959
+
1960
+ No additional properties.
1961
+
1962
+ ## Slide
1963
+
1964
+ ### Fields
1965
+
1966
+ | Name | Required | Type | Description |
1967
+ |---|---:|---|---|
1968
+ | `alt` | no | string | Alt text for the slide image |
1969
+ | `heading` | yes | string | Slide heading text |
1970
+ | `img` | yes | string | Slide image URL |
1971
+
1972
+ No additional properties.
1973
+
1974
+ ## SliderArg
1975
+
1976
+ ### Fields
1977
+
1978
+ _No fields._
1979
+
1980
+ Additional properties: unknown.
1981
+
1982
+ ## SliderCheck
1983
+
1984
+ ### Fields
1985
+
1986
+ | Name | Required | Type | Description |
1987
+ |---|---:|---|---|
1988
+ | `args` | no | [SliderArg](./types.md#sliderarg) | |
1989
+ | `message` | yes | string | |
1990
+ | `type` | yes | string | |
1991
+
1992
+ No additional properties.
1993
+
1994
+ ## SliderMark
1995
+
1996
+ Named marks on the slider track. Keys are numeric positions, values are labels
1997
+
1998
+ ### Fields
1999
+
2000
+ _No fields._
2001
+
2002
+ Additional properties: string.
2003
+
2004
+ ## SsnArg
2005
+
2006
+ ### Fields
2007
+
2008
+ _No fields._
2009
+
2010
+ Additional properties: unknown.
2011
+
2012
+ ## SsnCheck
2013
+
2014
+ ### Fields
2015
+
2016
+ | Name | Required | Type | Description |
2017
+ |---|---:|---|---|
2018
+ | `args` | no | [SsnArg](./types.md#ssnarg) | |
2019
+ | `message` | yes | string | |
2020
+ | `type` | yes | string | |
2021
+
2022
+ No additional properties.
2023
+
2024
+ ## StandAloneStep
2025
+
2026
+ ### Fields
2027
+
2028
+ | Name | Required | Type | Description |
2029
+ |---|---:|---|---|
2030
+ | `avatar` | no | [AvatarValue](./types.md#avatarvalue) | Avatar configuration to display with the step. Supports image URLs |
2031
+ | `badge` | no | [StepperBadge](./types.md#stepperbadge) | Badge configuration to display alongside the step title |
2032
+ | `description` | no | string | Optional step description |
2033
+ | `href` | no | string | URL for the step. Renders the step as an anchor tag with this href (semantic HTML only) |
2034
+ | `status` | no | [StandAloneStepStatus](./definitions.md#standalonestepstatus) | Step status indicator |
2035
+ | `title` | yes | string | Step title text |
2036
+
2037
+ No additional properties.
2038
+
2039
+ ## StepperBadge
2040
+
2041
+ Badge configuration to display alongside the step title
2042
+
2043
+ ### Fields
2044
+
2045
+ | Name | Required | Type | Description |
2046
+ |---|---:|---|---|
2047
+ | `appearance` | no | [BadgeAppearance](./definitions.md#badgeappearance) | Badge color appearance |
2048
+ | `aria-label` | no | string | Accessibility label for the badge |
2049
+ | `text` | yes | string | Badge text content |
2050
+
2051
+ No additional properties.
2052
+
2053
+ ## StepperStep
2054
+
2055
+ ### Fields
2056
+
2057
+ | Name | Required | Type | Description |
2058
+ |---|---:|---|---|
2059
+ | `avatar` | no | [AvatarValue](./types.md#avatarvalue) | Avatar configuration to display with the step. Supports image URLs |
2060
+ | `badge` | no | [StepperBadge](./types.md#stepperbadge) | Badge configuration to display alongside the step title |
2061
+ | `description` | no | string | Optional step description |
2062
+ | `href` | no | string | URL for the step. Renders the step as an anchor tag with this href (semantic HTML only) |
2063
+ | `status` | no | [StandAloneStepStatus](./definitions.md#standalonestepstatus) | Step status indicator |
2064
+ | `title` | yes | string | Step title text |
2065
+
2066
+ No additional properties.
2067
+
2068
+ ## SubmitButtonProp
2069
+
2070
+ Configuration for the form submit button
2071
+
2072
+ ### Fields
2073
+
2074
+ | Name | Required | Type | Description |
2075
+ |---|---:|---|---|
2076
+ | `isDisabled` | no | boolean | Disable submit button |
2077
+ | `isFluid` | no | boolean | Stretch submit button to fill width |
2078
+ | `isLoading` | no | boolean | Show loading spinner on submit button. Bind to state for manual control. |
2079
+ | `label` | no | string | Submit button label |
2080
+ | `size` | no | [ButtonSize](./definitions.md#buttonsize) | Submit button size |
2081
+
2082
+ No additional properties.
2083
+
2084
+ ## SurveyArg
2085
+
2086
+ ### Fields
2087
+
2088
+ _No fields._
2089
+
2090
+ Additional properties: unknown.
2091
+
2092
+ ## SurveyCheck
2093
+
2094
+ ### Fields
2095
+
2096
+ | Name | Required | Type | Description |
2097
+ |---|---:|---|---|
2098
+ | `args` | no | [SurveyArg](./types.md#surveyarg) | |
2099
+ | `message` | yes | string | |
2100
+ | `type` | yes | string | |
2101
+
2102
+ No additional properties.
2103
+
2104
+ ## SurveyList
2105
+
2106
+ ### Fields
2107
+
2108
+ | Name | Required | Type | Description |
2109
+ |---|---:|---|---|
2110
+ | `isDisabled` | no | boolean | Disable this specific option |
2111
+ | `label` | no | unknown | Display label for the option |
2112
+ | `selectionColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Override selected surface color token for this option |
2113
+ | `value` | yes | unknown | Value when selected |
2114
+
2115
+ No additional properties.
2116
+
2117
+ ## SurveyRangeLabel
2118
+
2119
+ Labels for lowest and highest options
2120
+
2121
+ ### Fields
2122
+
2123
+ | Name | Required | Type | Description |
2124
+ |---|---:|---|---|
2125
+ | `lower` | yes | string | Label for the lowest option |
2126
+ | `upper` | yes | string | Label for the highest option |
2127
+
2128
+ No additional properties.
2129
+
2130
+ ## SwitchArg
2131
+
2132
+ ### Fields
2133
+
2134
+ _No fields._
2135
+
2136
+ Additional properties: unknown.
2137
+
2138
+ ## SwitchCheck
2139
+
2140
+ ### Fields
2141
+
2142
+ | Name | Required | Type | Description |
2143
+ |---|---:|---|---|
2144
+ | `args` | no | [SwitchArg](./types.md#switcharg) | |
2145
+ | `message` | yes | string | |
2146
+ | `type` | yes | string | |
2147
+
2148
+ No additional properties.
2149
+
2150
+ ## TabBadge
2151
+
2152
+ Badge to display on the tab
2153
+
2154
+ ### Fields
2155
+
2156
+ | Name | Required | Type | Description |
2157
+ |---|---:|---|---|
2158
+ | `appearance` | no | [BadgeAppearance](./definitions.md#badgeappearance) | Badge appearance variant: INFO_DARK, INFO_LIGHT, ERROR_DARK, ERROR_LIGHT, PRIMARY_DARK, PRIMARY_LIGHT, SUCCESS_DARK, SUCCESS_LIGHT, WARNING_DARK, WARNING_LIGHT, NEUTRAL, BLACK |
2159
+ | `text` | yes | string | Text to display in the badge |
2160
+
2161
+ No additional properties.
2162
+
2163
+ ## TabItem
2164
+
2165
+ ### Fields
2166
+
2167
+ | Name | Required | Type | Description |
2168
+ |---|---:|---|---|
2169
+ | `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the tab |
2170
+ | `disabled` | no | boolean | Whether this tab is disabled |
2171
+ | `icon` | no | string | Icon name for the tab (e.g., FOLDER_OUTLINE) |
2172
+ | `label` | yes | string | Display text for the tab |
2173
+ | `tip` | no | unknown | Tooltip to show on hover |
2174
+ | `value` | yes | unknown | Value for this tab option |
2175
+
2176
+ No additional properties.
2177
+
2178
+ ## TextareaArg
2179
+
2180
+ ### Fields
2181
+
2182
+ _No fields._
2183
+
2184
+ Additional properties: unknown.
2185
+
2186
+ ## TextareaCheck
2187
+
2188
+ ### Fields
2189
+
2190
+ | Name | Required | Type | Description |
2191
+ |---|---:|---|---|
2192
+ | `args` | no | [TextareaArg](./types.md#textareaarg) | |
2193
+ | `message` | yes | string | |
2194
+ | `type` | yes | string | |
2195
+
2196
+ No additional properties.
2197
+
2198
+ ## TextAutoSuggestArg
2199
+
2200
+ ### Fields
2201
+
2202
+ _No fields._
2203
+
2204
+ Additional properties: unknown.
2205
+
2206
+ ## TextAutoSuggestCheck
2207
+
2208
+ ### Fields
2209
+
2210
+ | Name | Required | Type | Description |
2211
+ |---|---:|---|---|
2212
+ | `args` | no | [TextAutoSuggestArg](./types.md#textautosuggestarg) | |
2213
+ | `message` | yes | string | |
2214
+ | `type` | yes | string | |
2215
+
2216
+ No additional properties.
2217
+
2218
+ ## TextAutoSuggestStringPadding
2219
+
2220
+ Pads input value with character until reaching maxLength
2221
+
2222
+ ### Fields
2223
+
2224
+ | Name | Required | Type | Description |
2225
+ |---|---:|---|---|
2226
+ | `character` | yes | string | Character to use for padding |
2227
+ | `maxLength` | yes | number | Target length after padding |
2228
+ | `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Where to add padding: start or end |
2229
+
2230
+ No additional properties.
2231
+
2232
+ ## TextAutoSuggestSuggestion
2233
+
2234
+ ### Fields
2235
+
2236
+ | Name | Required | Type | Description |
2237
+ |---|---:|---|---|
2238
+ | `label` | yes | string | Display text for the suggestion |
2239
+ | `value` | yes | unknown | Value stored when suggestion is selected |
2240
+
2241
+ No additional properties.
2242
+
2243
+ ## TextInputArg
2244
+
2245
+ ### Fields
2246
+
2247
+ _No fields._
2248
+
2249
+ Additional properties: unknown.
2250
+
2251
+ ## TextInputCheck
2252
+
2253
+ ### Fields
2254
+
2255
+ | Name | Required | Type | Description |
2256
+ |---|---:|---|---|
2257
+ | `args` | no | [TextInputArg](./types.md#textinputarg) | |
2258
+ | `message` | yes | string | |
2259
+ | `type` | yes | string | |
2260
+
2261
+ No additional properties.
2262
+
2263
+ ## TextInputStringPadding
2264
+
2265
+ Pads input value with character until reaching maxLength
2266
+
2267
+ ### Fields
2268
+
2269
+ | Name | Required | Type | Description |
2270
+ |---|---:|---|---|
2271
+ | `character` | yes | string | Character to use for padding |
2272
+ | `maxLength` | yes | number | Target length after padding |
2273
+ | `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Where to add padding: start or end |
2274
+
2275
+ No additional properties.
2276
+
2277
+ ## TimeArg
2278
+
2279
+ ### Fields
2280
+
2281
+ _No fields._
2282
+
2283
+ Additional properties: unknown.
2284
+
2285
+ ## TimeCheck
2286
+
2287
+ ### Fields
2288
+
2289
+ | Name | Required | Type | Description |
2290
+ |---|---:|---|---|
2291
+ | `args` | no | [TimeArg](./types.md#timearg) | |
2292
+ | `message` | yes | string | |
2293
+ | `type` | yes | string | |
2294
+
2295
+ No additional properties.
2296
+
2297
+ ## TimeProp
2298
+
2299
+ Configuration for time picker. Sets initial time value independently of date input
2300
+
2301
+ ### Fields
2302
+
2303
+ | Name | Required | Type | Description |
2304
+ |---|---:|---|---|
2305
+ | `defaultValue` | yes | string | Default time as ISO string when no date is selected |
2306
+
2307
+ No additional properties.
2308
+
2309
+ ## TimeRangeArg
2310
+
2311
+ ### Fields
2312
+
2313
+ _No fields._
2314
+
2315
+ Additional properties: unknown.
2316
+
2317
+ ## TimeRangeCheck
2318
+
2319
+ ### Fields
2320
+
2321
+ | Name | Required | Type | Description |
2322
+ |---|---:|---|---|
2323
+ | `args` | no | [TimeRangeArg](./types.md#timerangearg) | |
2324
+ | `message` | yes | string | |
2325
+ | `type` | yes | string | |
2326
+
2327
+ No additional properties.
2328
+
2329
+ ## TimezoneArg
2330
+
2331
+ ### Fields
2332
+
2333
+ _No fields._
2334
+
2335
+ Additional properties: unknown.
2336
+
2337
+ ## TimezoneCheck
2338
+
2339
+ ### Fields
2340
+
2341
+ | Name | Required | Type | Description |
2342
+ |---|---:|---|---|
2343
+ | `args` | no | [TimezoneArg](./types.md#timezonearg) | |
2344
+ | `message` | yes | string | |
2345
+ | `type` | yes | string | |
2346
+
2347
+ No additional properties.
2348
+
2349
+ ## ToggleIcon
2350
+
2351
+ Toggle icon configuration
2352
+
2353
+ ### Fields
2354
+
2355
+ | Name | Required | Type | Description |
2356
+ |---|---:|---|---|
2357
+ | `align` | no | string | CSS alignSelf value. Default: center |
2358
+ | `margin` | no | [ButtonGroupGap](./definitions.md#buttongroupgap) | Margin spacing token for icon alignment |
2359
+ | `size` | no | [IconSize](./definitions.md#iconsize) | Icon size token. Default: 24 |
2360
+
2361
+ No additional properties.
2362
+
2363
+ ## TreeArg
2364
+
2365
+ ### Fields
2366
+
2367
+ _No fields._
2368
+
2369
+ Additional properties: unknown.
2370
+
2371
+ ## TreeCheck
2372
+
2373
+ ### Fields
2374
+
2375
+ | Name | Required | Type | Description |
2376
+ |---|---:|---|---|
2377
+ | `args` | no | [TreeArg](./types.md#treearg) | |
2378
+ | `message` | yes | string | |
2379
+ | `type` | yes | string | |
2380
+
2381
+ No additional properties.
2382
+
2383
+ ## TreeFooter
2384
+
2385
+ Fixed footer with clickable action at bottom of tree
2386
+
2387
+ ### Fields
2388
+
2389
+ | Name | Required | Type | Description |
2390
+ |---|---:|---|---|
2391
+ | `label` | yes | string | Footer button text |
2392
+
2393
+ No additional properties.
2394
+
2395
+ ## TreeFuseOption
2396
+
2397
+ Fuse.js search options for customizing search behavior
2398
+
2399
+ ### Fields
2400
+
2401
+ _No fields._
2402
+
2403
+ Additional properties: unknown.
2404
+
2405
+ ## TreeList
2406
+
2407
+ ### Fields
2408
+
2409
+ | Name | Required | Type | Description |
2410
+ |---|---:|---|---|
2411
+ | `disabledInfo` | no | unknown | Tooltip shown when item is disabled |
2412
+ | `isDisabled` | no | boolean | Disable this item |
2413
+ | `label` | yes | string | Display label for the item |
2414
+ | `parent` | no | string | Parent item value, null for root items |
2415
+ | `secondaryLabel` | no | string | Supporting text below the label |
2416
+ | `tag` | no | unknown | Chip/tag to display next to the label |
2417
+ | `value` | yes | string | Unique identifier for the item |
2418
+
2419
+ No additional properties.
2420
+
2421
+ ## TreeSelectArg
2422
+
2423
+ ### Fields
2424
+
2425
+ _No fields._
2426
+
2427
+ Additional properties: unknown.
2428
+
2429
+ ## TreeSelectCheck
2430
+
2431
+ ### Fields
2432
+
2433
+ | Name | Required | Type | Description |
2434
+ |---|---:|---|---|
2435
+ | `args` | no | [TreeSelectArg](./types.md#treeselectarg) | |
2436
+ | `message` | yes | string | |
2437
+ | `type` | yes | string | |
2438
+
2439
+ No additional properties.
2440
+
2441
+ ## TreeSelectFuseOption
2442
+
2443
+ Fuse.js search configuration. Default: { keys: ["label", "name"] }
2444
+
2445
+ ### Fields
2446
+
2447
+ _No fields._
2448
+
2449
+ Additional properties: unknown.
2450
+
2451
+ ## TreeSelectList
2452
+
2453
+ ### Fields
2454
+
2455
+ | Name | Required | Type | Description |
2456
+ |---|---:|---|---|
2457
+ | `isDisabled` | no | boolean | Disable this item |
2458
+ | `label` | yes | string | Display label for the item |
2459
+ | `parent` | no | string | Parent item value, null for root items |
2460
+ | `secondaryLabel` | no | string | Supporting text below the label |
2461
+ | `value` | yes | string | Unique identifier for the item |
2462
+
2463
+ No additional properties.
2464
+
2465
+ ## User_cache
2466
+
2467
+ User cache data with smallPhoto fallback
2468
+
2469
+ ### Fields
2470
+
2471
+ | Name | Required | Type | Description |
2472
+ |---|---:|---|---|
2473
+ | `smallPhoto` | no | string | Small photo URL |
2474
+
2475
+ Additional properties: unknown.
2476
+
2477
+ ## VerticalSize
2478
+
2479
+ Vertical size constraints for mobile stacked layout. Object with optional default/min/max properties as CSS strings
2480
+
2481
+ ### Fields
2482
+
2483
+ | Name | Required | Type | Description |
2484
+ |---|---:|---|---|
2485
+ | `default` | no | string | Default size as CSS string (e.g., "300px", "30%") |
2486
+ | `max` | no | string | Maximum size as CSS string (e.g., "400px", "50%") |
2487
+ | `min` | no | string | Minimum size as CSS string (e.g., "200px", "20%") |
2488
+
2489
+ No additional properties.
2490
+
2491
+ ## WorkEmailArg
2492
+
2493
+ ### Fields
2494
+
2495
+ _No fields._
2496
+
2497
+ Additional properties: unknown.
2498
+
2499
+ ## WorkEmailCheck
2500
+
2501
+ ### Fields
2502
+
2503
+ | Name | Required | Type | Description |
2504
+ |---|---:|---|---|
2505
+ | `args` | no | [WorkEmailArg](./types.md#workemailarg) | |
2506
+ | `message` | yes | string | |
2507
+ | `type` | yes | string | |
2508
+
2509
+ No additional properties.