@rippling/pebble-sdui-web 0.14.0 → 0.15.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.
@@ -1,4833 +0,0 @@
1
- <!-- Auto-generated from catalogs/core.catalog.json; do not edit directly. -->
2
- # core 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
- ## ActionBindingParam
7
-
8
- Optional params passed to the chained action.
9
-
10
- ### Fields
11
-
12
- _No fields._
13
-
14
- Additional properties: unknown.
15
-
16
- ## ActionCardPadding
17
-
18
- Override container padding per side using Pebble spacing tokens
19
-
20
- ### Fields
21
-
22
- | Name | Required | Type | Description |
23
- |---|---:|---|---|
24
- | `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
25
- | `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
26
- | `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
27
- | `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
28
-
29
- No additional properties.
30
-
31
- ## ActionCardPrimaryAction
32
-
33
- Primary action button configuration
34
-
35
- ### Fields
36
-
37
- | Name | Required | Type | Description |
38
- |---|---:|---|---|
39
- | `icon` | no | string | Icon type string for the action button |
40
- | `isDisabled` | no | boolean | Disable the action button. Default: false |
41
- | `title` | yes | string | Action button label |
42
- | `to` | no | string \| [ActionCardTo](./types.md#actioncardto) | Navigation destination for the action. String URL or { path, openInNewTab? } |
43
-
44
- No additional properties.
45
-
46
- ## ActionCardSecondaryAction
47
-
48
- Secondary action button configuration
49
-
50
- ### Fields
51
-
52
- | Name | Required | Type | Description |
53
- |---|---:|---|---|
54
- | `icon` | no | string | Icon type string for the action button |
55
- | `isDisabled` | no | boolean | Disable the action button. Default: false |
56
- | `title` | yes | string | Action button label |
57
- | `to` | no | string \| [ActionCardTo](./types.md#actioncardto) | Navigation destination for the action. String URL or { path, openInNewTab? } |
58
-
59
- No additional properties.
60
-
61
- ## ActionCardTo
62
-
63
- ### Fields
64
-
65
- | Name | Required | Type | Description |
66
- |---|---:|---|---|
67
- | `openInNewTab` | no | boolean | |
68
- | `path` | yes | string | |
69
-
70
- No additional properties.
71
-
72
- ## Addres
73
-
74
- Address object with street, city, state, country, and zip
75
-
76
- ### Fields
77
-
78
- | Name | Required | Type | Description |
79
- |---|---:|---|---|
80
- | `city` | no | string | City name |
81
- | `country` | yes | string | Country code |
82
- | `countyName` | no | string | County name |
83
- | `state` | no | string | State or province code |
84
- | `streetLine1` | yes | string | Primary street address line |
85
- | `streetLine2` | no | string | Secondary street address line |
86
- | `streetLine3` | no | string | Tertiary street address line |
87
- | `streetLine4` | no | string | Quaternary street address line |
88
- | `zip` | yes | string | Postal/ZIP code |
89
-
90
- No additional properties.
91
-
92
- ## AlertPrimaryAction
93
-
94
- Primary action button configuration
95
-
96
- ### Fields
97
-
98
- | Name | Required | Type | Description |
99
- |---|---:|---|---|
100
- | `icon` | no | string | Icon type string from Icon.TYPES for the action button |
101
- | `isDisabled` | no | boolean | Disable the action button. Default: false |
102
- | `shouldShowSpinner` | no | boolean | Show spinner on the action button. Default: false |
103
- | `title` | yes | string | Action button label |
104
- | `to` | no | string \| [AlertTo](./types.md#alertto) | Navigation destination for the action. String URL or { path, openInNewTab? } |
105
-
106
- No additional properties.
107
-
108
- ## AlertSecondaryAction
109
-
110
- Secondary action button configuration
111
-
112
- ### Fields
113
-
114
- | Name | Required | Type | Description |
115
- |---|---:|---|---|
116
- | `icon` | no | string | Icon type string from Icon.TYPES for the action button |
117
- | `isDisabled` | no | boolean | Disable the action button. Default: false |
118
- | `shouldShowSpinner` | no | boolean | Show spinner on the action button. Default: false |
119
- | `title` | yes | string | Action button label |
120
- | `to` | no | string \| [AlertTo](./types.md#alertto) | Navigation destination for the action. String URL or { path, openInNewTab? } |
121
-
122
- No additional properties.
123
-
124
- ## AlertTo
125
-
126
- ### Fields
127
-
128
- | Name | Required | Type | Description |
129
- |---|---:|---|---|
130
- | `openInNewTab` | no | boolean | |
131
- | `path` | yes | string | |
132
-
133
- No additional properties.
134
-
135
- ## AnimationData
136
-
137
- Lottie animation JSON object. Required if path is not provided
138
-
139
- ### Fields
140
-
141
- _No fields._
142
-
143
- Additional properties: unknown.
144
-
145
- ## AppGroupSelectArg
146
-
147
- ### Fields
148
-
149
- _No fields._
150
-
151
- Additional properties: unknown.
152
-
153
- ## AppGroupSelectAvatarProp
154
-
155
- Avatar configuration for the option
156
-
157
- ### Fields
158
-
159
- | Name | Required | Type | Description |
160
- |---|---:|---|---|
161
- | `image` | no | string | URL of avatar image |
162
- | `title` | no | string | Title/alt text for avatar |
163
-
164
- No additional properties.
165
-
166
- ## AppGroupSelectCheck
167
-
168
- ### Fields
169
-
170
- | Name | Required | Type | Description |
171
- |---|---:|---|---|
172
- | `args` | no | [AppGroupSelectArg](./types.md#appgroupselectarg) | |
173
- | `message` | yes | string | |
174
- | `type` | yes | string | |
175
-
176
- No additional properties.
177
-
178
- ## AppGroupSelectEmptyListPlaceholder
179
-
180
- ### Fields
181
-
182
- | Name | Required | Type | Description |
183
- |---|---:|---|---|
184
- | `onLoading` | no | string | Placeholder shown while list is loading |
185
- | `onNoSearchQuery` | no | string | Placeholder when no search query entered |
186
- | `onNoSearchResults` | no | string | Placeholder when search returns no results |
187
-
188
- No additional properties.
189
-
190
- ## AppGroupSelectFooter
191
-
192
- Fixed footer at bottom of dropdown menu
193
-
194
- ### Fields
195
-
196
- | Name | Required | Type | Description |
197
- |---|---:|---|---|
198
- | `label` | yes | string | Footer link text |
199
- | `onClick` | yes | string | Event name to emit when footer is clicked |
200
-
201
- No additional properties.
202
-
203
- ## AppGroupSelectFuseOption
204
-
205
- Fuse.js search options for customizing fuzzy search behavior
206
-
207
- ### Fields
208
-
209
- _No fields._
210
-
211
- Additional properties: unknown.
212
-
213
- ## AppGroupSelectList
214
-
215
- ### Fields
216
-
217
- | Name | Required | Type | Description |
218
- |---|---:|---|---|
219
- | `avatarProps` | no | [AppGroupSelectAvatarProp](./types.md#appgroupselectavatarprop) | Avatar configuration for the option |
220
- | `description` | no | string | Description text shown below the label |
221
- | `flag` | no | string | Two-letter country code for flag icon (e.g. "US", "IN") |
222
- | `isDisabled` | no | boolean | Disables this specific option |
223
- | `isRecommended` | no | boolean | Marks option as recommended with a badge |
224
- | `isSeparator` | no | boolean | Renders as a visual separator instead of selectable option |
225
- | `label` | yes | string | Display text for the option |
226
- | `labelIcon` | no | string | Icon glyph name to show next to the label |
227
- | `leftIconType` | no | string | Icon glyph name to show on the left. E.g. "CHECK_CIRCLE_OUTLINE" |
228
- | `quaternaryLabel` | no | string | Quaternary label shown below tertiary label |
229
- | `rightLabel` | no | string | Label aligned to the right side of the option |
230
- | `secondaryLabel` | no | string | Secondary label shown below the main label |
231
- | `tertiaryLabel` | no | string | Tertiary label shown below secondary label |
232
- | `value` | yes | unknown | Value stored when option is selected |
233
-
234
- No additional properties.
235
-
236
- ## AppGroupSelectListVariant2
237
-
238
- ### Fields
239
-
240
- | Name | Required | Type | Description |
241
- |---|---:|---|---|
242
- | `label` | yes | string | Group label/header |
243
- | `list` | yes | [AppGroupSelectList](./types.md#appgroupselectlist)[] | Options within this group |
244
-
245
- No additional properties.
246
-
247
- ## AppNavBarAction
248
-
249
- ### Fields
250
-
251
- | Name | Required | Type | Description |
252
- |---|---:|---|---|
253
- | `appearance` | no | [AppNavBarActionAppearance](./definitions.md#appnavbaractionappearance) | Button visual style. Default: PRIMARY |
254
- | `icon` | no | string | Icon name from Icon.TYPES (e.g. ADD, EDIT_OUTLINE) |
255
- | `id` | yes | string | Unique identifier for the action. Written to actionClickedId state on click |
256
- | `isDisabled` | no | boolean | Disables the button. Default: false |
257
- | `label` | yes | string | Button text |
258
- | `size` | no | [ButtonSize](./definitions.md#buttonsize) | Button size. Default: M |
259
-
260
- No additional properties.
261
-
262
- ## AppNavBarNavItemBadge
263
-
264
- Badge shown next to the nav item title
265
-
266
- ### Fields
267
-
268
- | Name | Required | Type | Description |
269
- |---|---:|---|---|
270
- | `appearance` | no | [BadgeAppearance](./definitions.md#badgeappearance) | Badge visual style |
271
- | `text` | yes | string | Text to display in the badge |
272
-
273
- No additional properties.
274
-
275
- ## AppNavBarNavItemQueryParam
276
-
277
- Query parameters to append when navigating to this item
278
-
279
- ### Fields
280
-
281
- _No fields._
282
-
283
- Additional properties: string.
284
-
285
- ## AvatarBadge
286
-
287
- Badge overlay configuration for the avatar
288
-
289
- ### Fields
290
-
291
- | Name | Required | Type | Description |
292
- |---|---:|---|---|
293
- | `aria-label` | yes | string | Accessible label for the badge |
294
- | `char` | no | string | Single character to display in the badge overlay |
295
-
296
- No additional properties.
297
-
298
- ## AvatarIcon
299
-
300
- ### Fields
301
-
302
- | Name | Required | Type | Description |
303
- |---|---:|---|---|
304
- | `backgroundColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | |
305
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | |
306
- | `type` | yes | string | |
307
-
308
- No additional properties.
309
-
310
- ## AvatarTip
311
-
312
- Tooltip shown on avatar hover. Object with content string and optional title
313
-
314
- ### Fields
315
-
316
- | Name | Required | Type | Description |
317
- |---|---:|---|---|
318
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
319
- | `content` | yes | string | Tooltip text content |
320
- | `title` | no | string | Tooltip title text |
321
-
322
- No additional properties.
323
-
324
- ## AvatarTo
325
-
326
- ### Fields
327
-
328
- | Name | Required | Type | Description |
329
- |---|---:|---|---|
330
- | `openInNewTab` | no | boolean | |
331
- | `path` | yes | string | |
332
-
333
- No additional properties.
334
-
335
- ## BadgeTip
336
-
337
- Tooltip configuration to show on hover
338
-
339
- ### Fields
340
-
341
- | Name | Required | Type | Description |
342
- |---|---:|---|---|
343
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip theme. Default: LIGHT |
344
- | `content` | yes | string | Tooltip text content |
345
- | `isDelayed` | no | boolean | Add delay before showing/hiding the tooltip. Default: false |
346
- | `maxWidth` | no | number \| string | Max width of tooltip. Number in px or CSS string |
347
- | `placement` | no | [BadgeTipPlacement](./definitions.md#badgetipplacement) | Tooltip position relative to badge. Default: bottom |
348
-
349
- No additional properties.
350
-
351
- ## BoxBorder
352
-
353
- Structured border using strict token parts
354
-
355
- ### Fields
356
-
357
- | Name | Required | Type | Description |
358
- |---|---:|---|---|
359
- | `color` | no | [BoxBorderColor](./definitions.md#boxbordercolor) | Border color token |
360
- | `style` | no | [BoxBorderStyle](./definitions.md#boxborderstyle) | CSS border style |
361
- | `width` | no | [BoxBorderWidth](./definitions.md#boxborderwidth) | Border width token |
362
-
363
- No additional properties.
364
-
365
- ## BoxGap
366
-
367
- ### Fields
368
-
369
- | Name | Required | Type | Description |
370
- |---|---:|---|---|
371
- | `column` | no | [BoxGap](./definitions.md#boxgap) | Column gap spacing token |
372
- | `row` | no | [BoxGap](./definitions.md#boxgap) | Row gap spacing token |
373
-
374
- No additional properties.
375
-
376
- ## BoxMargin
377
-
378
- ### Fields
379
-
380
- | Name | Required | Type | Description |
381
- |---|---:|---|---|
382
- | `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
383
- | `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
384
- | `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
385
- | `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
386
-
387
- No additional properties.
388
-
389
- ## BoxPadding
390
-
391
- ### Fields
392
-
393
- | Name | Required | Type | Description |
394
- |---|---:|---|---|
395
- | `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
396
- | `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
397
- | `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
398
- | `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
399
-
400
- No additional properties.
401
-
402
- ## BoxRadiu
403
-
404
- ### Fields
405
-
406
- | Name | Required | Type | Description |
407
- |---|---:|---|---|
408
- | `bottomLeft` | no | [BoxRadius](./definitions.md#boxradius) | Bottom-left corner radius token |
409
- | `bottomRight` | no | [BoxRadius](./definitions.md#boxradius) | Bottom-right corner radius token |
410
- | `topLeft` | no | [BoxRadius](./definitions.md#boxradius) | Top-left corner radius token |
411
- | `topRight` | no | [BoxRadius](./definitions.md#boxradius) | Top-right corner radius token |
412
-
413
- No additional properties.
414
-
415
- ## BreadcrumbItem
416
-
417
- ### Fields
418
-
419
- | Name | Required | Type | Description |
420
- |---|---:|---|---|
421
- | `href` | no | string | URL to navigate to when clicked |
422
- | `isDisabled` | no | boolean | Disables the breadcrumb item |
423
- | `title` | yes | string | Display label for the breadcrumb item |
424
- | `value` | yes | string | Unique value identifier for the item |
425
-
426
- No additional properties.
427
-
428
- ## ButtonIcon
429
-
430
- ### Fields
431
-
432
- | Name | Required | Type | Description |
433
- |---|---:|---|---|
434
- | `alignment` | no | [ButtonIconAlignment](./definitions.md#buttoniconalignment) | Icon alignment relative to label. Default: LEFT |
435
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only supported for OUTLINE, SOLID, GHOST appearances |
436
- | `type` | yes | string | Icon type name (e.g., "CHECK", "EDIT_OUTLINE") |
437
-
438
- No additional properties.
439
-
440
- ## ButtonLabel
441
-
442
- Labels for the expand and collapse buttons
443
-
444
- ### Fields
445
-
446
- | Name | Required | Type | Description |
447
- |---|---:|---|---|
448
- | `collapse` | yes | string | Label for the collapse button. Default: Show less |
449
- | `expand` | yes | string | Label for the expand button. Default: Show more |
450
-
451
- No additional properties.
452
-
453
- ## ButtonTip
454
-
455
- ### Fields
456
-
457
- | Name | Required | Type | Description |
458
- |---|---:|---|---|
459
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
460
- | `content` | yes | string | Tooltip content text |
461
- | `isVisible` | no | boolean | Control tooltip visibility from parent |
462
- | `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
463
- | `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
464
- | `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to button. Default: TOP_START |
465
-
466
- No additional properties.
467
-
468
- ## ButtonTo
469
-
470
- ### Fields
471
-
472
- | Name | Required | Type | Description |
473
- |---|---:|---|---|
474
- | `openInNewTab` | no | boolean | Open link in new tab. Default: false |
475
- | `path` | yes | string | URL path for navigation |
476
-
477
- No additional properties.
478
-
479
- ## CardAction
480
-
481
- ### Fields
482
-
483
- | Name | Required | Type | Description |
484
- |---|---:|---|---|
485
- | `icon` | no | string | Icon name from Icon.TYPES (e.g. "EDIT", "DELETE") |
486
- | `id` | yes | string | Unique identifier for the action |
487
- | `label` | yes | string | Label text for the action |
488
-
489
- No additional properties.
490
-
491
- ## CardTo
492
-
493
- ### Fields
494
-
495
- | Name | Required | Type | Description |
496
- |---|---:|---|---|
497
- | `openInNewTab` | no | boolean | |
498
- | `path` | yes | string | |
499
-
500
- No additional properties.
501
-
502
- ## CheckboxArg
503
-
504
- ### Fields
505
-
506
- _No fields._
507
-
508
- Additional properties: unknown.
509
-
510
- ## CheckboxCheck
511
-
512
- ### Fields
513
-
514
- | Name | Required | Type | Description |
515
- |---|---:|---|---|
516
- | `args` | no | [CheckboxArg](./types.md#checkboxarg) | |
517
- | `message` | yes | string | |
518
- | `type` | yes | string | |
519
-
520
- No additional properties.
521
-
522
- ## CheckboxGroupArg
523
-
524
- ### Fields
525
-
526
- _No fields._
527
-
528
- Additional properties: unknown.
529
-
530
- ## CheckboxGroupCheck
531
-
532
- ### Fields
533
-
534
- | Name | Required | Type | Description |
535
- |---|---:|---|---|
536
- | `args` | no | [CheckboxGroupArg](./types.md#checkboxgrouparg) | |
537
- | `message` | yes | string | |
538
- | `type` | yes | string | |
539
-
540
- No additional properties.
541
-
542
- ## CheckboxGroupList
543
-
544
- ### Fields
545
-
546
- | Name | Required | Type | Description |
547
- |---|---:|---|---|
548
- | `isDisabled` | no | boolean | Disables this specific checkbox |
549
- | `label` | yes | string | Display text for the checkbox option |
550
- | `secondaryLabel` | no | string | Secondary text below the option label |
551
- | `tag` | no | string \| [CheckboxGroupTag](./types.md#checkboxgrouptag) | Optional tag/label displayed with the option |
552
- | `tip` | no | string \| [CheckboxGroupTip](./types.md#checkboxgrouptip) | Tooltip shown on hover. Can be simple string text or a TipTypes object |
553
- | `value` | yes | unknown | Value stored when option is selected |
554
-
555
- No additional properties.
556
-
557
- ## CheckboxGroupTag
558
-
559
- ### Fields
560
-
561
- | Name | Required | Type | Description |
562
- |---|---:|---|---|
563
- | `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
564
- | `label` | yes | string | Tag label text |
565
-
566
- No additional properties.
567
-
568
- ## CheckboxGroupTip
569
-
570
- ### Fields
571
-
572
- | Name | Required | Type | Description |
573
- |---|---:|---|---|
574
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style. Default: LIGHT |
575
- | `content` | yes | string | Tooltip text content |
576
- | `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls. Default: false |
577
- | `isDelayed` | no | boolean | Add delay before showing tooltip. Default: false |
578
- | `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
579
- | `isPositionFixed` | no | boolean | Use fixed positioning relative to viewport. Default: false |
580
- | `isVisible` | no | boolean | Control tooltip visibility from state |
581
- | `maxHeight` | no | number \| string | Maximum height for tooltip content |
582
- | `maxWidth` | no | number \| string | Maximum width for tooltip content |
583
- | `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows. Default: false |
584
- | `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows. Default: false |
585
- | `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware. Default: false |
586
- | `padding` | no | string | CSS padding value for tooltip content |
587
- | `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to the checkbox option |
588
- | `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis. Default: false |
589
- | `tipHideDelay` | no | number | Milliseconds to wait before hiding tooltip when delayed |
590
- | `tipShowDelay` | no | number | Milliseconds to wait before showing tooltip when delayed |
591
- | `title` | no | string | Tooltip title text |
592
- | `truncateClassName` | no | string | CSS class when onlyIfOverflow is enabled |
593
-
594
- No additional properties.
595
-
596
- ## CheckListOption
597
-
598
- Per-item input type overrides
599
-
600
- ### Fields
601
-
602
- | Name | Required | Type | Description |
603
- |---|---:|---|---|
604
- | `shouldHaveNegativeCheckbox` | no | boolean | Override negative checkbox for this item |
605
- | `type` | no | [CheckListType](./definitions.md#checklisttype) | Override input type for this item |
606
-
607
- No additional properties.
608
-
609
- ## ChipAvatar
610
-
611
- ### Fields
612
-
613
- | Name | Required | Type | Description |
614
- |---|---:|---|---|
615
- | `image` | no | string | Avatar image URL |
616
- | `imageProps` | no | [ImageProp](./types.md#imageprop) | |
617
- | `title` | no | string | Title for generating initials when no image |
618
-
619
- No additional properties.
620
-
621
- ## ChipIcon
622
-
623
- ### Fields
624
-
625
- | Name | Required | Type | Description |
626
- |---|---:|---|---|
627
- | `alignment` | no | [ChipIconAlignment](./definitions.md#chipiconalignment) | Icon position relative to text. Default: Left |
628
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
629
- | `type` | yes | string | Icon type name (e.g., "CHECK", "USERS_OUTLINE") |
630
-
631
- No additional properties.
632
-
633
- ## ChipTip
634
-
635
- Tooltip configuration. Chip has default overflow tooltip behavior
636
-
637
- ### Fields
638
-
639
- | Name | Required | Type | Description |
640
- |---|---:|---|---|
641
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance (LIGHT, DARK). Default: LIGHT |
642
- | `content` | yes | string | Tooltip content text |
643
- | `isVisible` | no | boolean | Control tooltip visibility from parent |
644
- | `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
645
- | `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
646
- | `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to chip. Default: TOP_START |
647
-
648
- No additional properties.
649
-
650
- ## ChipTo
651
-
652
- ### Fields
653
-
654
- | Name | Required | Type | Description |
655
- |---|---:|---|---|
656
- | `openInNewTab` | no | boolean | Open link in new tab |
657
- | `path` | yes | string | Navigation path or URL |
658
-
659
- No additional properties.
660
-
661
- ## ClickedFile
662
-
663
- Bindable clicked file metadata written before chipClick emits
664
-
665
- ### Fields
666
-
667
- | Name | Required | Type | Description |
668
- |---|---:|---|---|
669
- | `name` | no | string | File name |
670
- | `content` | no | string | File content as a base64 data URL |
671
- | `hasError` | no | boolean | Whether the file has an error |
672
- | `isMultipart` | no | boolean | Whether this is a multipart upload |
673
- | `previewUrl` | no | string | Preview URL for the file |
674
- | `progress` | no | number | Upload progress 0-100 |
675
- | `size` | no | number | File size in bytes |
676
- | `tooltipText` | no | string | Tooltip text shown on error |
677
- | `type` | no | string | MIME type of the file |
678
- | `url` | no | string | URL of the uploaded file |
679
-
680
- No additional properties.
681
-
682
- ## CodeDiffEditorOption
683
-
684
- JSON-safe Monaco diff behavior options.
685
-
686
- ### Fields
687
-
688
- | Name | Required | Type | Description |
689
- |---|---:|---|---|
690
- | `diffAlgorithm` | no | [CodeDiffEditorOptionDiffAlgorithm](./definitions.md#codediffeditoroptiondiffalgorithm) | |
691
- | `ignoreTrimWhitespace` | no | boolean | |
692
- | `renderSideBySide` | no | boolean | |
693
- | `useInlineViewWhenSpaceIsLimited` | no | boolean | |
694
-
695
- No additional properties.
696
-
697
- ## CodeEditorOption
698
-
699
- JSON-safe Monaco editing behavior options.
700
-
701
- ### Fields
702
-
703
- | Name | Required | Type | Description |
704
- |---|---:|---|---|
705
- | `detectIndentation` | no | boolean | |
706
- | `formatOnPaste` | no | boolean | |
707
- | `formatOnType` | no | boolean | |
708
- | `insertSpaces` | no | boolean | |
709
- | `tabSize` | no | number | |
710
-
711
- No additional properties.
712
-
713
- ## ColorPickerArg
714
-
715
- ### Fields
716
-
717
- _No fields._
718
-
719
- Additional properties: unknown.
720
-
721
- ## ColorPickerCheck
722
-
723
- ### Fields
724
-
725
- | Name | Required | Type | Description |
726
- |---|---:|---|---|
727
- | `args` | no | [ColorPickerArg](./types.md#colorpickerarg) | |
728
- | `message` | yes | string | |
729
- | `type` | yes | string | |
730
-
731
- No additional properties.
732
-
733
- ## Column
734
-
735
- ### Fields
736
-
737
- | Name | Required | Type | Description |
738
- |---|---:|---|---|
739
- | `align` | no | [HeadingAlign](./definitions.md#headingalign) | Text alignment for this column |
740
- | `header` | yes | string | Column header text |
741
- | `key` | yes | string | Key to look up cell value in each row object |
742
- | `width` | no | number \| string | Column width in px (number) or CSS string |
743
- | `wrapText` | no | boolean | Whether to wrap text in cells of this column. Default: false (nowrap) |
744
-
745
- No additional properties.
746
-
747
- ## ConfigContext
748
-
749
- Query context sent to dynamic config modifiers for backend-owned variants.
750
-
751
- ### Fields
752
-
753
- _No fields._
754
-
755
- Additional properties: string.
756
-
757
- ## ContextFilter
758
-
759
- ### Fields
760
-
761
- | Name | Required | Type | Description |
762
- |---|---:|---|---|
763
- | `field` | yes | string | |
764
- | `operation` | yes | [ContextFilterOperation](./definitions.md#contextfilteroperation) | |
765
- | `value` | yes | unknown | |
766
-
767
- No additional properties.
768
-
769
- ## CountryIcon
770
-
771
- ### Fields
772
-
773
- | Name | Required | Type | Description |
774
- |---|---:|---|---|
775
- | `alignment` | no | [CountryIconAlignment](./definitions.md#countryiconalignment) | Alignment of the icon within the container. Use "RIGHT" to push icon to the right. |
776
- | `aria-describedby` | no | string | ID of element that describes the icon |
777
- | `aria-label` | no | string | Accessible label for the icon |
778
- | `aria-labelledby` | no | string | ID of element that labels the icon |
779
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
780
- | `isDisabled` | no | boolean | Sets icon interactions as disabled |
781
- | `isFocused` | no | boolean | Shows icon backdrop when focused |
782
- | `showCursor` | no | boolean | Shows pointer cursor and hover background |
783
- | `size` | no | number \| string | Icon size in pixels or CSS units |
784
- | `tip` | no | string | Tooltip content shown on icon hover |
785
- | `type` | yes | string | Icon type name (e.g. "INFO_CIRCLE_OUTLINE") |
786
-
787
- No additional properties.
788
-
789
- ## CurrencyArg
790
-
791
- ### Fields
792
-
793
- _No fields._
794
-
795
- Additional properties: unknown.
796
-
797
- ## CurrencyCheck
798
-
799
- ### Fields
800
-
801
- | Name | Required | Type | Description |
802
- |---|---:|---|---|
803
- | `args` | no | [CurrencyArg](./types.md#currencyarg) | |
804
- | `message` | yes | string | |
805
- | `type` | yes | string | |
806
-
807
- No additional properties.
808
-
809
- ## CurrencyCurrencyTypeProp
810
-
811
- Nested Select props for the currency selector
812
-
813
- ### Fields
814
-
815
- | Name | Required | Type | Description |
816
- |---|---:|---|---|
817
- | `name` | no | string | Unique identifier for the currency selector |
818
- | `aria-describedby` | no | string | ID of element that describes the currency selector |
819
- | `aria-label` | no | string | Accessible label for the currency selector |
820
- | `aria-labelledby` | no | string | ID of element that labels the currency selector |
821
- | `canClear` | no | boolean | Show clear button to deselect |
822
- | `defaultSearchQuery` | no | string | Initial search input value |
823
- | `defaultValue` | no | unknown | Initial selected currency code |
824
- | `dropdownHeight` | no | number | Dropdown menu height in pixels |
825
- | `emptyListPlaceholder` | no | string \| [CurrencyEmptyListPlaceholder](./types.md#currencyemptylistplaceholder) | Placeholder when dropdown list is empty |
826
- | `fuseOptions` | no | [CurrencyFuseOption](./types.md#currencyfuseoption) | Fuse.js search options |
827
- | `isDisabled` | no | boolean | Disables the currency selector |
828
- | `isMenuDefaultOpen` | no | boolean | If true, dropdown menu opens by default |
829
- | `isPositionFixed` | no | boolean | Position dropdown relative to viewport |
830
- | `isReadOnly` | no | boolean | Makes the currency selector read-only |
831
- | `isRequired` | no | boolean | Marks the currency selector as required |
832
- | `isSearchable` | no | boolean | Enable type-to-search filtering |
833
- | `maxHeight` | no | string \| number | Dropdown max height |
834
- | `placeholder` | no | string | Placeholder text when empty |
835
- | `scrollThreshold` | no | number | Extra virtual scroll render threshold |
836
- | `shouldFocusFirstElement` | no | boolean | Auto-focus first menu item |
837
- | `shouldShowSearchIcon` | no | boolean | Show search icon prefix |
838
- | `shouldUsePortal` | no | boolean | Render dropdown in a React Portal |
839
- | `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Select input size variant. Default: M |
840
- | `value` | no | unknown | Currently selected currency code |
841
-
842
- No additional properties.
843
-
844
- ## CurrencyDefaultValue
845
-
846
- ### Fields
847
-
848
- | Name | Required | Type | Description |
849
- |---|---:|---|---|
850
- | `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
851
- | `value` | yes | string \| number | Currency amount value |
852
-
853
- No additional properties.
854
-
855
- ## CurrencyEmptyListPlaceholder
856
-
857
- ### Fields
858
-
859
- | Name | Required | Type | Description |
860
- |---|---:|---|---|
861
- | `onLoading` | no | string | Placeholder shown while list is loading |
862
- | `onNoSearchQuery` | no | string | Placeholder when no search query entered |
863
- | `onNoSearchResults` | no | string | Placeholder when search returns no results |
864
-
865
- No additional properties.
866
-
867
- ## CurrencyFuseOption
868
-
869
- Fuse.js search options
870
-
871
- ### Fields
872
-
873
- _No fields._
874
-
875
- Additional properties: unknown.
876
-
877
- ## CurrencyValue
878
-
879
- ### Fields
880
-
881
- | Name | Required | Type | Description |
882
- |---|---:|---|---|
883
- | `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
884
- | `value` | yes | string \| number | Currency amount value |
885
-
886
- No additional properties.
887
-
888
- ## DateArg
889
-
890
- ### Fields
891
-
892
- _No fields._
893
-
894
- Additional properties: unknown.
895
-
896
- ## DateCheck
897
-
898
- ### Fields
899
-
900
- | Name | Required | Type | Description |
901
- |---|---:|---|---|
902
- | `args` | no | [DateArg](./types.md#datearg) | |
903
- | `message` | yes | string | |
904
- | `type` | yes | string | |
905
-
906
- No additional properties.
907
-
908
- ## DateInlineMultiArg
909
-
910
- ### Fields
911
-
912
- _No fields._
913
-
914
- Additional properties: unknown.
915
-
916
- ## DateInlineMultiCheck
917
-
918
- ### Fields
919
-
920
- | Name | Required | Type | Description |
921
- |---|---:|---|---|
922
- | `args` | no | [DateInlineMultiArg](./types.md#dateinlinemultiarg) | |
923
- | `message` | yes | string | |
924
- | `type` | yes | string | |
925
-
926
- No additional properties.
927
-
928
- ## DateRangeArg
929
-
930
- ### Fields
931
-
932
- _No fields._
933
-
934
- Additional properties: unknown.
935
-
936
- ## DateRangeCheck
937
-
938
- ### Fields
939
-
940
- | Name | Required | Type | Description |
941
- |---|---:|---|---|
942
- | `args` | no | [DateRangeArg](./types.md#daterangearg) | |
943
- | `message` | yes | string | |
944
- | `type` | yes | string | |
945
-
946
- No additional properties.
947
-
948
- ## DaySelectorArg
949
-
950
- ### Fields
951
-
952
- _No fields._
953
-
954
- Additional properties: unknown.
955
-
956
- ## DaySelectorCheck
957
-
958
- ### Fields
959
-
960
- | Name | Required | Type | Description |
961
- |---|---:|---|---|
962
- | `args` | no | [DaySelectorArg](./types.md#dayselectorarg) | |
963
- | `message` | yes | string | |
964
- | `type` | yes | string | |
965
-
966
- No additional properties.
967
-
968
- ## DaySelectorRenderProp
969
-
970
- Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string)
971
-
972
- ### Fields
973
-
974
- _No fields._
975
-
976
- Additional properties: [DaySelectorRenderPropValue](./types.md#dayselectorrenderpropvalue).
977
-
978
- ## DaySelectorRenderPropValue
979
-
980
- ### Fields
981
-
982
- | Name | Required | Type | Description |
983
- |---|---:|---|---|
984
- | `isDisabled` | no | boolean | |
985
- | `tip` | no | [DaySelectorTip](./types.md#dayselectortip) | |
986
-
987
- No additional properties.
988
-
989
- ## DaySelectorTip
990
-
991
- ### Fields
992
-
993
- | Name | Required | Type | Description |
994
- |---|---:|---|---|
995
- | `content` | yes | string | |
996
-
997
- No additional properties.
998
-
999
- ## DebouncedActionParamsParam
1000
-
1001
- ### Fields
1002
-
1003
- _No fields._
1004
-
1005
- Additional properties: unknown.
1006
-
1007
- ## DisabledTip
1008
-
1009
- ### Fields
1010
-
1011
- | Name | Required | Type | Description |
1012
- |---|---:|---|---|
1013
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance |
1014
- | `content` | yes | string | Tooltip content text |
1015
- | `isVisible` | no | boolean | Control tooltip visibility from parent |
1016
- | `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
1017
- | `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
1018
- | `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement |
1019
-
1020
- No additional properties.
1021
-
1022
- ## DraggableListList
1023
-
1024
- ### Fields
1025
-
1026
- | Name | Required | Type | Description |
1027
- |---|---:|---|---|
1028
- | `id` | yes | string \| number | Unique identifier for the item |
1029
- | `label` | no | string | Display label for the item |
1030
-
1031
- Additional properties: unknown.
1032
-
1033
- ## DraggableListTip
1034
-
1035
- Tooltip configuration for the default chip renderer
1036
-
1037
- ### Fields
1038
-
1039
- | Name | Required | Type | Description |
1040
- |---|---:|---|---|
1041
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: DARK |
1042
- | `contentKey` | no | string | List item key used as tooltip content |
1043
- | `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls |
1044
- | `isDelayed` | no | boolean | Add delay before showing tooltip |
1045
- | `isMobileSupported` | no | boolean | Show tooltip on mobile devices |
1046
- | `isPositionFixed` | no | boolean | Use fixed positioning relative to viewport |
1047
- | `isVisible` | no | boolean | Control tooltip visibility |
1048
- | `maxHeight` | no | number \| string | Maximum tooltip height |
1049
- | `maxWidth` | no | number \| string | Maximum tooltip width |
1050
- | `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows |
1051
- | `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows |
1052
- | `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware |
1053
- | `padding` | no | string | CSS padding value for tooltip content |
1054
- | `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement |
1055
- | `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis |
1056
- | `tipHideDelay` | no | number | Milliseconds to wait before hiding delayed tooltip |
1057
- | `tipShowDelay` | no | number | Milliseconds to wait before showing delayed tooltip |
1058
- | `title` | no | string | Static tooltip title |
1059
- | `titleKey` | no | string | List item key used as tooltip title |
1060
- | `truncateClassName` | no | string | CSS class when overflow-only tooltip is enabled |
1061
-
1062
- No additional properties.
1063
-
1064
- ## DrawerItem
1065
-
1066
- ### Fields
1067
-
1068
- | Name | Required | Type | Description |
1069
- |---|---:|---|---|
1070
- | `href` | no | string | URL to navigate to when clicked |
1071
- | `isDisabled` | no | boolean | Disables the breadcrumb item |
1072
- | `title` | yes | string | Display label for the breadcrumb item |
1073
- | `value` | yes | string | Unique value identifier for the item |
1074
-
1075
- No additional properties.
1076
-
1077
- ## DrawerProp
1078
-
1079
- Breadcrumb props for the drawer title
1080
-
1081
- ### Fields
1082
-
1083
- | Name | Required | Type | Description |
1084
- |---|---:|---|---|
1085
- | `active` | no | string | Value of the active breadcrumb item |
1086
- | `aria-describedby` | no | string | ID of element that describes the breadcrumb nav |
1087
- | `aria-label` | no | string | Accessible label for the breadcrumb nav |
1088
- | `aria-labelledby` | no | string | ID of element that labels the breadcrumb nav |
1089
- | `items` | yes | [DrawerItem](./types.md#draweritem)[] | Breadcrumb items shown in the drawer header |
1090
- | `noMargin` | no | boolean | Remove default breadcrumb margin |
1091
- | `shouldCollapseMiddle` | no | boolean | Collapse middle breadcrumb items |
1092
-
1093
- No additional properties.
1094
-
1095
- ## DropdownDisabledInfo
1096
-
1097
- ### Fields
1098
-
1099
- | Name | Required | Type | Description |
1100
- |---|---:|---|---|
1101
- | `content` | yes | string | |
1102
-
1103
- No additional properties.
1104
-
1105
- ## DropdownFooter
1106
-
1107
- Footer item rendered at the bottom of the list
1108
-
1109
- ### Fields
1110
-
1111
- | Name | Required | Type | Description |
1112
- |---|---:|---|---|
1113
- | `disabledInfo` | no | string \| [DropdownDisabledInfo](./types.md#dropdowndisabledinfo) | Tooltip content shown when the option is disabled |
1114
- | `isDisabled` | no | boolean | Disables this option |
1115
- | `label` | no | string | Display text for the option |
1116
- | `labelIcon` | no | string | Icon name to show next to the label |
1117
- | `leftIconType` | no | string | Icon name to show on the left side of the item |
1118
- | `quaternaryLabel` | no | string | Quaternary text below the tertiary label |
1119
- | `secondaryLabel` | no | string | Secondary text below the main label |
1120
- | `tag` | no | string \| [DropdownTag](./types.md#dropdowntag) | Tag shown beside the option text |
1121
- | `tertiaryLabel` | no | string | Tertiary text below the secondary label |
1122
- | `type` | no | [DropdownFooterType](./definitions.md#dropdownfootertype) | Visual style type for the option (WARNING or ALERT) |
1123
- | `value` | no | unknown | Value for the option |
1124
-
1125
- Additional properties: unknown.
1126
-
1127
- ## DropdownList
1128
-
1129
- ### Fields
1130
-
1131
- | Name | Required | Type | Description |
1132
- |---|---:|---|---|
1133
- | `label` | yes | string | Display text for the dropdown item |
1134
- | `value` | yes | string | Value identifier for the dropdown item |
1135
-
1136
- No additional properties.
1137
-
1138
- ## DropdownList2
1139
-
1140
- ### Fields
1141
-
1142
- | Name | Required | Type | Description |
1143
- |---|---:|---|---|
1144
- | `disabledInfo` | no | string \| [DropdownDisabledInfo](./types.md#dropdowndisabledinfo) | Tooltip content shown when the option is disabled |
1145
- | `isDisabled` | no | boolean | Disables this option |
1146
- | `label` | no | string | Display text for the option |
1147
- | `labelIcon` | no | string | Icon name to show next to the label |
1148
- | `leftIconType` | no | string | Icon name to show on the left side of the item |
1149
- | `quaternaryLabel` | no | string | Quaternary text below the tertiary label |
1150
- | `secondaryLabel` | no | string | Secondary text below the main label |
1151
- | `tag` | no | string \| [DropdownTag](./types.md#dropdowntag) | Tag shown beside the option text |
1152
- | `tertiaryLabel` | no | string | Tertiary text below the secondary label |
1153
- | `type` | no | [DropdownFooterType](./definitions.md#dropdownfootertype) | Visual style type for the option (WARNING or ALERT) |
1154
- | `value` | no | unknown | Value for the option |
1155
-
1156
- Additional properties: unknown.
1157
-
1158
- ## DropdownListVariant2
1159
-
1160
- ### Fields
1161
-
1162
- | Name | Required | Type | Description |
1163
- |---|---:|---|---|
1164
- | `isDisabled` | no | boolean | Disables this option |
1165
- | `isNestedMenu` | no | boolean | Marks this item as a nested menu |
1166
- | `label` | yes | string | Display text for the nested menu item |
1167
- | `labelIcon` | no | string | Icon name to show next to the label |
1168
- | `leftIconType` | no | string | Icon name to show on the left side of the item |
1169
- | `list` | yes | [DropdownList2](./types.md#dropdownlist2)[] | Nested flat list items |
1170
- | `tag` | no | string \| [DropdownTag](./types.md#dropdowntag) | Tag shown beside the option text |
1171
- | `value` | no | unknown | Value for the nested option |
1172
-
1173
- Additional properties: unknown.
1174
-
1175
- ## DropdownTag
1176
-
1177
- ### Fields
1178
-
1179
- | Name | Required | Type | Description |
1180
- |---|---:|---|---|
1181
- | `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance |
1182
- | `text` | yes | string | Tag text |
1183
-
1184
- No additional properties.
1185
-
1186
- ## EditButton
1187
-
1188
- ### Fields
1189
-
1190
- | Name | Required | Type | Description |
1191
- |---|---:|---|---|
1192
- | `disabledTip` | no | string \| [DisabledTip](./types.md#disabledtip) | Tooltip shown when the settings edit button is disabled |
1193
- | `isDisabled` | no | boolean | Disable the settings edit button |
1194
- | `show` | no | boolean | Show or hide the settings edit button. Default: true |
1195
-
1196
- No additional properties.
1197
-
1198
- ## EmailArg
1199
-
1200
- ### Fields
1201
-
1202
- _No fields._
1203
-
1204
- Additional properties: unknown.
1205
-
1206
- ## EmailCheck
1207
-
1208
- ### Fields
1209
-
1210
- | Name | Required | Type | Description |
1211
- |---|---:|---|---|
1212
- | `args` | no | [EmailArg](./types.md#emailarg) | |
1213
- | `message` | yes | string | |
1214
- | `type` | yes | string | |
1215
-
1216
- No additional properties.
1217
-
1218
- ## EmailStringPadding
1219
-
1220
- Pads input value with character until reaching maxLength
1221
-
1222
- ### Fields
1223
-
1224
- | Name | Required | Type | Description |
1225
- |---|---:|---|---|
1226
- | `character` | yes | string | Character to use for padding |
1227
- | `maxLength` | yes | number | Target length after padding |
1228
- | `position` | yes | [PanePin](./definitions.md#panepin) | Where to add padding: start or end |
1229
-
1230
- No additional properties.
1231
-
1232
- ## ExpansionPanelToggleIcon
1233
-
1234
- Toggle icon layout options
1235
-
1236
- ### Fields
1237
-
1238
- | Name | Required | Type | Description |
1239
- |---|---:|---|---|
1240
- | `align` | no | string | CSS align-self value for the toggle icon |
1241
- | `margin` | no | string | CSS margin around the toggle icon container |
1242
- | `size` | no | number \| string | Toggle icon size. Default: 24px |
1243
-
1244
- No additional properties.
1245
-
1246
- ## FileAllowCameraCapture
1247
-
1248
- ### Fields
1249
-
1250
- | Name | Required | Type | Description |
1251
- |---|---:|---|---|
1252
- | `quality` | no | number | Captured image quality |
1253
-
1254
- No additional properties.
1255
-
1256
- ## FileCropperConfig
1257
-
1258
- Image cropper configuration
1259
-
1260
- ### Fields
1261
-
1262
- | Name | Required | Type | Description |
1263
- |---|---:|---|---|
1264
- | `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper |
1265
- | `enforceAspectRatio` | no | boolean | Enforce cropper aspect ratio |
1266
- | `showUploadButton` | no | boolean | Show upload button on cropper |
1267
- | `title` | no | string | Title for the cropper modal |
1268
-
1269
- No additional properties.
1270
-
1271
- ## FileDefaultValue
1272
-
1273
- ### Fields
1274
-
1275
- | Name | Required | Type | Description |
1276
- |---|---:|---|---|
1277
- | `name` | no | string | File name |
1278
- | `content` | no | string | File content as a base64 data URL |
1279
- | `hasError` | no | boolean | Whether the file has an error |
1280
- | `isMultipart` | no | boolean | Whether this is a multipart upload |
1281
- | `previewUrl` | no | string | Preview URL for the file |
1282
- | `progress` | no | number | Upload progress 0-100 |
1283
- | `size` | no | number | File size in bytes |
1284
- | `tooltipText` | no | string | Tooltip text shown on error |
1285
- | `type` | no | string | MIME type of the file |
1286
- | `url` | no | string | URL of the uploaded file |
1287
-
1288
- No additional properties.
1289
-
1290
- ## FileDropAllowCameraCapture
1291
-
1292
- ### Fields
1293
-
1294
- | Name | Required | Type | Description |
1295
- |---|---:|---|---|
1296
- | `quality` | no | number | Captured image quality |
1297
-
1298
- No additional properties.
1299
-
1300
- ## FileDropArg
1301
-
1302
- ### Fields
1303
-
1304
- _No fields._
1305
-
1306
- Additional properties: unknown.
1307
-
1308
- ## FileDropCheck
1309
-
1310
- ### Fields
1311
-
1312
- | Name | Required | Type | Description |
1313
- |---|---:|---|---|
1314
- | `args` | no | [FileDropArg](./types.md#filedroparg) | |
1315
- | `message` | yes | string | |
1316
- | `type` | yes | string | |
1317
-
1318
- No additional properties.
1319
-
1320
- ## FileDropCropperConfig
1321
-
1322
- Cropper configuration
1323
-
1324
- ### Fields
1325
-
1326
- | Name | Required | Type | Description |
1327
- |---|---:|---|---|
1328
- | `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
1329
- | `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
1330
- | `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
1331
- | `title` | no | string | Title for the cropper modal |
1332
-
1333
- No additional properties.
1334
-
1335
- ## FileDropDefaultValue
1336
-
1337
- ### Fields
1338
-
1339
- | Name | Required | Type | Description |
1340
- |---|---:|---|---|
1341
- | `name` | no | string | File name |
1342
- | `content` | no | string | File content as a base64 data URL |
1343
- | `hasError` | no | boolean | Whether the file has an error |
1344
- | `previewUrl` | no | string | Preview URL for the file |
1345
- | `progress` | no | number | Upload progress 0-100 |
1346
- | `tooltipText` | no | string | Tooltip text shown on error |
1347
- | `type` | no | string | MIME type of the file |
1348
- | `url` | no | string | URL of the uploaded file |
1349
-
1350
- No additional properties.
1351
-
1352
- ## FileDropValue
1353
-
1354
- ### Fields
1355
-
1356
- | Name | Required | Type | Description |
1357
- |---|---:|---|---|
1358
- | `name` | no | string | File name |
1359
- | `content` | no | string | File content as a base64 data URL |
1360
- | `hasError` | no | boolean | Whether the file has an error |
1361
- | `previewUrl` | no | string | Preview URL for the file |
1362
- | `progress` | no | number | Upload progress 0-100 |
1363
- | `tooltipText` | no | string | Tooltip text shown on error |
1364
- | `type` | no | string | MIME type of the file |
1365
- | `url` | no | string | URL of the uploaded file |
1366
-
1367
- No additional properties.
1368
-
1369
- ## FileValue
1370
-
1371
- ### Fields
1372
-
1373
- | Name | Required | Type | Description |
1374
- |---|---:|---|---|
1375
- | `name` | no | string | File name |
1376
- | `content` | no | string | File content as a base64 data URL |
1377
- | `hasError` | no | boolean | Whether the file has an error |
1378
- | `isMultipart` | no | boolean | Whether this is a multipart upload |
1379
- | `previewUrl` | no | string | Preview URL for the file |
1380
- | `progress` | no | number | Upload progress 0-100 |
1381
- | `size` | no | number | File size in bytes |
1382
- | `tooltipText` | no | string | Tooltip text shown on error |
1383
- | `type` | no | string | MIME type of the file |
1384
- | `url` | no | string | URL of the uploaded file |
1385
-
1386
- No additional properties.
1387
-
1388
- ## FloatingButtonIcon
1389
-
1390
- ### Fields
1391
-
1392
- | Name | Required | Type | Description |
1393
- |---|---:|---|---|
1394
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
1395
- | `type` | yes | string | Icon type from Icon.TYPES |
1396
-
1397
- No additional properties.
1398
-
1399
- ## FloatingButtonTip
1400
-
1401
- ### Fields
1402
-
1403
- | Name | Required | Type | Description |
1404
- |---|---:|---|---|
1405
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
1406
- | `content` | yes | string | Tooltip content text |
1407
- | `isVisible` | no | boolean | Control tooltip visibility from parent |
1408
- | `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
1409
- | `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
1410
- | `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to button. Default: TOP_START |
1411
-
1412
- No additional properties.
1413
-
1414
- ## FloatingButtonTo
1415
-
1416
- ### Fields
1417
-
1418
- | Name | Required | Type | Description |
1419
- |---|---:|---|---|
1420
- | `openInNewTab` | no | boolean | Open link in new tab. Default: false |
1421
- | `path` | yes | string | URL path for navigation |
1422
-
1423
- No additional properties.
1424
-
1425
- ## FormCheckboxGroupList
1426
-
1427
- ### Fields
1428
-
1429
- | Name | Required | Type | Description |
1430
- |---|---:|---|---|
1431
- | `isDisabled` | no | boolean | Disables this specific checkbox |
1432
- | `label` | yes | string | Display text for the checkbox option |
1433
- | `secondaryLabel` | no | string | Secondary text below the option label |
1434
- | `tag` | no | string \| [FormCheckboxGroupTag](./types.md#formcheckboxgrouptag) | Optional tag/label displayed with the option |
1435
- | `tip` | no | string \| [FormCheckboxGroupTip](./types.md#formcheckboxgrouptip) | Tooltip shown on hover. Can be simple string text or a TipTypes object |
1436
- | `value` | yes | unknown | Value stored when option is selected |
1437
-
1438
- No additional properties.
1439
-
1440
- ## FormCheckboxGroupTag
1441
-
1442
- ### Fields
1443
-
1444
- | Name | Required | Type | Description |
1445
- |---|---:|---|---|
1446
- | `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
1447
- | `label` | yes | string | Tag label text |
1448
-
1449
- No additional properties.
1450
-
1451
- ## FormCheckboxGroupTip
1452
-
1453
- ### Fields
1454
-
1455
- | Name | Required | Type | Description |
1456
- |---|---:|---|---|
1457
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style. Default: LIGHT |
1458
- | `content` | yes | string | Tooltip text content |
1459
- | `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls. Default: false |
1460
- | `isDelayed` | no | boolean | Add delay before showing tooltip. Default: false |
1461
- | `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
1462
- | `isPositionFixed` | no | boolean | Use fixed positioning relative to viewport. Default: false |
1463
- | `isVisible` | no | boolean | Control tooltip visibility from state |
1464
- | `maxHeight` | no | number \| string | Maximum height for tooltip content |
1465
- | `maxWidth` | no | number \| string | Maximum width for tooltip content |
1466
- | `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows. Default: false |
1467
- | `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows. Default: false |
1468
- | `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware. Default: false |
1469
- | `padding` | no | string | CSS padding value for tooltip content |
1470
- | `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to the checkbox option |
1471
- | `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis. Default: false |
1472
- | `tipHideDelay` | no | number | Milliseconds to wait before hiding tooltip when delayed |
1473
- | `tipShowDelay` | no | number | Milliseconds to wait before showing tooltip when delayed |
1474
- | `title` | no | string | Tooltip title text |
1475
- | `truncateClassName` | no | string | CSS class when onlyIfOverflow is enabled |
1476
-
1477
- No additional properties.
1478
-
1479
- ## FormCheckboxGroupValidationError
1480
-
1481
- Map of rule name to error message
1482
-
1483
- ### Fields
1484
-
1485
- _No fields._
1486
-
1487
- Additional properties: string.
1488
-
1489
- ## FormCheckboxValidationError
1490
-
1491
- Map of rule name to error message
1492
-
1493
- ### Fields
1494
-
1495
- _No fields._
1496
-
1497
- Additional properties: string.
1498
-
1499
- ## FormCurrencyCurrencyTypeProp
1500
-
1501
- Nested Select props for the currency selector
1502
-
1503
- ### Fields
1504
-
1505
- | Name | Required | Type | Description |
1506
- |---|---:|---|---|
1507
- | `name` | no | string | Unique identifier for the currency selector |
1508
- | `aria-describedby` | no | string | ID of element that describes the currency selector |
1509
- | `aria-label` | no | string | Accessible label for the currency selector |
1510
- | `aria-labelledby` | no | string | ID of element that labels the currency selector |
1511
- | `canClear` | no | boolean | Show clear button to deselect |
1512
- | `defaultSearchQuery` | no | string | Initial search input value |
1513
- | `defaultValue` | no | unknown | Initial selected currency code |
1514
- | `dropdownHeight` | no | number | Dropdown menu height in pixels |
1515
- | `emptyListPlaceholder` | no | string \| [FormCurrencyEmptyListPlaceholder](./types.md#formcurrencyemptylistplaceholder) | Placeholder when dropdown list is empty |
1516
- | `fuseOptions` | no | [FormCurrencyFuseOption](./types.md#formcurrencyfuseoption) | Fuse.js search options |
1517
- | `isDisabled` | no | boolean | Disables the currency selector |
1518
- | `isMenuDefaultOpen` | no | boolean | If true, dropdown menu opens by default |
1519
- | `isPositionFixed` | no | boolean | Position dropdown relative to viewport |
1520
- | `isReadOnly` | no | boolean | Makes the currency selector read-only |
1521
- | `isRequired` | no | boolean | Marks the currency selector as required |
1522
- | `isSearchable` | no | boolean | Enable type-to-search filtering |
1523
- | `maxHeight` | no | string \| number | Dropdown max height |
1524
- | `placeholder` | no | string | Placeholder text when empty |
1525
- | `scrollThreshold` | no | number | Extra virtual scroll render threshold |
1526
- | `shouldFocusFirstElement` | no | boolean | Auto-focus first menu item |
1527
- | `shouldShowSearchIcon` | no | boolean | Show search icon prefix |
1528
- | `shouldUsePortal` | no | boolean | Render dropdown in a React Portal |
1529
- | `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Select input size variant. Default: M |
1530
- | `value` | no | unknown | Currently selected currency code |
1531
-
1532
- No additional properties.
1533
-
1534
- ## FormCurrencyDefaultValue
1535
-
1536
- ### Fields
1537
-
1538
- | Name | Required | Type | Description |
1539
- |---|---:|---|---|
1540
- | `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
1541
- | `value` | yes | string \| number | Currency amount value |
1542
-
1543
- No additional properties.
1544
-
1545
- ## FormCurrencyEmptyListPlaceholder
1546
-
1547
- ### Fields
1548
-
1549
- | Name | Required | Type | Description |
1550
- |---|---:|---|---|
1551
- | `onLoading` | no | string | Placeholder shown while list is loading |
1552
- | `onNoSearchQuery` | no | string | Placeholder when no search query entered |
1553
- | `onNoSearchResults` | no | string | Placeholder when search returns no results |
1554
-
1555
- No additional properties.
1556
-
1557
- ## FormCurrencyFuseOption
1558
-
1559
- Fuse.js search options
1560
-
1561
- ### Fields
1562
-
1563
- _No fields._
1564
-
1565
- Additional properties: unknown.
1566
-
1567
- ## FormCurrencyValidationError
1568
-
1569
- Map of rule name to error message
1570
-
1571
- ### Fields
1572
-
1573
- _No fields._
1574
-
1575
- Additional properties: string.
1576
-
1577
- ## FormCurrencyValue
1578
-
1579
- ### Fields
1580
-
1581
- | Name | Required | Type | Description |
1582
- |---|---:|---|---|
1583
- | `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
1584
- | `value` | yes | string \| number | Currency amount value |
1585
-
1586
- No additional properties.
1587
-
1588
- ## FormDateRangeValidationError
1589
-
1590
- Map of rule name to error message
1591
-
1592
- ### Fields
1593
-
1594
- _No fields._
1595
-
1596
- Additional properties: string.
1597
-
1598
- ## FormDateValidationError
1599
-
1600
- Map of rule name to error message
1601
-
1602
- ### Fields
1603
-
1604
- _No fields._
1605
-
1606
- Additional properties: string.
1607
-
1608
- ## FormDaySelectorRenderProp
1609
-
1610
- Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string)
1611
-
1612
- ### Fields
1613
-
1614
- _No fields._
1615
-
1616
- Additional properties: [FormDaySelectorRenderPropValue](./types.md#formdayselectorrenderpropvalue).
1617
-
1618
- ## FormDaySelectorRenderPropValue
1619
-
1620
- ### Fields
1621
-
1622
- | Name | Required | Type | Description |
1623
- |---|---:|---|---|
1624
- | `isDisabled` | no | boolean | |
1625
- | `tip` | no | [FormDaySelectorTip](./types.md#formdayselectortip) | |
1626
-
1627
- No additional properties.
1628
-
1629
- ## FormDaySelectorTip
1630
-
1631
- ### Fields
1632
-
1633
- | Name | Required | Type | Description |
1634
- |---|---:|---|---|
1635
- | `content` | yes | string | |
1636
-
1637
- No additional properties.
1638
-
1639
- ## FormDaySelectorValidationError
1640
-
1641
- Map of rule name to error message
1642
-
1643
- ### Fields
1644
-
1645
- _No fields._
1646
-
1647
- Additional properties: string.
1648
-
1649
- ## FormEmailStringPadding
1650
-
1651
- Pads input value with character until reaching maxLength
1652
-
1653
- ### Fields
1654
-
1655
- | Name | Required | Type | Description |
1656
- |---|---:|---|---|
1657
- | `character` | yes | string | Character to use for padding |
1658
- | `maxLength` | yes | number | Target length after padding |
1659
- | `position` | yes | [PanePin](./definitions.md#panepin) | Where to add padding: start or end |
1660
-
1661
- No additional properties.
1662
-
1663
- ## FormEmailValidationError
1664
-
1665
- Map of rule name to error message
1666
-
1667
- ### Fields
1668
-
1669
- _No fields._
1670
-
1671
- Additional properties: string.
1672
-
1673
- ## FormFileAllowCameraCapture
1674
-
1675
- ### Fields
1676
-
1677
- | Name | Required | Type | Description |
1678
- |---|---:|---|---|
1679
- | `quality` | no | number | Captured image quality |
1680
-
1681
- No additional properties.
1682
-
1683
- ## FormFileCropperConfig
1684
-
1685
- Cropper configuration
1686
-
1687
- ### Fields
1688
-
1689
- | Name | Required | Type | Description |
1690
- |---|---:|---|---|
1691
- | `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
1692
- | `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
1693
- | `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
1694
- | `title` | no | string | Title for the cropper modal |
1695
-
1696
- No additional properties.
1697
-
1698
- ## FormFileDefaultValue
1699
-
1700
- ### Fields
1701
-
1702
- | Name | Required | Type | Description |
1703
- |---|---:|---|---|
1704
- | `name` | no | string | File name |
1705
- | `content` | no | string | File content as a base64 data URL |
1706
- | `hasError` | no | boolean | Whether the file has an error |
1707
- | `isMultipart` | no | boolean | Whether this is a multipart upload |
1708
- | `previewUrl` | no | string | Preview URL for the file |
1709
- | `progress` | no | number | Upload progress 0-100 |
1710
- | `size` | no | number | File size in bytes |
1711
- | `tooltipText` | no | string | Tooltip text shown on error |
1712
- | `type` | no | string | MIME type of the file |
1713
- | `url` | no | string | URL of the uploaded file |
1714
-
1715
- No additional properties.
1716
-
1717
- ## FormFileDropAllowCameraCapture
1718
-
1719
- ### Fields
1720
-
1721
- | Name | Required | Type | Description |
1722
- |---|---:|---|---|
1723
- | `quality` | no | number | Captured image quality |
1724
-
1725
- No additional properties.
1726
-
1727
- ## FormFileDropCropperConfig
1728
-
1729
- Cropper configuration
1730
-
1731
- ### Fields
1732
-
1733
- | Name | Required | Type | Description |
1734
- |---|---:|---|---|
1735
- | `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
1736
- | `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
1737
- | `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
1738
- | `title` | no | string | Title for the cropper modal |
1739
-
1740
- No additional properties.
1741
-
1742
- ## FormFileDropDefaultValue
1743
-
1744
- ### Fields
1745
-
1746
- | Name | Required | Type | Description |
1747
- |---|---:|---|---|
1748
- | `name` | no | string | File name |
1749
- | `content` | no | string | File content as a base64 data URL |
1750
- | `hasError` | no | boolean | Whether the file has an error |
1751
- | `previewUrl` | no | string | Preview URL for the file |
1752
- | `progress` | no | number | Upload progress 0-100 |
1753
- | `tooltipText` | no | string | Tooltip text shown on error |
1754
- | `type` | no | string | MIME type of the file |
1755
- | `url` | no | string | URL of the uploaded file |
1756
-
1757
- No additional properties.
1758
-
1759
- ## FormFileDropValidationError
1760
-
1761
- Map of rule name to error message
1762
-
1763
- ### Fields
1764
-
1765
- _No fields._
1766
-
1767
- Additional properties: string.
1768
-
1769
- ## FormFileDropValue
1770
-
1771
- ### Fields
1772
-
1773
- | Name | Required | Type | Description |
1774
- |---|---:|---|---|
1775
- | `name` | no | string | File name |
1776
- | `content` | no | string | File content as a base64 data URL |
1777
- | `hasError` | no | boolean | Whether the file has an error |
1778
- | `previewUrl` | no | string | Preview URL for the file |
1779
- | `progress` | no | number | Upload progress 0-100 |
1780
- | `tooltipText` | no | string | Tooltip text shown on error |
1781
- | `type` | no | string | MIME type of the file |
1782
- | `url` | no | string | URL of the uploaded file |
1783
-
1784
- No additional properties.
1785
-
1786
- ## FormFileValidationError
1787
-
1788
- Map of rule name to error message
1789
-
1790
- ### Fields
1791
-
1792
- _No fields._
1793
-
1794
- Additional properties: string.
1795
-
1796
- ## FormFileValue
1797
-
1798
- ### Fields
1799
-
1800
- | Name | Required | Type | Description |
1801
- |---|---:|---|---|
1802
- | `name` | no | string | File name |
1803
- | `content` | no | string | File content as a base64 data URL |
1804
- | `hasError` | no | boolean | Whether the file has an error |
1805
- | `isMultipart` | no | boolean | Whether this is a multipart upload |
1806
- | `previewUrl` | no | string | Preview URL for the file |
1807
- | `progress` | no | number | Upload progress 0-100 |
1808
- | `size` | no | number | File size in bytes |
1809
- | `tooltipText` | no | string | Tooltip text shown on error |
1810
- | `type` | no | string | MIME type of the file |
1811
- | `url` | no | string | URL of the uploaded file |
1812
-
1813
- No additional properties.
1814
-
1815
- ## FormIcon
1816
-
1817
- ### Fields
1818
-
1819
- | Name | Required | Type | Description |
1820
- |---|---:|---|---|
1821
- | `alignment` | no | [ButtonIconAlignment](./definitions.md#buttoniconalignment) | Icon alignment relative to button label. Default: LEFT |
1822
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
1823
- | `type` | yes | string | Icon type name from Icon.TYPES |
1824
-
1825
- No additional properties.
1826
-
1827
- ## FormInputGroupInput
1828
-
1829
- Main input configuration with type and inputProps
1830
-
1831
- ### Fields
1832
-
1833
- | Name | Required | Type | Description |
1834
- |---|---:|---|---|
1835
- | `inputProps` | yes | [FormInputGroupInputProp](./types.md#forminputgroupinputprop) | Props to pass to the input component |
1836
- | `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
1837
-
1838
- No additional properties.
1839
-
1840
- ## FormInputGroupInputProp
1841
-
1842
- Props to pass to the input component
1843
-
1844
- ### Fields
1845
-
1846
- _No fields._
1847
-
1848
- Additional properties: unknown.
1849
-
1850
- ## FormInputGroupPrefix
1851
-
1852
- ### Fields
1853
-
1854
- | Name | Required | Type | Description |
1855
- |---|---:|---|---|
1856
- | `inputProps` | yes | [FormInputGroupInputProp](./types.md#forminputgroupinputprop) | Props to pass to the input component |
1857
- | `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
1858
-
1859
- No additional properties.
1860
-
1861
- ## FormInputGroupSuffix
1862
-
1863
- ### Fields
1864
-
1865
- | Name | Required | Type | Description |
1866
- |---|---:|---|---|
1867
- | `inputProps` | yes | [FormInputGroupInputProp](./types.md#forminputgroupinputprop) | Props to pass to the input component |
1868
- | `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
1869
-
1870
- No additional properties.
1871
-
1872
- ## FormInputGroupValidationError
1873
-
1874
- Map of rule name to error message
1875
-
1876
- ### Fields
1877
-
1878
- _No fields._
1879
-
1880
- Additional properties: string.
1881
-
1882
- ## FormMaskerValidationError
1883
-
1884
- Map of rule name to error message
1885
-
1886
- ### Fields
1887
-
1888
- _No fields._
1889
-
1890
- Additional properties: string.
1891
-
1892
- ## FormNumberStringPadding
1893
-
1894
- Adds padding characters to the input value
1895
-
1896
- ### Fields
1897
-
1898
- | Name | Required | Type | Description |
1899
- |---|---:|---|---|
1900
- | `character` | yes | string | Character to use for padding |
1901
- | `maxLength` | yes | number | Target length after padding |
1902
- | `position` | yes | [PanePin](./definitions.md#panepin) | Position to pad (start or end) |
1903
-
1904
- No additional properties.
1905
-
1906
- ## FormNumberValidationError
1907
-
1908
- Map of rule name to error message
1909
-
1910
- ### Fields
1911
-
1912
- _No fields._
1913
-
1914
- Additional properties: string.
1915
-
1916
- ## FormPasswordStringPadding
1917
-
1918
- Pads input value with character until reaching maxLength
1919
-
1920
- ### Fields
1921
-
1922
- | Name | Required | Type | Description |
1923
- |---|---:|---|---|
1924
- | `character` | yes | string | Character to use for padding |
1925
- | `maxLength` | yes | number | Target length after padding |
1926
- | `position` | yes | [PanePin](./definitions.md#panepin) | Where to add padding: start or end |
1927
-
1928
- No additional properties.
1929
-
1930
- ## FormPasswordValidationError
1931
-
1932
- Map of rule name to error message
1933
-
1934
- ### Fields
1935
-
1936
- _No fields._
1937
-
1938
- Additional properties: string.
1939
-
1940
- ## FormPercentageValidationError
1941
-
1942
- Map of rule name to error message
1943
-
1944
- ### Fields
1945
-
1946
- _No fields._
1947
-
1948
- Additional properties: string.
1949
-
1950
- ## FormPhoneCountryCode
1951
-
1952
- Country-code dropdown configuration preserving the serializable CountryCodeProp shape
1953
-
1954
- ### Fields
1955
-
1956
- | Name | Required | Type | Description |
1957
- |---|---:|---|---|
1958
- | `name` | no | string | Name for the country-code select input |
1959
- | `aria-describedby` | no | string | ID of the element that describes the country-code dropdown |
1960
- | `aria-label` | no | string | Accessible label for the country-code dropdown |
1961
- | `aria-labelledby` | no | string | ID of the element that labels the country-code dropdown |
1962
- | `canClear` | no | boolean | Show clear button in the country-code dropdown |
1963
- | `defaultSearchQuery` | no | string | Initial search query for the country-code dropdown |
1964
- | `defaultValue` | no | string | Initial selected country code for the dropdown branch |
1965
- | `dropdownHeight` | no | number | Country-code dropdown menu height in pixels |
1966
- | `emptyListPlaceholder` | no | string \| [FormPhoneEmptyListPlaceholder](./types.md#formphoneemptylistplaceholder) | Placeholder shown when the country-code dropdown list is empty |
1967
- | `fuseOptions` | no | [FormPhoneFuseOption](./types.md#formphonefuseoption) | Fuse.js search options for the country-code dropdown |
1968
- | `id` | no | string | HTML id attribute for the country-code select input |
1969
- | `isDisabled` | no | boolean | Disables the country-code dropdown |
1970
- | `isMenuDefaultOpen` | no | boolean | If true, the country-code dropdown opens by default |
1971
- | `isPositionFixed` | no | boolean | Position the country-code dropdown relative to the viewport |
1972
- | `isReadOnly` | no | boolean | Makes the country-code dropdown read-only |
1973
- | `isRequired` | no | boolean | Marks the country-code dropdown as required |
1974
- | `maxHeight` | no | string \| number | Maximum dropdown height or chip container height as a CSS value |
1975
- | `placement` | no | [AppGroupSelectPlacement](./definitions.md#appgroupselectplacement) | Country-code dropdown placement. Default: bottom-start |
1976
- | `rows` | no | number | Minimum row count for the country-code dropdown |
1977
- | `scrollThreshold` | no | number | Extra pixels rendered above and below the viewport in paginated mode |
1978
- | `shouldFocusFirstElement` | no | boolean | Auto-focus the first dropdown item when the menu opens |
1979
- | `shouldShowSearchIcon` | no | boolean | Show the search icon inside the country-code dropdown |
1980
- | `shouldUsePortal` | no | boolean | Render the country-code dropdown in a React portal |
1981
- | `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Country-code dropdown size. Default: M |
1982
- | `theme` | no | [FormTimezoneTheme](./definitions.md#formtimezonetheme) | Country-code dropdown theme variant |
1983
- | `value` | no | string | Controlled selected country code for the dropdown branch |
1984
-
1985
- No additional properties.
1986
-
1987
- ## FormPhoneEmptyListPlaceholder
1988
-
1989
- ### Fields
1990
-
1991
- | Name | Required | Type | Description |
1992
- |---|---:|---|---|
1993
- | `onLoading` | no | string | Placeholder shown while the dropdown list is loading |
1994
- | `onNoSearchQuery` | no | string | Placeholder when no search query is entered |
1995
- | `onNoSearchResults` | no | string | Placeholder shown when no matching regions are found |
1996
-
1997
- No additional properties.
1998
-
1999
- ## FormPhoneFuseOption
2000
-
2001
- Fuse.js search options for the country-code dropdown
2002
-
2003
- ### Fields
2004
-
2005
- _No fields._
2006
-
2007
- Additional properties: unknown.
2008
-
2009
- ## FormPhoneStringPadding
2010
-
2011
- Pads input value with character until reaching maxLength
2012
-
2013
- ### Fields
2014
-
2015
- | Name | Required | Type | Description |
2016
- |---|---:|---|---|
2017
- | `character` | yes | string | Character to use for padding |
2018
- | `maxLength` | yes | number | Target length after padding |
2019
- | `position` | yes | [PanePin](./definitions.md#panepin) | Where to add padding: start or end |
2020
-
2021
- No additional properties.
2022
-
2023
- ## FormPhoneValidationError
2024
-
2025
- Map of rule name to error message
2026
-
2027
- ### Fields
2028
-
2029
- _No fields._
2030
-
2031
- Additional properties: string.
2032
-
2033
- ## FormRadioList
2034
-
2035
- ### Fields
2036
-
2037
- | Name | Required | Type | Description |
2038
- |---|---:|---|---|
2039
- | `isActive` | no | boolean | Controls focus state of the option |
2040
- | `isDisabled` | no | boolean | Disables this specific option |
2041
- | `label` | yes | string | Display text for the option |
2042
- | `secondaryLabel` | no | string | Secondary text below the option label |
2043
- | `tag` | no | string \| [FormRadioTag](./types.md#formradiotag) | Optional tag/label displayed with the option |
2044
- | `tip` | no | string | Tooltip text shown on hover |
2045
- | `value` | yes | unknown | Value stored when option is selected |
2046
-
2047
- No additional properties.
2048
-
2049
- ## FormRadioTag
2050
-
2051
- ### Fields
2052
-
2053
- | Name | Required | Type | Description |
2054
- |---|---:|---|---|
2055
- | `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
2056
- | `label` | yes | string | Tag label text |
2057
-
2058
- No additional properties.
2059
-
2060
- ## FormRadioValidationError
2061
-
2062
- Map of rule name to error message
2063
-
2064
- ### Fields
2065
-
2066
- _No fields._
2067
-
2068
- Additional properties: string.
2069
-
2070
- ## FormSegmentedControlList
2071
-
2072
- ### Fields
2073
-
2074
- | Name | Required | Type | Description |
2075
- |---|---:|---|---|
2076
- | `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style for this specific option |
2077
- | `aria-label` | no | string | Accessible label, required if label is not provided (e.g. for icon-only items) |
2078
- | `icon` | no | string | Icon to display for icon-only items. Requires aria-label or label for accessibility |
2079
- | `isDisabled` | no | boolean | Disables this specific option |
2080
- | `label` | no | string | Display text for the option |
2081
- | `tip` | no | [FormSegmentedControlTip](./types.md#formsegmentedcontroltip) | Tooltip to show on hover for this option |
2082
- | `value` | yes | string | Value stored when option is selected |
2083
-
2084
- No additional properties.
2085
-
2086
- ## FormSegmentedControlRangeLabel
2087
-
2088
- Labels to display at the start and end of the control range
2089
-
2090
- ### Fields
2091
-
2092
- | Name | Required | Type | Description |
2093
- |---|---:|---|---|
2094
- | `end` | yes | string | Label at the end of the range |
2095
- | `start` | yes | string | Label at the start of the range |
2096
-
2097
- No additional properties.
2098
-
2099
- ## FormSegmentedControlTip
2100
-
2101
- Tooltip to show on hover for this option
2102
-
2103
- ### Fields
2104
-
2105
- | Name | Required | Type | Description |
2106
- |---|---:|---|---|
2107
- | `content` | yes | string | Tooltip text content |
2108
-
2109
- No additional properties.
2110
-
2111
- ## FormSegmentedControlValidationError
2112
-
2113
- Map of rule name to error message
2114
-
2115
- ### Fields
2116
-
2117
- _No fields._
2118
-
2119
- Additional properties: string.
2120
-
2121
- ## FormSelectableGroupList
2122
-
2123
- ### Fields
2124
-
2125
- _No fields._
2126
-
2127
- Additional properties: unknown.
2128
-
2129
- ## FormSelectableGroupValidationError
2130
-
2131
- Map of rule name to error message
2132
-
2133
- ### Fields
2134
-
2135
- _No fields._
2136
-
2137
- Additional properties: string.
2138
-
2139
- ## FormSelectAvatarProp
2140
-
2141
- Avatar configuration for the option
2142
-
2143
- ### Fields
2144
-
2145
- | Name | Required | Type | Description |
2146
- |---|---:|---|---|
2147
- | `image` | no | string | URL of avatar image |
2148
- | `title` | no | string | Title/alt text for avatar |
2149
-
2150
- No additional properties.
2151
-
2152
- ## FormSelectEmptyListPlaceholder
2153
-
2154
- ### Fields
2155
-
2156
- | Name | Required | Type | Description |
2157
- |---|---:|---|---|
2158
- | `onLoading` | no | string | Placeholder shown while list is loading |
2159
- | `onNoSearchQuery` | no | string | Placeholder when no search query entered |
2160
- | `onNoSearchResults` | no | string | Placeholder when search returns no results |
2161
-
2162
- No additional properties.
2163
-
2164
- ## FormSelectFuseOption
2165
-
2166
- Fuse.js search options for customizing fuzzy search behavior
2167
-
2168
- ### Fields
2169
-
2170
- _No fields._
2171
-
2172
- Additional properties: unknown.
2173
-
2174
- ## FormSelectList
2175
-
2176
- ### Fields
2177
-
2178
- | Name | Required | Type | Description |
2179
- |---|---:|---|---|
2180
- | `avatarProps` | no | [FormSelectAvatarProp](./types.md#formselectavatarprop) | Avatar configuration for the option |
2181
- | `description` | no | string | Description text shown below the label |
2182
- | `flag` | no | string | Two-letter country code for flag icon (e.g. "US", "IN") |
2183
- | `isDisabled` | no | boolean | Disables this specific option |
2184
- | `isRecommended` | no | boolean | Marks option as recommended with a badge |
2185
- | `isSeparator` | no | boolean | Renders as a visual separator instead of selectable option |
2186
- | `label` | yes | string | Display text for the option |
2187
- | `labelIcon` | no | string | Icon glyph name to show next to the label |
2188
- | `leftIconType` | no | string | Icon glyph name to show on the left. E.g. "CHECK_CIRCLE_OUTLINE" |
2189
- | `quaternaryLabel` | no | string | Quaternary label shown below tertiary label |
2190
- | `rightLabel` | no | string | Label aligned to the right side of the option |
2191
- | `secondaryLabel` | no | string | Secondary label shown below the main label |
2192
- | `tertiaryLabel` | no | string | Tertiary label shown below secondary label |
2193
- | `value` | yes | unknown | Value stored when option is selected |
2194
-
2195
- No additional properties.
2196
-
2197
- ## FormSelectValidationError
2198
-
2199
- Map of rule name to error message
2200
-
2201
- ### Fields
2202
-
2203
- _No fields._
2204
-
2205
- Additional properties: string.
2206
-
2207
- ## FormSignatureValidationError
2208
-
2209
- Map of rule name to error message
2210
-
2211
- ### Fields
2212
-
2213
- _No fields._
2214
-
2215
- Additional properties: string.
2216
-
2217
- ## FormSinValidationError
2218
-
2219
- Map of rule name to error message
2220
-
2221
- ### Fields
2222
-
2223
- _No fields._
2224
-
2225
- Additional properties: string.
2226
-
2227
- ## FormSliderMark
2228
-
2229
- Named marks on the slider track. Keys are numeric positions, values are labels
2230
-
2231
- ### Fields
2232
-
2233
- _No fields._
2234
-
2235
- Additional properties: string.
2236
-
2237
- ## FormSliderValidationError
2238
-
2239
- Map of rule name to error message
2240
-
2241
- ### Fields
2242
-
2243
- _No fields._
2244
-
2245
- Additional properties: string.
2246
-
2247
- ## FormSsnValidationError
2248
-
2249
- Map of rule name to error message
2250
-
2251
- ### Fields
2252
-
2253
- _No fields._
2254
-
2255
- Additional properties: string.
2256
-
2257
- ## FormSurveyList
2258
-
2259
- ### Fields
2260
-
2261
- | Name | Required | Type | Description |
2262
- |---|---:|---|---|
2263
- | `icon` | no | string | Pebble icon name displayed for the option |
2264
- | `isDisabled` | no | boolean | Disable this specific option |
2265
- | `label` | no | string \| number | Display label for the option |
2266
- | `selectionColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Override selected surface color token for this option |
2267
- | `value` | yes | string \| number | Value when selected |
2268
-
2269
- No additional properties.
2270
-
2271
- ## FormSurveyRangeLabel
2272
-
2273
- Labels for lowest and highest options
2274
-
2275
- ### Fields
2276
-
2277
- | Name | Required | Type | Description |
2278
- |---|---:|---|---|
2279
- | `lower` | yes | string | Label for the lowest option |
2280
- | `upper` | yes | string | Label for the highest option |
2281
-
2282
- No additional properties.
2283
-
2284
- ## FormSurveyValidationError
2285
-
2286
- Map of rule name to error message
2287
-
2288
- ### Fields
2289
-
2290
- _No fields._
2291
-
2292
- Additional properties: string.
2293
-
2294
- ## FormSwitchTip
2295
-
2296
- ### Fields
2297
-
2298
- | Name | Required | Type | Description |
2299
- |---|---:|---|---|
2300
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip theme. Default: LIGHT |
2301
- | `content` | yes | string | Tooltip text content |
2302
- | `hideOnDocumentScroll` | no | boolean | Hide tooltip when the document is scrolled. Default: false |
2303
- | `isDelayed` | no | boolean | Add delay before showing/hiding the tooltip. Default: false |
2304
- | `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
2305
- | `isPositionFixed` | no | boolean | Use fixed positioning for the tooltip. Default: false |
2306
- | `isVisible` | no | boolean | Control tooltip visibility from parent. Overrides hover behavior when set |
2307
- | `maxHeight` | no | number \| string | Max height of tooltip content. Number in px or CSS string |
2308
- | `maxWidth` | no | number \| string | Max width of tooltip. Number in px or CSS string. Default: 360 |
2309
- | `onlyIfChildOverflow` | no | boolean | Only show tooltip if a child element overflows. Default: false |
2310
- | `onlyIfOverflow` | no | boolean | Only show tooltip if the trigger element overflows. Default: false |
2311
- | `placement` | no | [TipPlacement](./definitions.md#tipplacement) | Tooltip position relative to child. Default: bottom |
2312
- | `tipHideDelay` | no | number | Custom delay in ms before tooltip hides |
2313
- | `tipShowDelay` | no | number | Custom delay in ms before tooltip appears |
2314
- | `title` | no | string | Optional bold title above tooltip content |
2315
-
2316
- No additional properties.
2317
-
2318
- ## FormSwitchValidationError
2319
-
2320
- Map of rule name to error message
2321
-
2322
- ### Fields
2323
-
2324
- _No fields._
2325
-
2326
- Additional properties: string.
2327
-
2328
- ## FormTextareaValidationError
2329
-
2330
- Map of rule name to error message
2331
-
2332
- ### Fields
2333
-
2334
- _No fields._
2335
-
2336
- Additional properties: string.
2337
-
2338
- ## FormTextAutoSuggestFuseOption
2339
-
2340
- Fuse.js search options for customizing suggestion filtering
2341
-
2342
- ### Fields
2343
-
2344
- _No fields._
2345
-
2346
- Additional properties: unknown.
2347
-
2348
- ## FormTextAutoSuggestList
2349
-
2350
- ### Fields
2351
-
2352
- | Name | Required | Type | Description |
2353
- |---|---:|---|---|
2354
- | `isDisabled` | no | boolean | Disables selection for this suggestion item |
2355
- | `label` | no | string | Display text shown for the suggestion item |
2356
- | `value` | no | string \| number | Value written when the suggestion is selected |
2357
-
2358
- Additional properties: unknown.
2359
-
2360
- ## FormTextAutoSuggestValidationError
2361
-
2362
- Map of rule name to error message
2363
-
2364
- ### Fields
2365
-
2366
- _No fields._
2367
-
2368
- Additional properties: string.
2369
-
2370
- ## FormTextStringPadding
2371
-
2372
- Pads input value with character until reaching maxLength
2373
-
2374
- ### Fields
2375
-
2376
- | Name | Required | Type | Description |
2377
- |---|---:|---|---|
2378
- | `character` | yes | string | Character to use for padding |
2379
- | `maxLength` | yes | number | Target length after padding |
2380
- | `position` | yes | [PanePin](./definitions.md#panepin) | Where to add padding: start or end |
2381
-
2382
- No additional properties.
2383
-
2384
- ## FormTextValidationError
2385
-
2386
- Map of rule name to error message
2387
-
2388
- ### Fields
2389
-
2390
- _No fields._
2391
-
2392
- Additional properties: string.
2393
-
2394
- ## FormTimeShouldAllowTimeSelection
2395
-
2396
- ### Fields
2397
-
2398
- | Name | Required | Type | Description |
2399
- |---|---:|---|---|
2400
- | `reference` | no | string | Reference ISO time for period labels |
2401
-
2402
- No additional properties.
2403
-
2404
- ## FormTimeTimezone
2405
-
2406
- ### Fields
2407
-
2408
- | Name | Required | Type | Description |
2409
- |---|---:|---|---|
2410
- | `name` | yes | string | Input name for the timezone selector |
2411
- | `isRequired` | no | boolean | Marks the timezone selector as required |
2412
- | `value` | no | string | Selected timezone value |
2413
-
2414
- No additional properties.
2415
-
2416
- ## FormTimeValidationError
2417
-
2418
- Map of rule name to error message
2419
-
2420
- ### Fields
2421
-
2422
- _No fields._
2423
-
2424
- Additional properties: string.
2425
-
2426
- ## FormTimezoneValidationError
2427
-
2428
- Map of rule name to error message
2429
-
2430
- ### Fields
2431
-
2432
- _No fields._
2433
-
2434
- Additional properties: string.
2435
-
2436
- ## FormTreeDisabledInfo
2437
-
2438
- ### Fields
2439
-
2440
- | Name | Required | Type | Description |
2441
- |---|---:|---|---|
2442
- | `content` | yes | string | Tooltip content text |
2443
- | `isMobileSupported` | no | boolean | Show tooltip on mobile devices |
2444
- | `maxHeight` | no | number \| string | Maximum tooltip height |
2445
- | `maxWidth` | no | number \| string | Maximum tooltip width |
2446
-
2447
- No additional properties.
2448
-
2449
- ## FormTreeFuseOption
2450
-
2451
- Fuse.js search options for customizing search behavior
2452
-
2453
- ### Fields
2454
-
2455
- _No fields._
2456
-
2457
- Additional properties: unknown.
2458
-
2459
- ## FormTreeList
2460
-
2461
- ### Fields
2462
-
2463
- | Name | Required | Type | Description |
2464
- |---|---:|---|---|
2465
- | `disabledInfo` | no | string \| [FormTreeDisabledInfo](./types.md#formtreedisabledinfo) | Tooltip shown when item is disabled |
2466
- | `isDisabled` | no | boolean | Disable this item |
2467
- | `isLeaf` | no | boolean | Marks the item as a leaf node |
2468
- | `label` | yes | string | Display label for the item |
2469
- | `parent` | no | string | Parent item value, null for root items |
2470
- | `secondaryLabel` | no | string | Supporting text below the label |
2471
- | `tag` | no | string \| [FormTreeTag](./types.md#formtreetag) | Chip/tag to display next to the label |
2472
- | `value` | yes | string | Unique identifier for the item |
2473
-
2474
- No additional properties.
2475
-
2476
- ## FormTreeSelectFuseOption
2477
-
2478
- Fuse.js search configuration. Default: { keys: ["label", "name"] }
2479
-
2480
- ### Fields
2481
-
2482
- _No fields._
2483
-
2484
- Additional properties: unknown.
2485
-
2486
- ## FormTreeSelectList
2487
-
2488
- ### Fields
2489
-
2490
- | Name | Required | Type | Description |
2491
- |---|---:|---|---|
2492
- | `isDisabled` | no | boolean | Disable this item |
2493
- | `isLeaf` | no | boolean | Marks the item as a leaf node |
2494
- | `label` | yes | string | Display label for the item |
2495
- | `parent` | no | string | Parent item value, null for root items |
2496
- | `secondaryLabel` | no | string | Supporting text below the label |
2497
- | `value` | yes | string | Unique identifier for the item |
2498
-
2499
- No additional properties.
2500
-
2501
- ## FormTreeSelectValidationError
2502
-
2503
- Map of rule name to error message
2504
-
2505
- ### Fields
2506
-
2507
- _No fields._
2508
-
2509
- Additional properties: string.
2510
-
2511
- ## FormTreeTag
2512
-
2513
- ### Fields
2514
-
2515
- | Name | Required | Type | Description |
2516
- |---|---:|---|---|
2517
- | `appearance` | no | string | Label appearance (e.g., "primary", "error", "success") |
2518
- | `text` | yes | string | Tag text to display |
2519
-
2520
- No additional properties.
2521
-
2522
- ## FormTreeValidationError
2523
-
2524
- Map of rule name to error message
2525
-
2526
- ### Fields
2527
-
2528
- _No fields._
2529
-
2530
- Additional properties: string.
2531
-
2532
- ## FormValidationError
2533
-
2534
- External validation errors keyed by input name
2535
-
2536
- ### Fields
2537
-
2538
- _No fields._
2539
-
2540
- Additional properties: string.
2541
-
2542
- ## FormValue
2543
-
2544
- Form values model. Written to state on change/submit (read-only — push-only)
2545
-
2546
- ### Fields
2547
-
2548
- _No fields._
2549
-
2550
- Additional properties: unknown.
2551
-
2552
- ## FormWorkEmailDomainList
2553
-
2554
- ### Fields
2555
-
2556
- | Name | Required | Type | Description |
2557
- |---|---:|---|---|
2558
- | `isDisabled` | no | boolean | Disables this specific domain option |
2559
- | `label` | no | string | Display label for the domain option |
2560
- | `tag` | no | string \| [FormWorkEmailTag](./types.md#formworkemailtag) | Optional tag shown with the domain option |
2561
- | `value` | yes | string | Domain option value |
2562
-
2563
- No additional properties.
2564
-
2565
- ## FormWorkEmailTag
2566
-
2567
- ### Fields
2568
-
2569
- | Name | Required | Type | Description |
2570
- |---|---:|---|---|
2571
- | `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Optional semantic appearance for the tag |
2572
- | `text` | yes | string | Tag text displayed with the domain option |
2573
-
2574
- No additional properties.
2575
-
2576
- ## FormWorkEmailValidationError
2577
-
2578
- Map of rule name to error message
2579
-
2580
- ### Fields
2581
-
2582
- _No fields._
2583
-
2584
- Additional properties: string.
2585
-
2586
- ## GridAction
2587
-
2588
- ### Fields
2589
-
2590
- | Name | Required | Type | Description |
2591
- |---|---:|---|---|
2592
- | `aria-label` | no | string | Accessibility label for the action button |
2593
- | `aria-labelledby` | no | string | ID of element that labels the action button |
2594
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
2595
- | `iconType` | yes | string | Icon type name (e.g., "EDIT_OUTLINE", "DELETE") |
2596
- | `id` | yes | string | Unique identifier for this action. Written to state on click |
2597
- | `isDisabled` | no | boolean | Disable the action button. Default: false |
2598
- | `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip for the action button. Can be a simple string or tooltip configuration object |
2599
-
2600
- No additional properties.
2601
-
2602
- ## GridLeftIcon
2603
-
2604
- ### Fields
2605
-
2606
- | Name | Required | Type | Description |
2607
- |---|---:|---|---|
2608
- | `aria-describedby` | no | string | ID of element that describes this icon |
2609
- | `aria-label` | no | string | Accessible label for screen readers |
2610
- | `aria-labelledby` | no | string | ID of element that labels this icon |
2611
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
2612
- | `type` | yes | string | Icon type name |
2613
-
2614
- No additional properties.
2615
-
2616
- ## GridList
2617
-
2618
- ### Fields
2619
-
2620
- | Name | Required | Type | Description |
2621
- |---|---:|---|---|
2622
- | `label` | yes | string \| number | Label displayed in the cell header. String or number value |
2623
- | `props` | yes | [GridProp](./types.md#gridprop) | Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens. |
2624
- | `renderer` | yes | "LABEL" | Renderer type for the cell value. LABEL renders a Label component. |
2625
- | `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
2626
-
2627
- No additional properties.
2628
-
2629
- ## GridListVariant2
2630
-
2631
- ### Fields
2632
-
2633
- | Name | Required | Type | Description |
2634
- |---|---:|---|---|
2635
- | `label` | yes | string \| number | Label displayed in the cell header. String or number value |
2636
- | `props` | yes | [GridProp](./types.md#gridprop) | Props passed to TextRenderer: { value, color? }. Color must be a Pebble text/icon color token. |
2637
- | `renderer` | no | "TEXT" | Renderer type for the cell value. TEXT displays plain text. Default: TEXT |
2638
- | `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
2639
-
2640
- No additional properties.
2641
-
2642
- ## GridProp
2643
-
2644
- Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
2645
-
2646
- ### Fields
2647
-
2648
- | Name | Required | Type | Description |
2649
- |---|---:|---|---|
2650
- | `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Color scheme of the label. Default: NEUTRAL |
2651
- | `children` | no | string | Text content of the label |
2652
- | `leftIcon` | no | string \| [GridLeftIcon](./types.md#gridlefticon) | Icon displayed on the left side of the label |
2653
- | `maxWidth` | no | string | Maximum width CSS value for truncation |
2654
- | `rightIcon` | no | string \| [GridRightIcon](./types.md#gridrighticon) | Icon displayed on the right side of the label |
2655
- | `size` | no | [ChipSize](./definitions.md#chipsize) | Size of the label. Default: LARGE |
2656
- | `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
2657
- | `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
2658
-
2659
- No additional properties.
2660
-
2661
- ## GridRightIcon
2662
-
2663
- ### Fields
2664
-
2665
- | Name | Required | Type | Description |
2666
- |---|---:|---|---|
2667
- | `aria-describedby` | no | string | ID of element that describes this icon |
2668
- | `aria-label` | no | string | Accessible label for screen readers |
2669
- | `aria-labelledby` | no | string | ID of element that labels this icon |
2670
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
2671
- | `type` | yes | string | Icon type name |
2672
-
2673
- No additional properties.
2674
-
2675
- ## GridTip
2676
-
2677
- ### Fields
2678
-
2679
- | Name | Required | Type | Description |
2680
- |---|---:|---|---|
2681
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style |
2682
- | `content` | yes | string | Tooltip content text |
2683
- | `isVisible` | no | boolean | Force tooltip to always be visible |
2684
- | `maxHeight` | no | number \| string | Maximum height for tooltip |
2685
- | `maxWidth` | no | number \| string | Maximum width for tooltip |
2686
- | `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement position |
2687
-
2688
- No additional properties.
2689
-
2690
- ## HelperMessage
2691
-
2692
- ### Fields
2693
-
2694
- | Name | Required | Type | Description |
2695
- |---|---:|---|---|
2696
- | `message` | yes | string | Helper or error message text |
2697
- | `status` | no | string | Message status, e.g. "ERROR" for validation errors |
2698
-
2699
- No additional properties.
2700
-
2701
- ## HStackMargin
2702
-
2703
- ### Fields
2704
-
2705
- | Name | Required | Type | Description |
2706
- |---|---:|---|---|
2707
- | `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
2708
- | `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
2709
- | `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
2710
- | `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
2711
-
2712
- No additional properties.
2713
-
2714
- ## HStackPadding
2715
-
2716
- ### Fields
2717
-
2718
- | Name | Required | Type | Description |
2719
- |---|---:|---|---|
2720
- | `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
2721
- | `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
2722
- | `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
2723
- | `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
2724
-
2725
- No additional properties.
2726
-
2727
- ## IconButtonIcon
2728
-
2729
- ### Fields
2730
-
2731
- | Name | Required | Type | Description |
2732
- |---|---:|---|---|
2733
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
2734
- | `type` | yes | string | Icon type from Icon.TYPES |
2735
-
2736
- No additional properties.
2737
-
2738
- ## IconButtonTip
2739
-
2740
- ### Fields
2741
-
2742
- | Name | Required | Type | Description |
2743
- |---|---:|---|---|
2744
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
2745
- | `content` | yes | string | Tooltip content text |
2746
- | `isVisible` | no | boolean | Control tooltip visibility from parent |
2747
- | `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
2748
- | `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
2749
- | `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to button. Default: TOP_START |
2750
-
2751
- No additional properties.
2752
-
2753
- ## IconButtonTo
2754
-
2755
- ### Fields
2756
-
2757
- | Name | Required | Type | Description |
2758
- |---|---:|---|---|
2759
- | `openInNewTab` | no | boolean | Open link in new tab. Default: false |
2760
- | `path` | yes | string | URL path for navigation |
2761
-
2762
- No additional properties.
2763
-
2764
- ## IconTip
2765
-
2766
- ### Fields
2767
-
2768
- | Name | Required | Type | Description |
2769
- |---|---:|---|---|
2770
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
2771
- | `content` | yes | string | Tooltip text content |
2772
- | `maxHeight` | no | number \| string | Max height in px or CSS string |
2773
- | `maxWidth` | no | number \| string | Max width in px or CSS string |
2774
- | `placement` | no | [IconTipPlacement](./definitions.md#icontipplacement) | Tooltip placement. Default: BOTTOM |
2775
- | `title` | no | string | Tooltip title text |
2776
-
2777
- No additional properties.
2778
-
2779
- ## ImageProp
2780
-
2781
- ### Fields
2782
-
2783
- | Name | Required | Type | Description |
2784
- |---|---:|---|---|
2785
- | `alt` | no | string | Alt text for avatar image |
2786
-
2787
- No additional properties.
2788
-
2789
- ## InputGroupInput
2790
-
2791
- Main input configuration with type and inputProps
2792
-
2793
- ### Fields
2794
-
2795
- | Name | Required | Type | Description |
2796
- |---|---:|---|---|
2797
- | `inputProps` | yes | [InputGroupInputProp](./types.md#inputgroupinputprop) | Props to pass to the input component |
2798
- | `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
2799
-
2800
- No additional properties.
2801
-
2802
- ## InputGroupInputProp
2803
-
2804
- Props to pass to the input component
2805
-
2806
- ### Fields
2807
-
2808
- _No fields._
2809
-
2810
- Additional properties: unknown.
2811
-
2812
- ## InputGroupPrefix
2813
-
2814
- ### Fields
2815
-
2816
- | Name | Required | Type | Description |
2817
- |---|---:|---|---|
2818
- | `inputProps` | yes | [InputGroupInputProp](./types.md#inputgroupinputprop) | Props to pass to the input component |
2819
- | `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
2820
-
2821
- No additional properties.
2822
-
2823
- ## InputGroupSuffix
2824
-
2825
- ### Fields
2826
-
2827
- | Name | Required | Type | Description |
2828
- |---|---:|---|---|
2829
- | `inputProps` | yes | [InputGroupInputProp](./types.md#inputgroupinputprop) | Props to pass to the input component |
2830
- | `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
2831
-
2832
- No additional properties.
2833
-
2834
- ## LabelLeftIcon
2835
-
2836
- ### Fields
2837
-
2838
- | Name | Required | Type | Description |
2839
- |---|---:|---|---|
2840
- | `aria-describedby` | no | string | ID of element that describes this icon |
2841
- | `aria-label` | no | string | Accessible label for screen readers |
2842
- | `aria-labelledby` | no | string | ID of element that labels this icon |
2843
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
2844
- | `type` | yes | string | Icon type name |
2845
-
2846
- No additional properties.
2847
-
2848
- ## LabelRightIcon
2849
-
2850
- ### Fields
2851
-
2852
- | Name | Required | Type | Description |
2853
- |---|---:|---|---|
2854
- | `aria-describedby` | no | string | ID of element that describes this icon |
2855
- | `aria-label` | no | string | Accessible label for screen readers |
2856
- | `aria-labelledby` | no | string | ID of element that labels this icon |
2857
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
2858
- | `type` | yes | string | Icon type name |
2859
-
2860
- No additional properties.
2861
-
2862
- ## LabelTip
2863
-
2864
- ### Fields
2865
-
2866
- | Name | Required | Type | Description |
2867
- |---|---:|---|---|
2868
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style. Default: LIGHT |
2869
- | `className` | no | string | CSS class name for tooltip |
2870
- | `content` | yes | string | Tooltip text content |
2871
- | `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls. Default: false |
2872
- | `isDelayed` | no | boolean | Add 300ms delay before showing tooltip. Default: false |
2873
- | `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
2874
- | `isPositionFixed` | no | boolean | Use fixed positioning (relative to viewport). Default: false |
2875
- | `isVisible` | no | boolean | Control tooltip visibility from parent component |
2876
- | `maxHeight` | no | number \| string | Maximum height for tooltip content |
2877
- | `maxWidth` | no | number \| string | Maximum width for tooltip content |
2878
- | `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows. Default: false |
2879
- | `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows. Default: false |
2880
- | `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware. Default: false |
2881
- | `padding` | no | string | CSS padding value for tooltip content |
2882
- | `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to label. Default: TOP_START |
2883
- | `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis. Default: false |
2884
- | `tipHideDelay` | no | number | Milliseconds to wait before hiding tooltip (when isDelayed is true) |
2885
- | `tipShowDelay` | no | number | Milliseconds to wait before showing tooltip (when isDelayed is true) |
2886
- | `title` | no | string | Tooltip title text |
2887
- | `truncateClassName` | no | string | CSS class when onlyIfOverflow is enabled |
2888
-
2889
- No additional properties.
2890
-
2891
- ## LabelValue
2892
-
2893
- Label chip displayed next to the title
2894
-
2895
- ### Fields
2896
-
2897
- | Name | Required | Type | Description |
2898
- |---|---:|---|---|
2899
- | `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Label appearance. Default: NEUTRAL |
2900
- | `children` | no | string | Label text displayed in the chip |
2901
- | `leftIcon` | no | string \| [ObjectUIHeaderLeftIcon](./types.md#objectuiheaderlefticon) | Left icon shown inside the label |
2902
- | `maxWidth` | no | string | Maximum label width as a CSS value |
2903
- | `rightIcon` | no | string \| [ObjectUIHeaderRightIcon](./types.md#objectuiheaderrighticon) | Right icon shown inside the label |
2904
- | `size` | no | [ChipSize](./definitions.md#chipsize) | Label size. Default: LARGE |
2905
- | `tip` | no | string | Tooltip text for the label. String tip content only in SDUI |
2906
-
2907
- No additional properties.
2908
-
2909
- ## LayoutBorder
2910
-
2911
- Structured border using strict token parts
2912
-
2913
- ### Fields
2914
-
2915
- | Name | Required | Type | Description |
2916
- |---|---:|---|---|
2917
- | `color` | no | [BoxBorderColor](./definitions.md#boxbordercolor) | Border color token |
2918
- | `style` | no | [BoxBorderStyle](./definitions.md#boxborderstyle) | CSS border style |
2919
- | `width` | no | [BoxBorderWidth](./definitions.md#boxborderwidth) | Border width token |
2920
-
2921
- No additional properties.
2922
-
2923
- ## LayoutGap
2924
-
2925
- ### Fields
2926
-
2927
- | Name | Required | Type | Description |
2928
- |---|---:|---|---|
2929
- | `column` | no | [BoxGap](./definitions.md#boxgap) | Column gap spacing token |
2930
- | `row` | no | [BoxGap](./definitions.md#boxgap) | Row gap spacing token |
2931
-
2932
- No additional properties.
2933
-
2934
- ## LayoutMargin
2935
-
2936
- ### Fields
2937
-
2938
- | Name | Required | Type | Description |
2939
- |---|---:|---|---|
2940
- | `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
2941
- | `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
2942
- | `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
2943
- | `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
2944
-
2945
- No additional properties.
2946
-
2947
- ## LayoutPadding
2948
-
2949
- ### Fields
2950
-
2951
- | Name | Required | Type | Description |
2952
- |---|---:|---|---|
2953
- | `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
2954
- | `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
2955
- | `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
2956
- | `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
2957
-
2958
- No additional properties.
2959
-
2960
- ## LayoutRadiu
2961
-
2962
- ### Fields
2963
-
2964
- | Name | Required | Type | Description |
2965
- |---|---:|---|---|
2966
- | `bottomLeft` | no | [BoxRadius](./definitions.md#boxradius) | Bottom-left corner radius token |
2967
- | `bottomRight` | no | [BoxRadius](./definitions.md#boxradius) | Bottom-right corner radius token |
2968
- | `topLeft` | no | [BoxRadius](./definitions.md#boxradius) | Top-left corner radius token |
2969
- | `topRight` | no | [BoxRadius](./definitions.md#boxradius) | Top-right corner radius token |
2970
-
2971
- No additional properties.
2972
-
2973
- ## LayoutValue
2974
-
2975
- ### Fields
2976
-
2977
- | Name | Required | Type | Description |
2978
- |---|---:|---|---|
2979
- | `border` | no | string | CSS border applied to the block wrapper, e.g. "1px solid #E0E0E0". |
2980
- | `height` | no | number | Height in grid units. Default: 1 |
2981
- | `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. |
2982
- | `maxHeight` | no | number | Maximum height in grid units |
2983
- | `maxWidth` | no | number | Maximum width in grid units |
2984
- | `minHeight` | no | number | Minimum height in grid units |
2985
- | `minWidth` | no | number | Minimum width in grid units |
2986
- | `shadow` | no | [LayoutValueShadow](./definitions.md#layoutvalueshadow) | Shadow token applied to the block wrapper, e.g. "shadowSm". |
2987
- | `shapeCorner` | no | [BoxRadius](./definitions.md#boxradius) | Shape-corner radius token for this block, e.g. "shapeCornerMd". Overrides the parent board `blockShapeCorner` for this entry only. |
2988
- | `width` | no | number | Width in grid units (1–12). Default: 3 |
2989
- | `x` | no | number | Horizontal position in grid units. Auto-calculated when omitted. |
2990
- | `y` | no | number | Vertical position in grid units. Auto-calculated when omitted. |
2991
-
2992
- No additional properties.
2993
-
2994
- ## LinkValue
2995
-
2996
- ### Fields
2997
-
2998
- | Name | Required | Type | Description |
2999
- |---|---:|---|---|
3000
- | `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the nested link tab |
3001
- | `title` | yes | string | Display text for the nested link tab |
3002
-
3003
- No additional properties.
3004
-
3005
- ## ListVariant3
3006
-
3007
- ### Fields
3008
-
3009
- | Name | Required | Type | Description |
3010
- |---|---:|---|---|
3011
- | `isSeparator` | yes | true | Render a visual separator |
3012
-
3013
- No additional properties.
3014
-
3015
- ## LoadConfig
3016
-
3017
- Semantic Lottie load configuration object
3018
-
3019
- ### Fields
3020
-
3021
- | Name | Required | Type | Description |
3022
- |---|---:|---|---|
3023
- | `animationData` | no | [AnimationData](./types.md#animationdata) | Lottie animation JSON object. Required if path is not provided |
3024
- | `autoplay` | no | boolean | Start playing automatically on load. Default: true |
3025
- | `loop` | no | boolean \| number | Loop animation. true for infinite, false for once, or number for specific count |
3026
- | `path` | no | string | URL or relative path to the Lottie JSON animation file. Required if animationData is not provided |
3027
- | `renderer` | no | [LoadConfigRenderer](./definitions.md#loadconfigrenderer) | Rendering method for the animation. Default: svg |
3028
-
3029
- No additional properties.
3030
-
3031
- ## Location
3032
-
3033
- Location object with nickname and address. Required for displaying location information
3034
-
3035
- ### Fields
3036
-
3037
- | Name | Required | Type | Description |
3038
- |---|---:|---|---|
3039
- | `address` | yes | [Addres](./types.md#addres) | Address object with street, city, state, country, and zip |
3040
- | `nickname` | yes | string | Location nickname or display name |
3041
-
3042
- No additional properties.
3043
-
3044
- ## LocationCardAction
3045
-
3046
- ### Fields
3047
-
3048
- | Name | Required | Type | Description |
3049
- |---|---:|---|---|
3050
- | `icon` | no | string | Icon name from Icon.TYPES (e.g. "EDIT", "DELETE") |
3051
- | `id` | yes | string | Unique identifier for the action |
3052
- | `label` | yes | string | Label text for the action |
3053
-
3054
- No additional properties.
3055
-
3056
- ## LocationCardTo
3057
-
3058
- ### Fields
3059
-
3060
- | Name | Required | Type | Description |
3061
- |---|---:|---|---|
3062
- | `openInNewTab` | no | boolean | |
3063
- | `path` | yes | string | |
3064
-
3065
- No additional properties.
3066
-
3067
- ## MaskerArg
3068
-
3069
- ### Fields
3070
-
3071
- _No fields._
3072
-
3073
- Additional properties: unknown.
3074
-
3075
- ## MaskerCheck
3076
-
3077
- ### Fields
3078
-
3079
- | Name | Required | Type | Description |
3080
- |---|---:|---|---|
3081
- | `args` | no | [MaskerArg](./types.md#maskerarg) | |
3082
- | `message` | yes | string | |
3083
- | `type` | yes | string | |
3084
-
3085
- No additional properties.
3086
-
3087
- ## MenuListList
3088
-
3089
- ### Fields
3090
-
3091
- | Name | Required | Type | Description |
3092
- |---|---:|---|---|
3093
- | `description` | no | string | Description text shown inline with the label |
3094
- | `disabledInfo` | no | string | Tooltip text shown for disabled items |
3095
- | `isDisabled` | no | boolean | Disables this menu item |
3096
- | `label` | yes | string | Display text for the menu item |
3097
- | `leftIconType` | no | string | Icon name to show on the left side of the item |
3098
- | `quaternaryLabel` | no | string | Quaternary text shown below tertiary label |
3099
- | `rightLabel` | no | string | Text shown on the right side of the item |
3100
- | `secondaryLabel` | no | string | Secondary text shown below the label |
3101
- | `tag` | no | string | Tag label shown beside the item text |
3102
- | `tertiaryLabel` | no | string | Tertiary text shown below secondary label |
3103
- | `type` | no | [DropdownFooterType](./definitions.md#dropdownfootertype) | Visual style type for the item (WARNING or ALERT) |
3104
- | `value` | yes | string | Unique value for the item |
3105
-
3106
- No additional properties.
3107
-
3108
- ## Metadata
3109
-
3110
- Arbitrary key/value context forwarded to the global SnackBar.onTrigger callback. Useful for analytics/logging (e.g. { source: "ProfilePage" })
3111
-
3112
- ### Fields
3113
-
3114
- _No fields._
3115
-
3116
- Additional properties: unknown.
3117
-
3118
- ## NestedListToggleIcon
3119
-
3120
- Toggle icon configuration
3121
-
3122
- ### Fields
3123
-
3124
- | Name | Required | Type | Description |
3125
- |---|---:|---|---|
3126
- | `align` | no | string | CSS alignSelf value. Default: center |
3127
- | `margin` | no | [BoxGap](./definitions.md#boxgap) | Margin spacing token for icon alignment |
3128
- | `size` | no | [IconSize](./definitions.md#iconsize) | Icon size token. Default: 24 |
3129
-
3130
- No additional properties.
3131
-
3132
- ## NumberArg
3133
-
3134
- ### Fields
3135
-
3136
- _No fields._
3137
-
3138
- Additional properties: unknown.
3139
-
3140
- ## NumberCheck
3141
-
3142
- ### Fields
3143
-
3144
- | Name | Required | Type | Description |
3145
- |---|---:|---|---|
3146
- | `args` | no | [NumberArg](./types.md#numberarg) | |
3147
- | `message` | yes | string | |
3148
- | `type` | yes | string | |
3149
-
3150
- No additional properties.
3151
-
3152
- ## NumberStringPadding
3153
-
3154
- Adds padding characters to the input value
3155
-
3156
- ### Fields
3157
-
3158
- | Name | Required | Type | Description |
3159
- |---|---:|---|---|
3160
- | `character` | yes | string | Character to use for padding |
3161
- | `maxLength` | yes | number | Target length after padding |
3162
- | `position` | yes | [PanePin](./definitions.md#panepin) | Position to pad (start or end) |
3163
-
3164
- No additional properties.
3165
-
3166
- ## ObjectUIAvatarProp
3167
-
3168
- Avatar configuration for the header
3169
-
3170
- ### Fields
3171
-
3172
- | Name | Required | Type | Description |
3173
- |---|---:|---|---|
3174
- | `icon` | no | string | Icon type string when type is ICON |
3175
- | `image` | no | string | Image URL for the avatar |
3176
- | `imageBackground` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color token for avatar image background |
3177
- | `isRound` | no | boolean | If false, square avatar is shown. Default: true |
3178
- | `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
3179
-
3180
- No additional properties.
3181
-
3182
- ## ObjectUIHeaderAvatarProp
3183
-
3184
- Avatar configuration for the header
3185
-
3186
- ### Fields
3187
-
3188
- | Name | Required | Type | Description |
3189
- |---|---:|---|---|
3190
- | `icon` | no | string | Icon type string when type is ICON |
3191
- | `image` | no | string | Image URL for the avatar |
3192
- | `imageBackground` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color token for avatar image background |
3193
- | `isRound` | no | boolean | If false, square avatar is shown. Default: true |
3194
- | `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
3195
-
3196
- No additional properties.
3197
-
3198
- ## ObjectUIHeaderLeftIcon
3199
-
3200
- ### Fields
3201
-
3202
- | Name | Required | Type | Description |
3203
- |---|---:|---|---|
3204
- | `aria-describedby` | no | string | ID of the element describing the icon |
3205
- | `aria-label` | no | string | Accessible label for the icon |
3206
- | `aria-labelledby` | no | string | ID of the element labelling the icon |
3207
- | `color` | no | string | Optional icon color value |
3208
- | `type` | yes | string | Icon type string to render inside the label |
3209
-
3210
- No additional properties.
3211
-
3212
- ## ObjectUIHeaderPrimaryAction
3213
-
3214
- Primary action button. Clicking it emits the primaryAction event
3215
-
3216
- ### Fields
3217
-
3218
- | Name | Required | Type | Description |
3219
- |---|---:|---|---|
3220
- | `icon` | no | string | Icon type string for the primary button |
3221
- | `label` | yes | string | Label of the primary button |
3222
- | `size` | no | [ButtonSize](./definitions.md#buttonsize) | Primary button size. Default: M |
3223
-
3224
- No additional properties.
3225
-
3226
- ## ObjectUIHeaderRightIcon
3227
-
3228
- ### Fields
3229
-
3230
- | Name | Required | Type | Description |
3231
- |---|---:|---|---|
3232
- | `aria-describedby` | no | string | ID of the element describing the icon |
3233
- | `aria-label` | no | string | Accessible label for the icon |
3234
- | `aria-labelledby` | no | string | ID of the element labelling the icon |
3235
- | `color` | no | string | Optional icon color value |
3236
- | `type` | yes | string | Icon type string to render inside the label |
3237
-
3238
- No additional properties.
3239
-
3240
- ## ObjectUIStatsAction
3241
-
3242
- ### Fields
3243
-
3244
- | Name | Required | Type | Description |
3245
- |---|---:|---|---|
3246
- | `aria-label` | no | string | Accessibility label for the action button |
3247
- | `aria-labelledby` | no | string | ID of element that labels the action button |
3248
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
3249
- | `iconType` | yes | string | Icon type name (e.g., "EDIT_OUTLINE", "DELETE") |
3250
- | `id` | yes | string | Unique identifier for this action. Written to state on click |
3251
- | `isDisabled` | no | boolean | Disable the action button. Default: false |
3252
- | `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip for the action button. Can be a simple string or tooltip configuration object |
3253
-
3254
- No additional properties.
3255
-
3256
- ## ObjectUIStatsLeftIcon
3257
-
3258
- ### Fields
3259
-
3260
- | Name | Required | Type | Description |
3261
- |---|---:|---|---|
3262
- | `aria-describedby` | no | string | ID of element that describes this icon |
3263
- | `aria-label` | no | string | Accessible label for screen readers |
3264
- | `aria-labelledby` | no | string | ID of element that labels this icon |
3265
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
3266
- | `type` | yes | string | Icon type name |
3267
-
3268
- No additional properties.
3269
-
3270
- ## ObjectUIStatsList
3271
-
3272
- ### Fields
3273
-
3274
- | Name | Required | Type | Description |
3275
- |---|---:|---|---|
3276
- | `label` | yes | string \| number | Label displayed in the cell header. String or number value |
3277
- | `props` | yes | [ObjectUIStatsProp](./types.md#objectuistatsprop) | Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens. |
3278
- | `renderer` | yes | "LABEL" | Renderer type for the cell value. LABEL renders a Label component. |
3279
- | `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
3280
-
3281
- No additional properties.
3282
-
3283
- ## ObjectUIStatsListVariant2
3284
-
3285
- ### Fields
3286
-
3287
- | Name | Required | Type | Description |
3288
- |---|---:|---|---|
3289
- | `label` | yes | string \| number | Label displayed in the cell header. String or number value |
3290
- | `props` | yes | [ObjectUIStatsProp](./types.md#objectuistatsprop) | Props passed to TextRenderer: { value, color? }. Color must be a Pebble text/icon color token. |
3291
- | `renderer` | no | "TEXT" | Renderer type for the cell value. TEXT displays plain text. Default: TEXT |
3292
- | `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
3293
-
3294
- No additional properties.
3295
-
3296
- ## ObjectUIStatsProp
3297
-
3298
- Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
3299
-
3300
- ### Fields
3301
-
3302
- | Name | Required | Type | Description |
3303
- |---|---:|---|---|
3304
- | `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Color scheme of the label. Default: NEUTRAL |
3305
- | `children` | no | string | Text content of the label |
3306
- | `leftIcon` | no | string \| [ObjectUIStatsLeftIcon](./types.md#objectuistatslefticon) | Icon displayed on the left side of the label |
3307
- | `maxWidth` | no | string | Maximum width CSS value for truncation |
3308
- | `rightIcon` | no | string \| [ObjectUIStatsRightIcon](./types.md#objectuistatsrighticon) | Icon displayed on the right side of the label |
3309
- | `size` | no | [ChipSize](./definitions.md#chipsize) | Size of the label. Default: LARGE |
3310
- | `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
3311
- | `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
3312
-
3313
- No additional properties.
3314
-
3315
- ## ObjectUIStatsRightIcon
3316
-
3317
- ### Fields
3318
-
3319
- | Name | Required | Type | Description |
3320
- |---|---:|---|---|
3321
- | `aria-describedby` | no | string | ID of element that describes this icon |
3322
- | `aria-label` | no | string | Accessible label for screen readers |
3323
- | `aria-labelledby` | no | string | ID of element that labels this icon |
3324
- | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
3325
- | `type` | yes | string | Icon type name |
3326
-
3327
- No additional properties.
3328
-
3329
- ## ObjectUIStatsTip
3330
-
3331
- ### Fields
3332
-
3333
- | Name | Required | Type | Description |
3334
- |---|---:|---|---|
3335
- | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style |
3336
- | `content` | yes | string | Tooltip content text |
3337
- | `isVisible` | no | boolean | Force tooltip to always be visible |
3338
- | `maxHeight` | no | number \| string | Maximum height for tooltip |
3339
- | `maxWidth` | no | number \| string | Maximum width for tooltip |
3340
- | `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement position |
3341
-
3342
- No additional properties.
3343
-
3344
- ## PageHeaderAction
3345
-
3346
- ### Fields
3347
-
3348
- | Name | Required | Type | Description |
3349
- |---|---:|---|---|
3350
- | `actionType` | no | [PageHeaderActionActionType](./definitions.md#pageheaderactionactiontype) | JSON-only extension. Type of action renderer. Default: button |
3351
- | `appearance` | no | [AppNavBarActionAppearance](./definitions.md#appnavbaractionappearance) | Button visual style. Default: PRIMARY |
3352
- | `icon` | no | string | Icon name from Icon.TYPES (e.g. ADD, EDIT_OUTLINE) |
3353
- | `id` | yes | string | Unique identifier for the action. Written to actionClickedId state on click |
3354
- | `isDisabled` | no | boolean | Disables the button. Default: false |
3355
- | `label` | yes | string | Button text |
3356
- | `size` | no | [ButtonSize](./definitions.md#buttonsize) | Button size. Default: M |
3357
- | `variant` | no | [ButtonVariant](./definitions.md#buttonvariant) | Button variant. Default: NORMAL |
3358
-
3359
- No additional properties.
3360
-
3361
- ## PaginateListList
3362
-
3363
- ### Fields
3364
-
3365
- | Name | Required | Type | Description |
3366
- |---|---:|---|---|
3367
- | `id` | yes | string \| number | Unique identifier for the item |
3368
- | `label` | yes | string | Display text for the item |
3369
-
3370
- No additional properties.
3371
-
3372
- ## PaneDimensionValue
3373
-
3374
- ### Fields
3375
-
3376
- | Name | Required | Type | Description |
3377
- |---|---:|---|---|
3378
- | `unit` | yes | "percent" | Percentage unit discriminator. |
3379
- | `value` | yes | number | Percentage value. |
3380
-
3381
- No additional properties.
3382
-
3383
- ## PaneSizingValue
3384
-
3385
- ### Fields
3386
-
3387
- | Name | Required | Type | Description |
3388
- |---|---:|---|---|
3389
- | `mode` | yes | "fixed" | Use an exact pane size. |
3390
- | `size` | yes | unknown | Fixed pane size. |
3391
-
3392
- No additional properties.
3393
-
3394
- ## PaneSizingValueVariant2
3395
-
3396
- ### Fields
3397
-
3398
- | Name | Required | Type | Description |
3399
- |---|---:|---|---|
3400
- | `maxSize` | no | unknown | Optional maximum content size. |
3401
- | `minSize` | no | unknown | Optional minimum content size. |
3402
- | `mode` | yes | "content" | Size the pane from its content. |
3403
-
3404
- No additional properties.
3405
-
3406
- ## PaneSizingValueVariant3
3407
-
3408
- ### Fields
3409
-
3410
- | Name | Required | Type | Description |
3411
- |---|---:|---|---|
3412
- | `growWeight` | no | number | Relative share of available growth. Default: 1. |
3413
- | `maxSize` | no | unknown | Optional maximum pane size. |
3414
- | `minSize` | no | unknown | Optional minimum pane size. |
3415
- | `mode` | yes | [PaneSizingValueVariant3Mode](./definitions.md#panesizingvaluevariant3mode) | Fill available space or allow user resizing. |
3416
- | `preferredSize` | yes | unknown | Preferred pane size. |
3417
- | `shrinkWeight` | no | number | Relative share of required shrinking. Default: 1. |
3418
-
3419
- No additional properties.
3420
-
3421
- ## PartnerCompany
3422
-
3423
- Partner company data for profile URL routing
3424
-
3425
- ### Fields
3426
-
3427
- _No fields._
3428
-
3429
- Additional properties: unknown.
3430
-
3431
- ## PasswordArg
3432
-
3433
- ### Fields
3434
-
3435
- _No fields._
3436
-
3437
- Additional properties: unknown.
3438
-
3439
- ## PasswordCheck
3440
-
3441
- ### Fields
3442
-
3443
- | Name | Required | Type | Description |
3444
- |---|---:|---|---|
3445
- | `args` | no | [PasswordArg](./types.md#passwordarg) | |
3446
- | `message` | yes | string | |
3447
- | `type` | yes | string | |
3448
-
3449
- No additional properties.
3450
-
3451
- ## PasswordStringPadding
3452
-
3453
- Pads input value with character until reaching maxLength
3454
-
3455
- ### Fields
3456
-
3457
- | Name | Required | Type | Description |
3458
- |---|---:|---|---|
3459
- | `character` | yes | string | Character to use for padding |
3460
- | `maxLength` | yes | number | Target length after padding |
3461
- | `position` | yes | [PanePin](./definitions.md#panepin) | Where to add padding: start or end |
3462
-
3463
- No additional properties.
3464
-
3465
- ## Payload
3466
-
3467
- ### Fields
3468
-
3469
- _No fields._
3470
-
3471
- Additional properties: unknown.
3472
-
3473
- ## PercentageArg
3474
-
3475
- ### Fields
3476
-
3477
- _No fields._
3478
-
3479
- Additional properties: unknown.
3480
-
3481
- ## PercentageCheck
3482
-
3483
- ### Fields
3484
-
3485
- | Name | Required | Type | Description |
3486
- |---|---:|---|---|
3487
- | `args` | no | [PercentageArg](./types.md#percentagearg) | |
3488
- | `message` | yes | string | |
3489
- | `type` | yes | string | |
3490
-
3491
- No additional properties.
3492
-
3493
- ## PhoneArg
3494
-
3495
- ### Fields
3496
-
3497
- _No fields._
3498
-
3499
- Additional properties: unknown.
3500
-
3501
- ## PhoneCheck
3502
-
3503
- ### Fields
3504
-
3505
- | Name | Required | Type | Description |
3506
- |---|---:|---|---|
3507
- | `args` | no | [PhoneArg](./types.md#phonearg) | |
3508
- | `message` | yes | string | |
3509
- | `type` | yes | string | |
3510
-
3511
- No additional properties.
3512
-
3513
- ## PhoneCountryCode
3514
-
3515
- Country-code dropdown configuration preserving the serializable CountryCodeProp shape
3516
-
3517
- ### Fields
3518
-
3519
- | Name | Required | Type | Description |
3520
- |---|---:|---|---|
3521
- | `name` | no | string | Name for the country-code select input |
3522
- | `aria-describedby` | no | string | ID of the element that describes the country-code dropdown |
3523
- | `aria-label` | no | string | Accessible label for the country-code dropdown |
3524
- | `aria-labelledby` | no | string | ID of the element that labels the country-code dropdown |
3525
- | `canClear` | no | boolean | Show clear button in the country-code dropdown |
3526
- | `defaultSearchQuery` | no | string | Initial search query for the country-code dropdown |
3527
- | `defaultValue` | no | string | Initial selected country code for the dropdown branch |
3528
- | `dropdownHeight` | no | number | Country-code dropdown menu height in pixels |
3529
- | `emptyListPlaceholder` | no | string \| [PhoneEmptyListPlaceholder](./types.md#phoneemptylistplaceholder) | Placeholder shown when the country-code dropdown list is empty |
3530
- | `fuseOptions` | no | [PhoneFuseOption](./types.md#phonefuseoption) | Fuse.js search options for the country-code dropdown |
3531
- | `id` | no | string | HTML id attribute for the country-code select input |
3532
- | `isDisabled` | no | boolean | Disables the country-code dropdown |
3533
- | `isMenuDefaultOpen` | no | boolean | If true, the country-code dropdown opens by default |
3534
- | `isPositionFixed` | no | boolean | Position the country-code dropdown relative to the viewport |
3535
- | `isReadOnly` | no | boolean | Makes the country-code dropdown read-only |
3536
- | `isRequired` | no | boolean | Marks the country-code dropdown as required |
3537
- | `maxHeight` | no | string \| number | Maximum dropdown height or chip container height as a CSS value |
3538
- | `placement` | no | [AppGroupSelectPlacement](./definitions.md#appgroupselectplacement) | Country-code dropdown placement. Default: bottom-start |
3539
- | `rows` | no | number | Minimum row count for the country-code dropdown |
3540
- | `scrollThreshold` | no | number | Extra pixels rendered above and below the viewport in paginated mode |
3541
- | `shouldFocusFirstElement` | no | boolean | Auto-focus the first dropdown item when the menu opens |
3542
- | `shouldShowSearchIcon` | no | boolean | Show the search icon inside the country-code dropdown |
3543
- | `shouldUsePortal` | no | boolean | Render the country-code dropdown in a React portal |
3544
- | `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Country-code dropdown size. Default: M |
3545
- | `theme` | no | [FormTimezoneTheme](./definitions.md#formtimezonetheme) | Country-code dropdown theme variant |
3546
- | `value` | no | string | Controlled selected country code for the dropdown branch |
3547
-
3548
- No additional properties.
3549
-
3550
- ## PhoneEmptyListPlaceholder
3551
-
3552
- ### Fields
3553
-
3554
- | Name | Required | Type | Description |
3555
- |---|---:|---|---|
3556
- | `onLoading` | no | string | Placeholder shown while the dropdown list is loading |
3557
- | `onNoSearchQuery` | no | string | Placeholder when no search query is entered |
3558
- | `onNoSearchResults` | no | string | Placeholder shown when no matching regions are found |
3559
-
3560
- No additional properties.
3561
-
3562
- ## PhoneFuseOption
3563
-
3564
- Fuse.js search options for the country-code dropdown
3565
-
3566
- ### Fields
3567
-
3568
- _No fields._
3569
-
3570
- Additional properties: unknown.
3571
-
3572
- ## PhoneStringPadding
3573
-
3574
- Pads input value with character until reaching maxLength
3575
-
3576
- ### Fields
3577
-
3578
- | Name | Required | Type | Description |
3579
- |---|---:|---|---|
3580
- | `character` | yes | string | Character to use for padding |
3581
- | `maxLength` | yes | number | Target length after padding |
3582
- | `position` | yes | [PanePin](./definitions.md#panepin) | Where to add padding: start or end |
3583
-
3584
- No additional properties.
3585
-
3586
- ## PopperProp
3587
-
3588
- Serializable popover options; middleware functions are not supported
3589
-
3590
- ### Fields
3591
-
3592
- | Name | Required | Type | Description |
3593
- |---|---:|---|---|
3594
- | `placement` | no | [FormTreeSelectPlacement](./definitions.md#formtreeselectplacement) | Popover placement |
3595
- | `shouldFlipIfNoSpace` | no | boolean | Whether the popover flips when there is not enough space |
3596
-
3597
- No additional properties.
3598
-
3599
- ## ProgressStepsStep
3600
-
3601
- ### Fields
3602
-
3603
- | Name | Required | Type | Description |
3604
- |---|---:|---|---|
3605
- | `hasError` | no | boolean | Marks the step as having an error |
3606
- | `icon` | no | string | Icon type from Icon.TYPES to display for the step |
3607
- | `isDisabled` | no | boolean | Disables the step |
3608
- | `subtitle` | no | string | Subtitle text for the step |
3609
- | `title` | no | string | Title text for the step |
3610
-
3611
- No additional properties.
3612
-
3613
- ## RadioArg
3614
-
3615
- ### Fields
3616
-
3617
- _No fields._
3618
-
3619
- Additional properties: unknown.
3620
-
3621
- ## RadioCheck
3622
-
3623
- ### Fields
3624
-
3625
- | Name | Required | Type | Description |
3626
- |---|---:|---|---|
3627
- | `args` | no | [RadioArg](./types.md#radioarg) | |
3628
- | `message` | yes | string | |
3629
- | `type` | yes | string | |
3630
-
3631
- No additional properties.
3632
-
3633
- ## RadioList
3634
-
3635
- ### Fields
3636
-
3637
- | Name | Required | Type | Description |
3638
- |---|---:|---|---|
3639
- | `isActive` | no | boolean | Controls focus state of the option |
3640
- | `isDisabled` | no | boolean | Disables this specific option |
3641
- | `label` | yes | string | Display text for the option |
3642
- | `secondaryLabel` | no | string | Secondary text below the option label |
3643
- | `tag` | no | string \| [RadioTag](./types.md#radiotag) | Optional tag/label displayed with the option |
3644
- | `tip` | no | string | Tooltip text shown on hover |
3645
- | `value` | yes | unknown | Value stored when option is selected |
3646
-
3647
- No additional properties.
3648
-
3649
- ## RadioTag
3650
-
3651
- ### Fields
3652
-
3653
- | Name | Required | Type | Description |
3654
- |---|---:|---|---|
3655
- | `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
3656
- | `label` | yes | string | Tag label text |
3657
-
3658
- No additional properties.
3659
-
3660
- ## RangeSliderArg
3661
-
3662
- ### Fields
3663
-
3664
- _No fields._
3665
-
3666
- Additional properties: unknown.
3667
-
3668
- ## RangeSliderCheck
3669
-
3670
- ### Fields
3671
-
3672
- | Name | Required | Type | Description |
3673
- |---|---:|---|---|
3674
- | `args` | no | [RangeSliderArg](./types.md#rangesliderarg) | |
3675
- | `message` | yes | string | |
3676
- | `type` | yes | string | |
3677
-
3678
- No additional properties.
3679
-
3680
- ## RangeSliderMark
3681
-
3682
- Marks on slider as {position: label} object (e.g. {10: "10$", 50: "50$"})
3683
-
3684
- ### Fields
3685
-
3686
- _No fields._
3687
-
3688
- Additional properties: string.
3689
-
3690
- ## Role
3691
-
3692
- ### Fields
3693
-
3694
- | Name | Required | Type | Description |
3695
- |---|---:|---|---|
3696
- | `fullName` | no | string | Display name |
3697
- | `id` | no | string | Unique identifier |
3698
- | `image` | no | string | Avatar image URL |
3699
- | `inviteEmail` | no | string | Invite email (fallback label if fullName/workEmail absent) |
3700
- | `partnerCompany` | no | [PartnerCompany](./types.md#partnercompany) | Partner company data for profile URL routing |
3701
- | `user_cache` | no | [User_cache](./types.md#usercache) | User cache data with smallPhoto fallback |
3702
- | `workEmail` | no | string | Work email |
3703
-
3704
- No additional properties.
3705
-
3706
- ## Row
3707
-
3708
- ### Fields
3709
-
3710
- _No fields._
3711
-
3712
- Additional properties: string | number | boolean | null.
3713
-
3714
- ## RowAction
3715
-
3716
- ### Fields
3717
-
3718
- | Name | Required | Type | Description |
3719
- |---|---:|---|---|
3720
- | `appearance` | no | [RowActionAppearance](./definitions.md#rowactionappearance) | Button appearance. Defaults to GHOST. |
3721
- | `icon` | no | string | Icon name from Icon.TYPES, such as EDIT_OUTLINE. |
3722
- | `iconColor` | no | string | Icon color token or CSS color string. |
3723
- | `id` | yes | string | Unique identifier for the row action. |
3724
- | `isDisabled` | no | boolean | Disable the action for every row. |
3725
- | `isHidden` | no | boolean | Hide the action for every row. |
3726
- | `label` | yes | string | Visible label for the row action. |
3727
- | `placement` | no | [RowActionPlacement](./definitions.md#rowactionplacement) | Where the action is rendered. Defaults to the Grid row-actions behavior. |
3728
- | `tip` | no | string | Tooltip text for the action. |
3729
- | `type` | no | [RowActionType](./definitions.md#rowactiontype) | Button style to render. Defaults to Button. |
3730
-
3731
- No additional properties.
3732
-
3733
- ## RunActionsParamsAction
3734
-
3735
- ### Fields
3736
-
3737
- | Name | Required | Type | Description |
3738
- |---|---:|---|---|
3739
- | `action` | yes | string | |
3740
- | `params` | no | [RunActionsParamsParam](./types.md#runactionsparamsparam) | |
3741
-
3742
- No additional properties.
3743
-
3744
- ## RunActionsParamsParam
3745
-
3746
- ### Fields
3747
-
3748
- _No fields._
3749
-
3750
- Additional properties: unknown.
3751
-
3752
- ## Segment
3753
-
3754
- ### Fields
3755
-
3756
- | Name | Required | Type | Description |
3757
- |---|---:|---|---|
3758
- | `segmentColor` | yes | [SegmentSegmentColor](./definitions.md#segmentsegmentcolor) \| [SegmentSegmentColor](./definitions.md#segmentsegmentcolor) | Pebble chart color token, or semantic color token for status-related visualizations. |
3759
- | `value` | yes | number | Numeric value of this segment |
3760
-
3761
- No additional properties.
3762
-
3763
- ## SegmentedControlArg
3764
-
3765
- ### Fields
3766
-
3767
- _No fields._
3768
-
3769
- Additional properties: unknown.
3770
-
3771
- ## SegmentedControlCheck
3772
-
3773
- ### Fields
3774
-
3775
- | Name | Required | Type | Description |
3776
- |---|---:|---|---|
3777
- | `args` | no | [SegmentedControlArg](./types.md#segmentedcontrolarg) | |
3778
- | `message` | yes | string | |
3779
- | `type` | yes | string | |
3780
-
3781
- No additional properties.
3782
-
3783
- ## SegmentedControlList
3784
-
3785
- ### Fields
3786
-
3787
- | Name | Required | Type | Description |
3788
- |---|---:|---|---|
3789
- | `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style for this specific option |
3790
- | `aria-label` | no | string | Accessible label, required if label is not provided (e.g. for icon-only items) |
3791
- | `icon` | no | string | Icon to display for icon-only items. Requires aria-label or label for accessibility |
3792
- | `isDisabled` | no | boolean | Disables this specific option |
3793
- | `label` | no | string | Display text for the option |
3794
- | `tip` | no | [SegmentedControlTip](./types.md#segmentedcontroltip) | Tooltip to show on hover for this option |
3795
- | `value` | yes | string | Value stored when option is selected |
3796
-
3797
- No additional properties.
3798
-
3799
- ## SegmentedControlOption
3800
-
3801
- ### Fields
3802
-
3803
- | Name | Required | Type | Description |
3804
- |---|---:|---|---|
3805
- | `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style for this specific option |
3806
- | `aria-label` | no | string | Accessible label, required if label is not provided (e.g. for icon-only items) |
3807
- | `icon` | no | string | Icon to display for icon-only items. Requires aria-label or label for accessibility |
3808
- | `isDisabled` | no | boolean | Disables this specific option |
3809
- | `label` | no | string | Display text for the option |
3810
- | `tip` | no | [SegmentedControlTip](./types.md#segmentedcontroltip) | Tooltip to show on hover for this option |
3811
- | `value` | yes | string | Value stored when option is selected |
3812
-
3813
- No additional properties.
3814
-
3815
- ## SegmentedControlRangeLabel
3816
-
3817
- Labels to display at the start and end of the control range
3818
-
3819
- ### Fields
3820
-
3821
- | Name | Required | Type | Description |
3822
- |---|---:|---|---|
3823
- | `end` | yes | string | Label at the end of the range |
3824
- | `start` | yes | string | Label at the start of the range |
3825
-
3826
- No additional properties.
3827
-
3828
- ## SegmentedControlTip
3829
-
3830
- Tooltip to show on hover for this option
3831
-
3832
- ### Fields
3833
-
3834
- | Name | Required | Type | Description |
3835
- |---|---:|---|---|
3836
- | `content` | yes | string | Tooltip text content |
3837
-
3838
- No additional properties.
3839
-
3840
- ## SelectableGroupArg
3841
-
3842
- ### Fields
3843
-
3844
- _No fields._
3845
-
3846
- Additional properties: unknown.
3847
-
3848
- ## SelectableGroupCheck
3849
-
3850
- ### Fields
3851
-
3852
- | Name | Required | Type | Description |
3853
- |---|---:|---|---|
3854
- | `args` | no | [SelectableGroupArg](./types.md#selectablegrouparg) | |
3855
- | `message` | yes | string | |
3856
- | `type` | yes | string | |
3857
-
3858
- No additional properties.
3859
-
3860
- ## SelectableGroupList
3861
-
3862
- ### Fields
3863
-
3864
- _No fields._
3865
-
3866
- Additional properties: unknown.
3867
-
3868
- ## SelectableMenuList
3869
-
3870
- ### Fields
3871
-
3872
- | Name | Required | Type | Description |
3873
- |---|---:|---|---|
3874
- | `isDisabled` | no | boolean | Disables this option |
3875
- | `label` | yes | string | Display text for the option |
3876
- | `value` | yes | string | Unique value for the option |
3877
-
3878
- No additional properties.
3879
-
3880
- ## SelectArg
3881
-
3882
- ### Fields
3883
-
3884
- _No fields._
3885
-
3886
- Additional properties: unknown.
3887
-
3888
- ## SelectAvatarProp
3889
-
3890
- Avatar configuration for the option
3891
-
3892
- ### Fields
3893
-
3894
- | Name | Required | Type | Description |
3895
- |---|---:|---|---|
3896
- | `image` | no | string | URL of avatar image |
3897
- | `title` | no | string | Title/alt text for avatar |
3898
-
3899
- No additional properties.
3900
-
3901
- ## SelectCheck
3902
-
3903
- ### Fields
3904
-
3905
- | Name | Required | Type | Description |
3906
- |---|---:|---|---|
3907
- | `args` | no | [SelectArg](./types.md#selectarg) | |
3908
- | `message` | yes | string | |
3909
- | `type` | yes | string | |
3910
-
3911
- No additional properties.
3912
-
3913
- ## SelectedEmoji
3914
-
3915
- Bindable selected emoji data written before the change event emits
3916
-
3917
- ### Fields
3918
-
3919
- | Name | Required | Type | Description |
3920
- |---|---:|---|---|
3921
- | `name` | yes | string | Descriptive emoji name |
3922
- | `id` | yes | string | Unique identifier for the emoji |
3923
- | `keywords` | yes | string[] | Search keywords for the emoji |
3924
- | `native` | yes | string | Native emoji character |
3925
- | `shortcodes` | yes | string | Short-form emoji representation |
3926
- | `unified` | yes | string | Unicode representation for the emoji |
3927
-
3928
- No additional properties.
3929
-
3930
- ## SelectEmptyListPlaceholder
3931
-
3932
- ### Fields
3933
-
3934
- | Name | Required | Type | Description |
3935
- |---|---:|---|---|
3936
- | `onLoading` | no | string | Placeholder shown while list is loading |
3937
- | `onNoSearchQuery` | no | string | Placeholder when no search query entered |
3938
- | `onNoSearchResults` | no | string | Placeholder when search returns no results |
3939
-
3940
- No additional properties.
3941
-
3942
- ## SelectFooter
3943
-
3944
- Fixed footer at bottom of dropdown menu
3945
-
3946
- ### Fields
3947
-
3948
- | Name | Required | Type | Description |
3949
- |---|---:|---|---|
3950
- | `label` | yes | string | Footer link text |
3951
- | `onClick` | yes | string | Event name to emit when footer is clicked |
3952
-
3953
- No additional properties.
3954
-
3955
- ## SelectFuseOption
3956
-
3957
- Fuse.js search options for customizing fuzzy search behavior
3958
-
3959
- ### Fields
3960
-
3961
- _No fields._
3962
-
3963
- Additional properties: unknown.
3964
-
3965
- ## SelectList
3966
-
3967
- ### Fields
3968
-
3969
- | Name | Required | Type | Description |
3970
- |---|---:|---|---|
3971
- | `avatarProps` | no | [SelectAvatarProp](./types.md#selectavatarprop) | Avatar configuration for the option |
3972
- | `description` | no | string | Description text shown below the label |
3973
- | `flag` | no | string | Two-letter country code for flag icon (e.g. "US", "IN") |
3974
- | `isDisabled` | no | boolean | Disables this specific option |
3975
- | `isRecommended` | no | boolean | Marks option as recommended with a badge |
3976
- | `isSeparator` | no | boolean | Renders as a visual separator instead of selectable option |
3977
- | `label` | yes | string | Display text for the option |
3978
- | `labelIcon` | no | string | Icon glyph name to show next to the label |
3979
- | `leftIconType` | no | string | Icon glyph name to show on the left. E.g. "CHECK_CIRCLE_OUTLINE" |
3980
- | `quaternaryLabel` | no | string | Quaternary label shown below tertiary label |
3981
- | `rightLabel` | no | string | Label aligned to the right side of the option |
3982
- | `secondaryLabel` | no | string | Secondary label shown below the main label |
3983
- | `tertiaryLabel` | no | string | Tertiary label shown below secondary label |
3984
- | `value` | yes | unknown | Value stored when option is selected |
3985
-
3986
- No additional properties.
3987
-
3988
- ## SelectOption
3989
-
3990
- ### Fields
3991
-
3992
- | Name | Required | Type | Description |
3993
- |---|---:|---|---|
3994
- | `avatarProps` | no | [SelectAvatarProp](./types.md#selectavatarprop) | Avatar configuration for the option |
3995
- | `description` | no | string | Description text shown below the label |
3996
- | `flag` | no | string | Two-letter country code for flag icon (e.g. "US", "IN") |
3997
- | `isDisabled` | no | boolean | Disables this specific option |
3998
- | `isRecommended` | no | boolean | Marks option as recommended with a badge |
3999
- | `isSeparator` | no | boolean | Renders as a visual separator instead of selectable option |
4000
- | `label` | yes | string | Display text for the option |
4001
- | `labelIcon` | no | string | Icon glyph name to show next to the label |
4002
- | `leftIconType` | no | string | Icon glyph name to show on the left. E.g. "CHECK_CIRCLE_OUTLINE" |
4003
- | `quaternaryLabel` | no | string | Quaternary label shown below tertiary label |
4004
- | `rightLabel` | no | string | Label aligned to the right side of the option |
4005
- | `secondaryLabel` | no | string | Secondary label shown below the main label |
4006
- | `tertiaryLabel` | no | string | Tertiary label shown below secondary label |
4007
- | `value` | yes | unknown | Value stored when option is selected |
4008
-
4009
- No additional properties.
4010
-
4011
- ## SerializableValueValue
4012
-
4013
- ### Fields
4014
-
4015
- _No fields._
4016
-
4017
- Additional properties: unknown.
4018
-
4019
- ## ShouldShowHeader
4020
-
4021
- ### Fields
4022
-
4023
- | Name | Required | Type | Description |
4024
- |---|---:|---|---|
4025
- | `headerActions` | yes | boolean | Show month/year navigation |
4026
-
4027
- No additional properties.
4028
-
4029
- ## ShowMoreValue
4030
-
4031
- Configuration for show more behavior
4032
-
4033
- ### Fields
4034
-
4035
- | Name | Required | Type | Description |
4036
- |---|---:|---|---|
4037
- | `size` | yes | number | Number of items to show initially before "show more" |
4038
-
4039
- No additional properties.
4040
-
4041
- ## SignatureArg
4042
-
4043
- ### Fields
4044
-
4045
- _No fields._
4046
-
4047
- Additional properties: unknown.
4048
-
4049
- ## SignatureCheck
4050
-
4051
- ### Fields
4052
-
4053
- | Name | Required | Type | Description |
4054
- |---|---:|---|---|
4055
- | `args` | no | [SignatureArg](./types.md#signaturearg) | |
4056
- | `message` | yes | string | |
4057
- | `type` | yes | string | |
4058
-
4059
- No additional properties.
4060
-
4061
- ## SinArg
4062
-
4063
- ### Fields
4064
-
4065
- _No fields._
4066
-
4067
- Additional properties: unknown.
4068
-
4069
- ## SinCheck
4070
-
4071
- ### Fields
4072
-
4073
- | Name | Required | Type | Description |
4074
- |---|---:|---|---|
4075
- | `args` | no | [SinArg](./types.md#sinarg) | |
4076
- | `message` | yes | string | |
4077
- | `type` | yes | string | |
4078
-
4079
- No additional properties.
4080
-
4081
- ## SkipButton
4082
-
4083
- Secondary skip action. Click emits the skip event.
4084
-
4085
- ### Fields
4086
-
4087
- | Name | Required | Type | Description |
4088
- |---|---:|---|---|
4089
- | `label` | no | string | Skip button label. Defaults to the Pebble skip label |
4090
-
4091
- No additional properties.
4092
-
4093
- ## Slide
4094
-
4095
- ### Fields
4096
-
4097
- | Name | Required | Type | Description |
4098
- |---|---:|---|---|
4099
- | `alt` | no | string | Alt text for the slide image |
4100
- | `heading` | yes | string | Slide heading text |
4101
- | `img` | yes | string | Slide image URL |
4102
-
4103
- No additional properties.
4104
-
4105
- ## SliderArg
4106
-
4107
- ### Fields
4108
-
4109
- _No fields._
4110
-
4111
- Additional properties: unknown.
4112
-
4113
- ## SliderCheck
4114
-
4115
- ### Fields
4116
-
4117
- | Name | Required | Type | Description |
4118
- |---|---:|---|---|
4119
- | `args` | no | [SliderArg](./types.md#sliderarg) | |
4120
- | `message` | yes | string | |
4121
- | `type` | yes | string | |
4122
-
4123
- No additional properties.
4124
-
4125
- ## SliderMark
4126
-
4127
- Named marks on the slider track. Keys are numeric positions, values are labels
4128
-
4129
- ### Fields
4130
-
4131
- _No fields._
4132
-
4133
- Additional properties: string.
4134
-
4135
- ## Src
4136
-
4137
- ### Fields
4138
-
4139
- | Name | Required | Type | Description |
4140
- |---|---:|---|---|
4141
- | `dark` | no | string | |
4142
- | `light` | no | string | |
4143
-
4144
- No additional properties.
4145
-
4146
- ## SsnArg
4147
-
4148
- ### Fields
4149
-
4150
- _No fields._
4151
-
4152
- Additional properties: unknown.
4153
-
4154
- ## SsnCheck
4155
-
4156
- ### Fields
4157
-
4158
- | Name | Required | Type | Description |
4159
- |---|---:|---|---|
4160
- | `args` | no | [SsnArg](./types.md#ssnarg) | |
4161
- | `message` | yes | string | |
4162
- | `type` | yes | string | |
4163
-
4164
- No additional properties.
4165
-
4166
- ## StandAloneStep
4167
-
4168
- ### Fields
4169
-
4170
- | Name | Required | Type | Description |
4171
- |---|---:|---|---|
4172
- | `avatar` | no | [StepperAvatar](./types.md#stepperavatar) | Avatar configuration to display with the step. Supports image URLs |
4173
- | `badge` | no | [StepperBadge](./types.md#stepperbadge) | Badge configuration to display alongside the step title |
4174
- | `description` | no | string | Optional step description |
4175
- | `href` | no | string | URL for the step. Renders the step as an anchor tag with this href (semantic HTML only) |
4176
- | `status` | no | [StandAloneStepStatus](./definitions.md#standalonestepstatus) | Step status indicator |
4177
- | `title` | yes | string | Step title text |
4178
-
4179
- No additional properties.
4180
-
4181
- ## StepperAvatar
4182
-
4183
- Avatar configuration to display with the step. Supports image URLs
4184
-
4185
- ### Fields
4186
-
4187
- | Name | Required | Type | Description |
4188
- |---|---:|---|---|
4189
- | `imageUrl` | no | string | URL of the avatar image |
4190
- | `type` | no | [StepperAvatarType](./definitions.md#stepperavatartype) | Avatar type |
4191
-
4192
- No additional properties.
4193
-
4194
- ## StepperBadge
4195
-
4196
- Badge configuration to display alongside the step title
4197
-
4198
- ### Fields
4199
-
4200
- | Name | Required | Type | Description |
4201
- |---|---:|---|---|
4202
- | `appearance` | no | [BadgeAppearance](./definitions.md#badgeappearance) | Badge color appearance |
4203
- | `aria-label` | no | string | Accessibility label for the badge |
4204
- | `text` | yes | string | Badge text content |
4205
-
4206
- No additional properties.
4207
-
4208
- ## StepperStep
4209
-
4210
- ### Fields
4211
-
4212
- | Name | Required | Type | Description |
4213
- |---|---:|---|---|
4214
- | `avatar` | no | [StepperAvatar](./types.md#stepperavatar) | Avatar configuration to display with the step. Supports image URLs |
4215
- | `badge` | no | [StepperBadge](./types.md#stepperbadge) | Badge configuration to display alongside the step title |
4216
- | `description` | no | string | Optional step description |
4217
- | `href` | no | string | URL for the step. Renders the step as an anchor tag with this href (semantic HTML only) |
4218
- | `status` | no | [StandAloneStepStatus](./definitions.md#standalonestepstatus) | Step status indicator |
4219
- | `title` | yes | string | Step title text |
4220
-
4221
- No additional properties.
4222
-
4223
- ## SubmitButtonProp
4224
-
4225
- Configuration for the form submit button
4226
-
4227
- ### Fields
4228
-
4229
- | Name | Required | Type | Description |
4230
- |---|---:|---|---|
4231
- | `icon` | no | string \| [FormIcon](./types.md#formicon) | Icon to show in the submit button |
4232
- | `isDisabled` | no | boolean | Disable submit button |
4233
- | `isFluid` | no | boolean | Stretch submit button to fill width |
4234
- | `isLoading` | no | boolean | Show loading spinner on submit button. Bind to state for manual control. |
4235
- | `label` | no | string | Submit button label |
4236
- | `size` | no | [ButtonSize](./definitions.md#buttonsize) | Submit button size |
4237
-
4238
- No additional properties.
4239
-
4240
- ## SubmitFormDataParamsQueryParam
4241
-
4242
- ### Fields
4243
-
4244
- _No fields._
4245
-
4246
- Additional properties: unknown.
4247
-
4248
- ## SupportButtonTo
4249
-
4250
- ### Fields
4251
-
4252
- | Name | Required | Type | Description |
4253
- |---|---:|---|---|
4254
- | `openInNewTab` | no | boolean | Open link in new tab. Default: false |
4255
- | `path` | yes | string | URL path for navigation |
4256
-
4257
- No additional properties.
4258
-
4259
- ## SupportLink
4260
-
4261
- ### Fields
4262
-
4263
- | Name | Required | Type | Description |
4264
- |---|---:|---|---|
4265
- | `href` | no | string | URL for the support/help link |
4266
- | `icon` | no | string | Pebble icon name for the support link |
4267
- | `text` | no | string | Visible support link text override |
4268
-
4269
- No additional properties.
4270
-
4271
- ## SurveyArg
4272
-
4273
- ### Fields
4274
-
4275
- _No fields._
4276
-
4277
- Additional properties: unknown.
4278
-
4279
- ## SurveyCheck
4280
-
4281
- ### Fields
4282
-
4283
- | Name | Required | Type | Description |
4284
- |---|---:|---|---|
4285
- | `args` | no | [SurveyArg](./types.md#surveyarg) | |
4286
- | `message` | yes | string | |
4287
- | `type` | yes | string | |
4288
-
4289
- No additional properties.
4290
-
4291
- ## SurveyList
4292
-
4293
- ### Fields
4294
-
4295
- | Name | Required | Type | Description |
4296
- |---|---:|---|---|
4297
- | `icon` | no | string | Pebble icon name displayed for the option |
4298
- | `isDisabled` | no | boolean | Disable this specific option |
4299
- | `label` | no | string \| number | Display label for the option |
4300
- | `selectionColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Override selected surface color token for this option |
4301
- | `value` | yes | string \| number | Value when selected |
4302
-
4303
- No additional properties.
4304
-
4305
- ## SurveyRangeLabel
4306
-
4307
- Labels for lowest and highest options
4308
-
4309
- ### Fields
4310
-
4311
- | Name | Required | Type | Description |
4312
- |---|---:|---|---|
4313
- | `lower` | yes | string | Label for the lowest option |
4314
- | `upper` | yes | string | Label for the highest option |
4315
-
4316
- No additional properties.
4317
-
4318
- ## SwitchArg
4319
-
4320
- ### Fields
4321
-
4322
- _No fields._
4323
-
4324
- Additional properties: unknown.
4325
-
4326
- ## SwitchCheck
4327
-
4328
- ### Fields
4329
-
4330
- | Name | Required | Type | Description |
4331
- |---|---:|---|---|
4332
- | `args` | no | [SwitchArg](./types.md#switcharg) | |
4333
- | `message` | yes | string | |
4334
- | `type` | yes | string | |
4335
-
4336
- No additional properties.
4337
-
4338
- ## SwitchTip
4339
-
4340
- ### Fields
4341
-
4342
- | Name | Required | Type | Description |
4343
- |---|---:|---|---|
4344
- | `content` | yes | string | Tooltip text content |
4345
- | `placement` | no | [SwitchTipPlacement](./definitions.md#switchtipplacement) | Tooltip placement relative to the switch |
4346
-
4347
- No additional properties.
4348
-
4349
- ## TabBadge
4350
-
4351
- Badge to display on the tab
4352
-
4353
- ### Fields
4354
-
4355
- | Name | Required | Type | Description |
4356
- |---|---:|---|---|
4357
- | `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 |
4358
- | `text` | yes | string | Text to display in the badge |
4359
-
4360
- No additional properties.
4361
-
4362
- ## TabItem
4363
-
4364
- ### Fields
4365
-
4366
- | Name | Required | Type | Description |
4367
- |---|---:|---|---|
4368
- | `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the tab |
4369
- | `href` | no | string | Semantic href for LINK tabs; navigation is prevented by Pebble Tabs |
4370
- | `icon` | no | string | Icon name for the tab (e.g., FOLDER_OUTLINE) |
4371
- | `isDisabled` | no | boolean | Whether this tab is disabled |
4372
- | `tip` | no | string \| [TabTip](./types.md#tabtip) | Tooltip to show on hover |
4373
- | `title` | yes | string | Display text for the tab |
4374
- | `value` | yes | unknown | JSON-only tab value stored when the tab changes |
4375
-
4376
- No additional properties.
4377
-
4378
- ## TabList
4379
-
4380
- ### Fields
4381
-
4382
- | Name | Required | Type | Description |
4383
- |---|---:|---|---|
4384
- | `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the link tab |
4385
- | `links` | no | [LinkValue](./types.md#linkvalue)[] | Nested link tabs for vertical LINK tabs |
4386
- | `title` | yes | string | Display text for the link-style tab |
4387
-
4388
- No additional properties.
4389
-
4390
- ## TabTip
4391
-
4392
- ### Fields
4393
-
4394
- | Name | Required | Type | Description |
4395
- |---|---:|---|---|
4396
- | `content` | yes | string | Tip content text |
4397
- | `testId` | no | string | Test ID for the tip |
4398
-
4399
- No additional properties.
4400
-
4401
- ## TextareaArg
4402
-
4403
- ### Fields
4404
-
4405
- _No fields._
4406
-
4407
- Additional properties: unknown.
4408
-
4409
- ## TextareaCheck
4410
-
4411
- ### Fields
4412
-
4413
- | Name | Required | Type | Description |
4414
- |---|---:|---|---|
4415
- | `args` | no | [TextareaArg](./types.md#textareaarg) | |
4416
- | `message` | yes | string | |
4417
- | `type` | yes | string | |
4418
-
4419
- No additional properties.
4420
-
4421
- ## TextAutoSuggestArg
4422
-
4423
- ### Fields
4424
-
4425
- _No fields._
4426
-
4427
- Additional properties: unknown.
4428
-
4429
- ## TextAutoSuggestCheck
4430
-
4431
- ### Fields
4432
-
4433
- | Name | Required | Type | Description |
4434
- |---|---:|---|---|
4435
- | `args` | no | [TextAutoSuggestArg](./types.md#textautosuggestarg) | |
4436
- | `message` | yes | string | |
4437
- | `type` | yes | string | |
4438
-
4439
- No additional properties.
4440
-
4441
- ## TextAutoSuggestFuseOption
4442
-
4443
- Fuse.js search options for customizing suggestion filtering
4444
-
4445
- ### Fields
4446
-
4447
- _No fields._
4448
-
4449
- Additional properties: unknown.
4450
-
4451
- ## TextAutoSuggestList
4452
-
4453
- ### Fields
4454
-
4455
- | Name | Required | Type | Description |
4456
- |---|---:|---|---|
4457
- | `label` | yes | string | Display text for the suggestion |
4458
- | `value` | yes | string \| number | Value stored when suggestion is selected |
4459
-
4460
- No additional properties.
4461
-
4462
- ## TextAutoSuggestStringPadding
4463
-
4464
- Pads input value with character until reaching maxLength
4465
-
4466
- ### Fields
4467
-
4468
- | Name | Required | Type | Description |
4469
- |---|---:|---|---|
4470
- | `character` | yes | string | Character to use for padding |
4471
- | `maxLength` | yes | number | Target length after padding |
4472
- | `position` | yes | [PanePin](./definitions.md#panepin) | Where to add padding: start or end |
4473
-
4474
- No additional properties.
4475
-
4476
- ## TextInputArg
4477
-
4478
- ### Fields
4479
-
4480
- _No fields._
4481
-
4482
- Additional properties: unknown.
4483
-
4484
- ## TextInputCheck
4485
-
4486
- ### Fields
4487
-
4488
- | Name | Required | Type | Description |
4489
- |---|---:|---|---|
4490
- | `args` | no | [TextInputArg](./types.md#textinputarg) | |
4491
- | `message` | yes | string | |
4492
- | `type` | yes | string | |
4493
-
4494
- No additional properties.
4495
-
4496
- ## TextInputStringPadding
4497
-
4498
- Pads input value with character until reaching maxLength
4499
-
4500
- ### Fields
4501
-
4502
- | Name | Required | Type | Description |
4503
- |---|---:|---|---|
4504
- | `character` | yes | string | Character to use for padding |
4505
- | `maxLength` | yes | number | Target length after padding |
4506
- | `position` | yes | [PanePin](./definitions.md#panepin) | Where to add padding: start or end |
4507
-
4508
- No additional properties.
4509
-
4510
- ## TimeArg
4511
-
4512
- ### Fields
4513
-
4514
- _No fields._
4515
-
4516
- Additional properties: unknown.
4517
-
4518
- ## TimeCheck
4519
-
4520
- ### Fields
4521
-
4522
- | Name | Required | Type | Description |
4523
- |---|---:|---|---|
4524
- | `args` | no | [TimeArg](./types.md#timearg) | |
4525
- | `message` | yes | string | |
4526
- | `type` | yes | string | |
4527
-
4528
- No additional properties.
4529
-
4530
- ## TimeProp
4531
-
4532
- Configuration for time picker. Sets initial time value independently of date input
4533
-
4534
- ### Fields
4535
-
4536
- | Name | Required | Type | Description |
4537
- |---|---:|---|---|
4538
- | `defaultValue` | yes | string | Default time as ISO string when no date is selected |
4539
-
4540
- No additional properties.
4541
-
4542
- ## TimeRangeArg
4543
-
4544
- ### Fields
4545
-
4546
- _No fields._
4547
-
4548
- Additional properties: unknown.
4549
-
4550
- ## TimeRangeCheck
4551
-
4552
- ### Fields
4553
-
4554
- | Name | Required | Type | Description |
4555
- |---|---:|---|---|
4556
- | `args` | no | [TimeRangeArg](./types.md#timerangearg) | |
4557
- | `message` | yes | string | |
4558
- | `type` | yes | string | |
4559
-
4560
- No additional properties.
4561
-
4562
- ## TimeRangeShouldAllowTimeSelection
4563
-
4564
- ### Fields
4565
-
4566
- | Name | Required | Type | Description |
4567
- |---|---:|---|---|
4568
- | `reference` | no | string | Reference ISO time for period labels |
4569
-
4570
- No additional properties.
4571
-
4572
- ## TimeShouldAllowTimeSelection
4573
-
4574
- ### Fields
4575
-
4576
- | Name | Required | Type | Description |
4577
- |---|---:|---|---|
4578
- | `reference` | no | string | Reference ISO time for period labels |
4579
-
4580
- No additional properties.
4581
-
4582
- ## TimeTimezone
4583
-
4584
- ### Fields
4585
-
4586
- | Name | Required | Type | Description |
4587
- |---|---:|---|---|
4588
- | `name` | yes | string | Input name for the timezone selector |
4589
- | `isRequired` | no | boolean | Marks the timezone selector as required |
4590
- | `value` | no | string | Selected timezone value |
4591
-
4592
- No additional properties.
4593
-
4594
- ## TimezoneArg
4595
-
4596
- ### Fields
4597
-
4598
- _No fields._
4599
-
4600
- Additional properties: unknown.
4601
-
4602
- ## TimezoneCheck
4603
-
4604
- ### Fields
4605
-
4606
- | Name | Required | Type | Description |
4607
- |---|---:|---|---|
4608
- | `args` | no | [TimezoneArg](./types.md#timezonearg) | |
4609
- | `message` | yes | string | |
4610
- | `type` | yes | string | |
4611
-
4612
- No additional properties.
4613
-
4614
- ## Title
4615
-
4616
- ### Fields
4617
-
4618
- | Name | Required | Type | Description |
4619
- |---|---:|---|---|
4620
- | `kind` | yes | "BREADCRUMB" | Render the drawer title as a Breadcrumb |
4621
- | `props` | yes | [DrawerProp](./types.md#drawerprop) | Breadcrumb props for the drawer title |
4622
-
4623
- No additional properties.
4624
-
4625
- ## TreeArg
4626
-
4627
- ### Fields
4628
-
4629
- _No fields._
4630
-
4631
- Additional properties: unknown.
4632
-
4633
- ## TreeCheck
4634
-
4635
- ### Fields
4636
-
4637
- | Name | Required | Type | Description |
4638
- |---|---:|---|---|
4639
- | `args` | no | [TreeArg](./types.md#treearg) | |
4640
- | `message` | yes | string | |
4641
- | `type` | yes | string | |
4642
-
4643
- No additional properties.
4644
-
4645
- ## TreeDisabledInfo
4646
-
4647
- ### Fields
4648
-
4649
- | Name | Required | Type | Description |
4650
- |---|---:|---|---|
4651
- | `content` | yes | string | Tooltip content text |
4652
- | `isMobileSupported` | no | boolean | Show tooltip on mobile devices |
4653
- | `maxHeight` | no | number \| string | Maximum tooltip height |
4654
- | `maxWidth` | no | number \| string | Maximum tooltip width |
4655
-
4656
- No additional properties.
4657
-
4658
- ## TreeFooter
4659
-
4660
- Fixed footer with clickable action at bottom of tree
4661
-
4662
- ### Fields
4663
-
4664
- | Name | Required | Type | Description |
4665
- |---|---:|---|---|
4666
- | `label` | yes | string | Footer button text |
4667
-
4668
- No additional properties.
4669
-
4670
- ## TreeFuseOption
4671
-
4672
- Fuse.js search options for customizing search behavior
4673
-
4674
- ### Fields
4675
-
4676
- _No fields._
4677
-
4678
- Additional properties: unknown.
4679
-
4680
- ## TreeList
4681
-
4682
- ### Fields
4683
-
4684
- | Name | Required | Type | Description |
4685
- |---|---:|---|---|
4686
- | `disabledInfo` | no | string \| [TreeDisabledInfo](./types.md#treedisabledinfo) | Tooltip shown when item is disabled |
4687
- | `isDisabled` | no | boolean | Disable this item |
4688
- | `isLeaf` | no | boolean | Marks the item as a leaf node |
4689
- | `label` | yes | string | Display label for the item |
4690
- | `parent` | no | string | Parent item value, null for root items |
4691
- | `secondaryLabel` | no | string | Supporting text below the label |
4692
- | `tag` | no | string \| [TreeTag](./types.md#treetag) | Chip/tag to display next to the label |
4693
- | `value` | yes | string | Unique identifier for the item |
4694
-
4695
- No additional properties.
4696
-
4697
- ## TreeSelectArg
4698
-
4699
- ### Fields
4700
-
4701
- _No fields._
4702
-
4703
- Additional properties: unknown.
4704
-
4705
- ## TreeSelectCheck
4706
-
4707
- ### Fields
4708
-
4709
- | Name | Required | Type | Description |
4710
- |---|---:|---|---|
4711
- | `args` | no | [TreeSelectArg](./types.md#treeselectarg) | |
4712
- | `message` | yes | string | |
4713
- | `type` | yes | string | |
4714
-
4715
- No additional properties.
4716
-
4717
- ## TreeSelectFuseOption
4718
-
4719
- Fuse.js search configuration. Default: { keys: ["label", "name"] }
4720
-
4721
- ### Fields
4722
-
4723
- _No fields._
4724
-
4725
- Additional properties: unknown.
4726
-
4727
- ## TreeSelectList
4728
-
4729
- ### Fields
4730
-
4731
- | Name | Required | Type | Description |
4732
- |---|---:|---|---|
4733
- | `isDisabled` | no | boolean | Disable this item |
4734
- | `isLeaf` | no | boolean | Marks the item as a leaf node |
4735
- | `label` | yes | string | Display label for the item |
4736
- | `parent` | no | string | Parent item value, null for root items |
4737
- | `secondaryLabel` | no | string | Supporting text below the label |
4738
- | `value` | yes | string | Unique identifier for the item |
4739
-
4740
- No additional properties.
4741
-
4742
- ## TreeTag
4743
-
4744
- ### Fields
4745
-
4746
- | Name | Required | Type | Description |
4747
- |---|---:|---|---|
4748
- | `appearance` | no | string | Label appearance (e.g., "primary", "error", "success") |
4749
- | `text` | yes | string | Tag text to display |
4750
-
4751
- No additional properties.
4752
-
4753
- ## User_cache
4754
-
4755
- User cache data with smallPhoto fallback
4756
-
4757
- ### Fields
4758
-
4759
- | Name | Required | Type | Description |
4760
- |---|---:|---|---|
4761
- | `smallPhoto` | no | string | Small photo URL |
4762
-
4763
- Additional properties: unknown.
4764
-
4765
- ## VStackMargin
4766
-
4767
- ### Fields
4768
-
4769
- | Name | Required | Type | Description |
4770
- |---|---:|---|---|
4771
- | `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
4772
- | `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
4773
- | `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
4774
- | `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
4775
-
4776
- No additional properties.
4777
-
4778
- ## VStackPadding
4779
-
4780
- ### Fields
4781
-
4782
- | Name | Required | Type | Description |
4783
- |---|---:|---|---|
4784
- | `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
4785
- | `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
4786
- | `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
4787
- | `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
4788
-
4789
- No additional properties.
4790
-
4791
- ## WorkEmailArg
4792
-
4793
- ### Fields
4794
-
4795
- _No fields._
4796
-
4797
- Additional properties: unknown.
4798
-
4799
- ## WorkEmailCheck
4800
-
4801
- ### Fields
4802
-
4803
- | Name | Required | Type | Description |
4804
- |---|---:|---|---|
4805
- | `args` | no | [WorkEmailArg](./types.md#workemailarg) | |
4806
- | `message` | yes | string | |
4807
- | `type` | yes | string | |
4808
-
4809
- No additional properties.
4810
-
4811
- ## WorkEmailDomainList
4812
-
4813
- ### Fields
4814
-
4815
- | Name | Required | Type | Description |
4816
- |---|---:|---|---|
4817
- | `isDisabled` | no | boolean | Disables this specific domain option |
4818
- | `label` | no | string | Display label for the domain option |
4819
- | `tag` | no | string \| [WorkEmailTag](./types.md#workemailtag) | Optional tag shown with the domain option |
4820
- | `value` | yes | string | Domain option value |
4821
-
4822
- No additional properties.
4823
-
4824
- ## WorkEmailTag
4825
-
4826
- ### Fields
4827
-
4828
- | Name | Required | Type | Description |
4829
- |---|---:|---|---|
4830
- | `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Optional semantic appearance for the tag |
4831
- | `text` | yes | string | Tag text displayed with the domain option |
4832
-
4833
- No additional properties.