@rippling/pebble-sdui-web 0.8.0 → 0.9.1
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.
- package/dist/catalogs/custom-apps/action-params.d.ts +4 -0
- package/dist/catalogs/custom-apps/actions.d.ts +2 -1
- package/dist/catalogs/custom-apps/catalog.d.ts +2 -2
- package/dist/catalogs/custom-apps/component-events.d.ts +16 -14
- package/dist/catalogs/custom-apps/component-props.d.ts +1041 -260
- package/dist/catalogs/custom-apps/components.d.ts +5 -3
- package/dist/catalogs/custom-apps/index.cjs +4 -2
- package/dist/catalogs/custom-apps/index.cjs.map +1 -1
- package/dist/catalogs/custom-apps/index.d.ts +5 -5
- package/dist/catalogs/custom-apps/index.js +5983 -1661
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/catalogs/hub_platform/catalog.d.ts +1 -1
- package/dist/catalogs/hub_platform/component-props.d.ts +14 -6
- package/dist/catalogs/hub_platform/index.cjs +1 -1
- package/dist/catalogs/hub_platform/index.cjs.map +1 -1
- package/dist/catalogs/hub_platform/index.d.ts +1 -1
- package/dist/catalogs/hub_platform/index.js +86 -137
- package/dist/catalogs/hub_platform/index.js.map +1 -1
- package/dist/core/catalog-validation.cjs +2 -0
- package/dist/core/catalog-validation.cjs.map +1 -0
- package/dist/core/catalog-validation.d.ts +21 -0
- package/dist/core/catalog-validation.js +245 -0
- package/dist/core/catalog-validation.js.map +1 -0
- package/dist/core/directives.cjs +2 -0
- package/dist/core/directives.cjs.map +1 -0
- package/dist/core/directives.d.ts +72 -0
- package/dist/core/directives.js +35 -0
- package/dist/core/directives.js.map +1 -0
- package/dist/core/expressions.d.ts +5 -15
- package/dist/core/index.cjs +1 -1
- package/dist/core/index.d.ts +2 -0
- package/dist/core/index.js +28 -20
- package/dist/core/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/actions.md +31 -2
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +468 -291
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +250 -288
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +1362 -148
- package/dist/docs/typescript/web/catalogs/hub_platform/components.md +1 -1
- package/dist/docs/typescript/web/catalogs/hub_platform/types.md +14 -0
- package/dist/index.cjs +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +25 -17
- package/dist/index.js.map +1 -1
- package/dist/sdk-docs.cjs +208 -1
- package/dist/sdk-docs.cjs.map +1 -1
- package/dist/sdk-docs.js +213 -0
- package/dist/sdk-docs.js.map +1 -1
- package/package.json +1 -1
|
@@ -3,18 +3,52 @@
|
|
|
3
3
|
|
|
4
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
5
|
|
|
6
|
-
##
|
|
6
|
+
## ActionCardPadding
|
|
7
|
+
|
|
8
|
+
Override container padding per side using Pebble spacing tokens
|
|
7
9
|
|
|
8
10
|
### Fields
|
|
9
11
|
|
|
10
12
|
| Name | Required | Type | Description |
|
|
11
13
|
|---|---:|---|---|
|
|
12
|
-
| `
|
|
13
|
-
| `
|
|
14
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
15
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
16
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
17
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
14
18
|
|
|
15
19
|
No additional properties.
|
|
16
20
|
|
|
17
|
-
##
|
|
21
|
+
## ActionCardPrimaryAction
|
|
22
|
+
|
|
23
|
+
Primary action button configuration
|
|
24
|
+
|
|
25
|
+
### Fields
|
|
26
|
+
|
|
27
|
+
| Name | Required | Type | Description |
|
|
28
|
+
|---|---:|---|---|
|
|
29
|
+
| `icon` | no | string | Icon type string for the action button |
|
|
30
|
+
| `isDisabled` | no | boolean | Disable the action button. Default: false |
|
|
31
|
+
| `title` | yes | string | Action button label |
|
|
32
|
+
| `to` | no | string \| [ActionCardTo](./types.md#actioncardto) | Navigation destination for the action. String URL or { path, openInNewTab? } |
|
|
33
|
+
|
|
34
|
+
No additional properties.
|
|
35
|
+
|
|
36
|
+
## ActionCardSecondaryAction
|
|
37
|
+
|
|
38
|
+
Secondary action button configuration
|
|
39
|
+
|
|
40
|
+
### Fields
|
|
41
|
+
|
|
42
|
+
| Name | Required | Type | Description |
|
|
43
|
+
|---|---:|---|---|
|
|
44
|
+
| `icon` | no | string | Icon type string for the action button |
|
|
45
|
+
| `isDisabled` | no | boolean | Disable the action button. Default: false |
|
|
46
|
+
| `title` | yes | string | Action button label |
|
|
47
|
+
| `to` | no | string \| [ActionCardTo](./types.md#actioncardto) | Navigation destination for the action. String URL or { path, openInNewTab? } |
|
|
48
|
+
|
|
49
|
+
No additional properties.
|
|
50
|
+
|
|
51
|
+
## ActionCardTo
|
|
18
52
|
|
|
19
53
|
### Fields
|
|
20
54
|
|
|
@@ -45,18 +79,39 @@ Address object with street, city, state, country, and zip
|
|
|
45
79
|
|
|
46
80
|
No additional properties.
|
|
47
81
|
|
|
48
|
-
##
|
|
82
|
+
## AlertPrimaryAction
|
|
83
|
+
|
|
84
|
+
Primary action button configuration
|
|
49
85
|
|
|
50
86
|
### Fields
|
|
51
87
|
|
|
52
88
|
| Name | Required | Type | Description |
|
|
53
89
|
|---|---:|---|---|
|
|
54
|
-
| `
|
|
55
|
-
| `
|
|
90
|
+
| `icon` | no | string | Icon type string from Icon.TYPES for the action button |
|
|
91
|
+
| `isDisabled` | no | boolean | Disable the action button. Default: false |
|
|
92
|
+
| `shouldShowSpinner` | no | boolean | Show spinner on the action button. Default: false |
|
|
93
|
+
| `title` | yes | string | Action button label |
|
|
94
|
+
| `to` | no | string \| [AlertTo](./types.md#alertto) | Navigation destination for the action. String URL or { path, openInNewTab? } |
|
|
95
|
+
|
|
96
|
+
No additional properties.
|
|
97
|
+
|
|
98
|
+
## AlertSecondaryAction
|
|
99
|
+
|
|
100
|
+
Secondary action button configuration
|
|
101
|
+
|
|
102
|
+
### Fields
|
|
103
|
+
|
|
104
|
+
| Name | Required | Type | Description |
|
|
105
|
+
|---|---:|---|---|
|
|
106
|
+
| `icon` | no | string | Icon type string from Icon.TYPES for the action button |
|
|
107
|
+
| `isDisabled` | no | boolean | Disable the action button. Default: false |
|
|
108
|
+
| `shouldShowSpinner` | no | boolean | Show spinner on the action button. Default: false |
|
|
109
|
+
| `title` | yes | string | Action button label |
|
|
110
|
+
| `to` | no | string \| [AlertTo](./types.md#alertto) | Navigation destination for the action. String URL or { path, openInNewTab? } |
|
|
56
111
|
|
|
57
112
|
No additional properties.
|
|
58
113
|
|
|
59
|
-
##
|
|
114
|
+
## AlertTo
|
|
60
115
|
|
|
61
116
|
### Fields
|
|
62
117
|
|
|
@@ -69,7 +124,7 @@ No additional properties.
|
|
|
69
124
|
|
|
70
125
|
## AnimationData
|
|
71
126
|
|
|
72
|
-
Lottie animation JSON object. Required if path not provided
|
|
127
|
+
Lottie animation JSON object. Required if path is not provided
|
|
73
128
|
|
|
74
129
|
### Fields
|
|
75
130
|
|
|
@@ -145,7 +200,7 @@ _No fields._
|
|
|
145
200
|
|
|
146
201
|
Additional properties: unknown.
|
|
147
202
|
|
|
148
|
-
##
|
|
203
|
+
## AppGroupSelectList
|
|
149
204
|
|
|
150
205
|
### Fields
|
|
151
206
|
|
|
@@ -168,6 +223,17 @@ Additional properties: unknown.
|
|
|
168
223
|
|
|
169
224
|
No additional properties.
|
|
170
225
|
|
|
226
|
+
## AppGroupSelectListVariant2
|
|
227
|
+
|
|
228
|
+
### Fields
|
|
229
|
+
|
|
230
|
+
| Name | Required | Type | Description |
|
|
231
|
+
|---|---:|---|---|
|
|
232
|
+
| `label` | yes | string | Group label/header |
|
|
233
|
+
| `list` | yes | [AppGroupSelectList](./types.md#appgroupselectlist)[] | Options within this group |
|
|
234
|
+
|
|
235
|
+
No additional properties.
|
|
236
|
+
|
|
171
237
|
## AppNavBarAction
|
|
172
238
|
|
|
173
239
|
### Fields
|
|
@@ -196,13 +262,26 @@ Badge shown next to the nav item title
|
|
|
196
262
|
|
|
197
263
|
No additional properties.
|
|
198
264
|
|
|
265
|
+
## AvatarBadge
|
|
266
|
+
|
|
267
|
+
Badge overlay configuration for the avatar
|
|
268
|
+
|
|
269
|
+
### Fields
|
|
270
|
+
|
|
271
|
+
| Name | Required | Type | Description |
|
|
272
|
+
|---|---:|---|---|
|
|
273
|
+
| `aria-label` | yes | string | Accessible label for the badge |
|
|
274
|
+
| `char` | no | string | Single character to display in the badge overlay |
|
|
275
|
+
|
|
276
|
+
No additional properties.
|
|
277
|
+
|
|
199
278
|
## AvatarIcon
|
|
200
279
|
|
|
201
280
|
### Fields
|
|
202
281
|
|
|
203
282
|
| Name | Required | Type | Description |
|
|
204
283
|
|---|---:|---|---|
|
|
205
|
-
| `backgroundColor` | no | [
|
|
284
|
+
| `backgroundColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | |
|
|
206
285
|
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | |
|
|
207
286
|
| `type` | yes | string | |
|
|
208
287
|
|
|
@@ -338,6 +417,19 @@ No additional properties.
|
|
|
338
417
|
|
|
339
418
|
No additional properties.
|
|
340
419
|
|
|
420
|
+
## ButtonLabel
|
|
421
|
+
|
|
422
|
+
Labels for the expand and collapse buttons
|
|
423
|
+
|
|
424
|
+
### Fields
|
|
425
|
+
|
|
426
|
+
| Name | Required | Type | Description |
|
|
427
|
+
|---|---:|---|---|
|
|
428
|
+
| `collapse` | yes | string | Label for the collapse button. Default: Show less |
|
|
429
|
+
| `expand` | yes | string | Label for the expand button. Default: Show more |
|
|
430
|
+
|
|
431
|
+
No additional properties.
|
|
432
|
+
|
|
341
433
|
## ButtonTip
|
|
342
434
|
|
|
343
435
|
### Fields
|
|
@@ -427,7 +519,7 @@ Additional properties: unknown.
|
|
|
427
519
|
|
|
428
520
|
No additional properties.
|
|
429
521
|
|
|
430
|
-
##
|
|
522
|
+
## CheckboxGroupList
|
|
431
523
|
|
|
432
524
|
### Fields
|
|
433
525
|
|
|
@@ -437,7 +529,7 @@ No additional properties.
|
|
|
437
529
|
| `label` | yes | string | Display text for the checkbox option |
|
|
438
530
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
439
531
|
| `tag` | no | string \| [CheckboxGroupTag](./types.md#checkboxgrouptag) | Optional tag/label displayed with the option |
|
|
440
|
-
| `tip` | no | string | Tooltip
|
|
532
|
+
| `tip` | no | string \| [CheckboxGroupTip](./types.md#checkboxgrouptip) | Tooltip shown on hover. Can be simple string text or a TipTypes object |
|
|
441
533
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
442
534
|
|
|
443
535
|
No additional properties.
|
|
@@ -453,6 +545,34 @@ No additional properties.
|
|
|
453
545
|
|
|
454
546
|
No additional properties.
|
|
455
547
|
|
|
548
|
+
## CheckboxGroupTip
|
|
549
|
+
|
|
550
|
+
### Fields
|
|
551
|
+
|
|
552
|
+
| Name | Required | Type | Description |
|
|
553
|
+
|---|---:|---|---|
|
|
554
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style. Default: LIGHT |
|
|
555
|
+
| `content` | yes | string | Tooltip text content |
|
|
556
|
+
| `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls. Default: false |
|
|
557
|
+
| `isDelayed` | no | boolean | Add delay before showing tooltip. Default: false |
|
|
558
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
|
|
559
|
+
| `isPositionFixed` | no | boolean | Use fixed positioning relative to viewport. Default: false |
|
|
560
|
+
| `isVisible` | no | boolean | Control tooltip visibility from state |
|
|
561
|
+
| `maxHeight` | no | number \| string | Maximum height for tooltip content |
|
|
562
|
+
| `maxWidth` | no | number \| string | Maximum width for tooltip content |
|
|
563
|
+
| `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows. Default: false |
|
|
564
|
+
| `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows. Default: false |
|
|
565
|
+
| `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware. Default: false |
|
|
566
|
+
| `padding` | no | string | CSS padding value for tooltip content |
|
|
567
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to the checkbox option |
|
|
568
|
+
| `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis. Default: false |
|
|
569
|
+
| `tipHideDelay` | no | number | Milliseconds to wait before hiding tooltip when delayed |
|
|
570
|
+
| `tipShowDelay` | no | number | Milliseconds to wait before showing tooltip when delayed |
|
|
571
|
+
| `title` | no | string | Tooltip title text |
|
|
572
|
+
| `truncateClassName` | no | string | CSS class when onlyIfOverflow is enabled |
|
|
573
|
+
|
|
574
|
+
No additional properties.
|
|
575
|
+
|
|
456
576
|
## CheckListOption
|
|
457
577
|
|
|
458
578
|
Per-item input type overrides
|
|
@@ -518,6 +638,27 @@ No additional properties.
|
|
|
518
638
|
|
|
519
639
|
No additional properties.
|
|
520
640
|
|
|
641
|
+
## ClickedFile
|
|
642
|
+
|
|
643
|
+
Bindable clicked file metadata written before chipClick emits
|
|
644
|
+
|
|
645
|
+
### Fields
|
|
646
|
+
|
|
647
|
+
| Name | Required | Type | Description |
|
|
648
|
+
|---|---:|---|---|
|
|
649
|
+
| `name` | no | string | File name |
|
|
650
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
651
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
652
|
+
| `isMultipart` | no | boolean | Whether this is a multipart upload |
|
|
653
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
654
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
655
|
+
| `size` | no | number | File size in bytes |
|
|
656
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
657
|
+
| `type` | no | string | MIME type of the file |
|
|
658
|
+
| `url` | no | string | URL of the uploaded file |
|
|
659
|
+
|
|
660
|
+
No additional properties.
|
|
661
|
+
|
|
521
662
|
## CollapseBelow
|
|
522
663
|
|
|
523
664
|
Configure when each priority level auto-collapses based on container width. Keys are priority numbers, values are breakpoint tokens. Use false to disable auto-collapse for a priority level
|
|
@@ -569,7 +710,14 @@ No additional properties.
|
|
|
569
710
|
| Name | Required | Type | Description |
|
|
570
711
|
|---|---:|---|---|
|
|
571
712
|
| `alignment` | no | [CountryIconAlignment](./definitions.md#countryiconalignment) | Alignment of the icon within the container. Use "RIGHT" to push icon to the right. |
|
|
713
|
+
| `aria-describedby` | no | string | ID of element that describes the icon |
|
|
714
|
+
| `aria-label` | no | string | Accessible label for the icon |
|
|
715
|
+
| `aria-labelledby` | no | string | ID of element that labels the icon |
|
|
572
716
|
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
717
|
+
| `isDisabled` | no | boolean | Sets icon interactions as disabled |
|
|
718
|
+
| `isFocused` | no | boolean | Shows icon backdrop when focused |
|
|
719
|
+
| `showCursor` | no | boolean | Shows pointer cursor and hover background |
|
|
720
|
+
| `size` | no | number \| string | Icon size in pixels or CSS units |
|
|
573
721
|
| `tip` | no | string | Tooltip content shown on icon hover |
|
|
574
722
|
| `type` | yes | string | Icon type name (e.g. "INFO_CIRCLE_OUTLINE") |
|
|
575
723
|
|
|
@@ -595,6 +743,85 @@ Additional properties: unknown.
|
|
|
595
743
|
|
|
596
744
|
No additional properties.
|
|
597
745
|
|
|
746
|
+
## CurrencyCurrencyTypeProp
|
|
747
|
+
|
|
748
|
+
Nested Select props for the currency selector
|
|
749
|
+
|
|
750
|
+
### Fields
|
|
751
|
+
|
|
752
|
+
| Name | Required | Type | Description |
|
|
753
|
+
|---|---:|---|---|
|
|
754
|
+
| `name` | no | string | Unique identifier for the currency selector |
|
|
755
|
+
| `aria-describedby` | no | string | ID of element that describes the currency selector |
|
|
756
|
+
| `aria-label` | no | string | Accessible label for the currency selector |
|
|
757
|
+
| `aria-labelledby` | no | string | ID of element that labels the currency selector |
|
|
758
|
+
| `canClear` | no | boolean | Show clear button to deselect |
|
|
759
|
+
| `defaultSearchQuery` | no | string | Initial search input value |
|
|
760
|
+
| `defaultValue` | no | unknown | Initial selected currency code |
|
|
761
|
+
| `dropdownHeight` | no | number | Dropdown menu height in pixels |
|
|
762
|
+
| `emptyListPlaceholder` | no | string \| [CurrencyEmptyListPlaceholder](./types.md#currencyemptylistplaceholder) | Placeholder when dropdown list is empty |
|
|
763
|
+
| `fuseOptions` | no | [CurrencyFuseOption](./types.md#currencyfuseoption) | Fuse.js search options |
|
|
764
|
+
| `isDisabled` | no | boolean | Disables the currency selector |
|
|
765
|
+
| `isMenuDefaultOpen` | no | boolean | If true, dropdown menu opens by default |
|
|
766
|
+
| `isPositionFixed` | no | boolean | Position dropdown relative to viewport |
|
|
767
|
+
| `isReadOnly` | no | boolean | Makes the currency selector read-only |
|
|
768
|
+
| `isRequired` | no | boolean | Marks the currency selector as required |
|
|
769
|
+
| `isSearchable` | no | boolean | Enable type-to-search filtering |
|
|
770
|
+
| `maxHeight` | no | string \| number | Dropdown max height |
|
|
771
|
+
| `placeholder` | no | string | Placeholder text when empty |
|
|
772
|
+
| `scrollThreshold` | no | number | Extra virtual scroll render threshold |
|
|
773
|
+
| `shouldFocusFirstElement` | no | boolean | Auto-focus first menu item |
|
|
774
|
+
| `shouldShowSearchIcon` | no | boolean | Show search icon prefix |
|
|
775
|
+
| `shouldUsePortal` | no | boolean | Render dropdown in a React Portal |
|
|
776
|
+
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Select input size variant. Default: M |
|
|
777
|
+
| `value` | no | unknown | Currently selected currency code |
|
|
778
|
+
|
|
779
|
+
No additional properties.
|
|
780
|
+
|
|
781
|
+
## CurrencyDefaultValue
|
|
782
|
+
|
|
783
|
+
### Fields
|
|
784
|
+
|
|
785
|
+
| Name | Required | Type | Description |
|
|
786
|
+
|---|---:|---|---|
|
|
787
|
+
| `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
|
|
788
|
+
| `value` | yes | string \| number | Currency amount value |
|
|
789
|
+
|
|
790
|
+
No additional properties.
|
|
791
|
+
|
|
792
|
+
## CurrencyEmptyListPlaceholder
|
|
793
|
+
|
|
794
|
+
### Fields
|
|
795
|
+
|
|
796
|
+
| Name | Required | Type | Description |
|
|
797
|
+
|---|---:|---|---|
|
|
798
|
+
| `onLoading` | no | string | Placeholder shown while list is loading |
|
|
799
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query entered |
|
|
800
|
+
| `onNoSearchResults` | no | string | Placeholder when search returns no results |
|
|
801
|
+
|
|
802
|
+
No additional properties.
|
|
803
|
+
|
|
804
|
+
## CurrencyFuseOption
|
|
805
|
+
|
|
806
|
+
Fuse.js search options
|
|
807
|
+
|
|
808
|
+
### Fields
|
|
809
|
+
|
|
810
|
+
_No fields._
|
|
811
|
+
|
|
812
|
+
Additional properties: unknown.
|
|
813
|
+
|
|
814
|
+
## CurrencyValue
|
|
815
|
+
|
|
816
|
+
### Fields
|
|
817
|
+
|
|
818
|
+
| Name | Required | Type | Description |
|
|
819
|
+
|---|---:|---|---|
|
|
820
|
+
| `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
|
|
821
|
+
| `value` | yes | string \| number | Currency amount value |
|
|
822
|
+
|
|
823
|
+
No additional properties.
|
|
824
|
+
|
|
598
825
|
## DateArg
|
|
599
826
|
|
|
600
827
|
### Fields
|
|
@@ -675,6 +902,27 @@ Additional properties: unknown.
|
|
|
675
902
|
|
|
676
903
|
No additional properties.
|
|
677
904
|
|
|
905
|
+
## DaySelectorRenderProp
|
|
906
|
+
|
|
907
|
+
Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string)
|
|
908
|
+
|
|
909
|
+
### Fields
|
|
910
|
+
|
|
911
|
+
_No fields._
|
|
912
|
+
|
|
913
|
+
Additional properties: [DaySelectorRenderPropValue](./types.md#dayselectorrenderpropvalue).
|
|
914
|
+
|
|
915
|
+
## DaySelectorRenderPropValue
|
|
916
|
+
|
|
917
|
+
### Fields
|
|
918
|
+
|
|
919
|
+
| Name | Required | Type | Description |
|
|
920
|
+
|---|---:|---|---|
|
|
921
|
+
| `isDisabled` | no | boolean | |
|
|
922
|
+
| `tip` | no | [DaySelectorTip](./types.md#dayselectortip) | |
|
|
923
|
+
|
|
924
|
+
No additional properties.
|
|
925
|
+
|
|
678
926
|
## DaySelectorTip
|
|
679
927
|
|
|
680
928
|
### Fields
|
|
@@ -685,18 +933,18 @@ No additional properties.
|
|
|
685
933
|
|
|
686
934
|
No additional properties.
|
|
687
935
|
|
|
688
|
-
##
|
|
689
|
-
|
|
690
|
-
Optional display metadata for a multithreaded comment thread.
|
|
936
|
+
## DisabledTip
|
|
691
937
|
|
|
692
938
|
### Fields
|
|
693
939
|
|
|
694
940
|
| Name | Required | Type | Description |
|
|
695
941
|
|---|---:|---|---|
|
|
696
|
-
| `
|
|
697
|
-
| `
|
|
698
|
-
| `
|
|
699
|
-
| `
|
|
942
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance |
|
|
943
|
+
| `content` | yes | string | Tooltip content text |
|
|
944
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent |
|
|
945
|
+
| `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
|
|
946
|
+
| `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
|
|
947
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement |
|
|
700
948
|
|
|
701
949
|
No additional properties.
|
|
702
950
|
|
|
@@ -709,6 +957,68 @@ No additional properties.
|
|
|
709
957
|
| `id` | yes | string \| number | Unique identifier for the item |
|
|
710
958
|
| `label` | no | string | Display label for the item |
|
|
711
959
|
|
|
960
|
+
Additional properties: unknown.
|
|
961
|
+
|
|
962
|
+
## DraggableListTip
|
|
963
|
+
|
|
964
|
+
Tooltip configuration for the default chip renderer
|
|
965
|
+
|
|
966
|
+
### Fields
|
|
967
|
+
|
|
968
|
+
| Name | Required | Type | Description |
|
|
969
|
+
|---|---:|---|---|
|
|
970
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: DARK |
|
|
971
|
+
| `contentKey` | no | string | List item key used as tooltip content |
|
|
972
|
+
| `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls |
|
|
973
|
+
| `isDelayed` | no | boolean | Add delay before showing tooltip |
|
|
974
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices |
|
|
975
|
+
| `isPositionFixed` | no | boolean | Use fixed positioning relative to viewport |
|
|
976
|
+
| `isVisible` | no | boolean | Control tooltip visibility |
|
|
977
|
+
| `maxHeight` | no | number \| string | Maximum tooltip height |
|
|
978
|
+
| `maxWidth` | no | number \| string | Maximum tooltip width |
|
|
979
|
+
| `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows |
|
|
980
|
+
| `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows |
|
|
981
|
+
| `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware |
|
|
982
|
+
| `padding` | no | string | CSS padding value for tooltip content |
|
|
983
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement |
|
|
984
|
+
| `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis |
|
|
985
|
+
| `tipHideDelay` | no | number | Milliseconds to wait before hiding delayed tooltip |
|
|
986
|
+
| `tipShowDelay` | no | number | Milliseconds to wait before showing delayed tooltip |
|
|
987
|
+
| `title` | no | string | Static tooltip title |
|
|
988
|
+
| `titleKey` | no | string | List item key used as tooltip title |
|
|
989
|
+
| `truncateClassName` | no | string | CSS class when overflow-only tooltip is enabled |
|
|
990
|
+
|
|
991
|
+
No additional properties.
|
|
992
|
+
|
|
993
|
+
## DrawerItem
|
|
994
|
+
|
|
995
|
+
### Fields
|
|
996
|
+
|
|
997
|
+
| Name | Required | Type | Description |
|
|
998
|
+
|---|---:|---|---|
|
|
999
|
+
| `href` | no | string | URL to navigate to when clicked |
|
|
1000
|
+
| `isDisabled` | no | boolean | Disables the breadcrumb item |
|
|
1001
|
+
| `title` | yes | string | Display label for the breadcrumb item |
|
|
1002
|
+
| `value` | yes | string | Unique value identifier for the item |
|
|
1003
|
+
|
|
1004
|
+
No additional properties.
|
|
1005
|
+
|
|
1006
|
+
## DrawerProp
|
|
1007
|
+
|
|
1008
|
+
Breadcrumb props for the drawer title
|
|
1009
|
+
|
|
1010
|
+
### Fields
|
|
1011
|
+
|
|
1012
|
+
| Name | Required | Type | Description |
|
|
1013
|
+
|---|---:|---|---|
|
|
1014
|
+
| `active` | no | string | Value of the active breadcrumb item |
|
|
1015
|
+
| `aria-describedby` | no | string | ID of element that describes the breadcrumb nav |
|
|
1016
|
+
| `aria-label` | no | string | Accessible label for the breadcrumb nav |
|
|
1017
|
+
| `aria-labelledby` | no | string | ID of element that labels the breadcrumb nav |
|
|
1018
|
+
| `items` | yes | [DrawerItem](./types.md#draweritem)[] | Breadcrumb items shown in the drawer header |
|
|
1019
|
+
| `noMargin` | no | boolean | Remove default breadcrumb margin |
|
|
1020
|
+
| `shouldCollapseMiddle` | no | boolean | Collapse middle breadcrumb items |
|
|
1021
|
+
|
|
712
1022
|
No additional properties.
|
|
713
1023
|
|
|
714
1024
|
## DropdownDisabledInfo
|
|
@@ -721,6 +1031,28 @@ No additional properties.
|
|
|
721
1031
|
|
|
722
1032
|
No additional properties.
|
|
723
1033
|
|
|
1034
|
+
## DropdownFooter
|
|
1035
|
+
|
|
1036
|
+
Footer item rendered at the bottom of the list
|
|
1037
|
+
|
|
1038
|
+
### Fields
|
|
1039
|
+
|
|
1040
|
+
| Name | Required | Type | Description |
|
|
1041
|
+
|---|---:|---|---|
|
|
1042
|
+
| `disabledInfo` | no | string \| [DropdownDisabledInfo](./types.md#dropdowndisabledinfo) | Tooltip content shown when the option is disabled |
|
|
1043
|
+
| `isDisabled` | no | boolean | Disables this option |
|
|
1044
|
+
| `label` | no | string | Display text for the option |
|
|
1045
|
+
| `labelIcon` | no | string | Icon name to show next to the label |
|
|
1046
|
+
| `leftIconType` | no | string | Icon name to show on the left side of the item |
|
|
1047
|
+
| `quaternaryLabel` | no | string | Quaternary text below the tertiary label |
|
|
1048
|
+
| `secondaryLabel` | no | string | Secondary text below the main label |
|
|
1049
|
+
| `tag` | no | string \| [DropdownTag](./types.md#dropdowntag) | Tag shown beside the option text |
|
|
1050
|
+
| `tertiaryLabel` | no | string | Tertiary text below the secondary label |
|
|
1051
|
+
| `type` | no | [DropdownFooterType](./definitions.md#dropdownfootertype) | Visual style type for the option (WARNING or ALERT) |
|
|
1052
|
+
| `value` | no | unknown | Value for the option |
|
|
1053
|
+
|
|
1054
|
+
Additional properties: unknown.
|
|
1055
|
+
|
|
724
1056
|
## DropdownList
|
|
725
1057
|
|
|
726
1058
|
### Fields
|
|
@@ -740,15 +1072,55 @@ No additional properties.
|
|
|
740
1072
|
|---|---:|---|---|
|
|
741
1073
|
| `disabledInfo` | no | string \| [DropdownDisabledInfo](./types.md#dropdowndisabledinfo) | Tooltip content shown when the option is disabled |
|
|
742
1074
|
| `isDisabled` | no | boolean | Disables this option |
|
|
743
|
-
| `label` |
|
|
1075
|
+
| `label` | no | string | Display text for the option |
|
|
744
1076
|
| `labelIcon` | no | string | Icon name to show next to the label |
|
|
745
1077
|
| `leftIconType` | no | string | Icon name to show on the left side of the item |
|
|
746
1078
|
| `quaternaryLabel` | no | string | Quaternary text below the tertiary label |
|
|
747
1079
|
| `secondaryLabel` | no | string | Secondary text below the main label |
|
|
748
|
-
| `tag` | no | string | Tag
|
|
1080
|
+
| `tag` | no | string \| [DropdownTag](./types.md#dropdowntag) | Tag shown beside the option text |
|
|
749
1081
|
| `tertiaryLabel` | no | string | Tertiary text below the secondary label |
|
|
750
|
-
| `type` | no | [
|
|
751
|
-
| `value` |
|
|
1082
|
+
| `type` | no | [DropdownFooterType](./definitions.md#dropdownfootertype) | Visual style type for the option (WARNING or ALERT) |
|
|
1083
|
+
| `value` | no | unknown | Value for the option |
|
|
1084
|
+
|
|
1085
|
+
Additional properties: unknown.
|
|
1086
|
+
|
|
1087
|
+
## DropdownListVariant2
|
|
1088
|
+
|
|
1089
|
+
### Fields
|
|
1090
|
+
|
|
1091
|
+
| Name | Required | Type | Description |
|
|
1092
|
+
|---|---:|---|---|
|
|
1093
|
+
| `isDisabled` | no | boolean | Disables this option |
|
|
1094
|
+
| `isNestedMenu` | no | boolean | Marks this item as a nested menu |
|
|
1095
|
+
| `label` | yes | string | Display text for the nested menu item |
|
|
1096
|
+
| `labelIcon` | no | string | Icon name to show next to the label |
|
|
1097
|
+
| `leftIconType` | no | string | Icon name to show on the left side of the item |
|
|
1098
|
+
| `list` | yes | [DropdownList2](./types.md#dropdownlist2)[] | Nested flat list items |
|
|
1099
|
+
| `tag` | no | string \| [DropdownTag](./types.md#dropdowntag) | Tag shown beside the option text |
|
|
1100
|
+
| `value` | no | unknown | Value for the nested option |
|
|
1101
|
+
|
|
1102
|
+
Additional properties: unknown.
|
|
1103
|
+
|
|
1104
|
+
## DropdownTag
|
|
1105
|
+
|
|
1106
|
+
### Fields
|
|
1107
|
+
|
|
1108
|
+
| Name | Required | Type | Description |
|
|
1109
|
+
|---|---:|---|---|
|
|
1110
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance |
|
|
1111
|
+
| `text` | yes | string | Tag text |
|
|
1112
|
+
|
|
1113
|
+
No additional properties.
|
|
1114
|
+
|
|
1115
|
+
## EditButton
|
|
1116
|
+
|
|
1117
|
+
### Fields
|
|
1118
|
+
|
|
1119
|
+
| Name | Required | Type | Description |
|
|
1120
|
+
|---|---:|---|---|
|
|
1121
|
+
| `disabledTip` | no | string \| [DisabledTip](./types.md#disabledtip) | Tooltip shown when the settings edit button is disabled |
|
|
1122
|
+
| `isDisabled` | no | boolean | Disable the settings edit button |
|
|
1123
|
+
| `show` | no | boolean | Show or hide the settings edit button. Default: true |
|
|
752
1124
|
|
|
753
1125
|
No additional properties.
|
|
754
1126
|
|
|
@@ -772,6 +1144,88 @@ Additional properties: unknown.
|
|
|
772
1144
|
|
|
773
1145
|
No additional properties.
|
|
774
1146
|
|
|
1147
|
+
## EmailStringPadding
|
|
1148
|
+
|
|
1149
|
+
Pads input value with character until reaching maxLength
|
|
1150
|
+
|
|
1151
|
+
### Fields
|
|
1152
|
+
|
|
1153
|
+
| Name | Required | Type | Description |
|
|
1154
|
+
|---|---:|---|---|
|
|
1155
|
+
| `character` | yes | string | Character to use for padding |
|
|
1156
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1157
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
1158
|
+
|
|
1159
|
+
No additional properties.
|
|
1160
|
+
|
|
1161
|
+
## ExpansionPanelToggleIcon
|
|
1162
|
+
|
|
1163
|
+
Toggle icon layout options
|
|
1164
|
+
|
|
1165
|
+
### Fields
|
|
1166
|
+
|
|
1167
|
+
| Name | Required | Type | Description |
|
|
1168
|
+
|---|---:|---|---|
|
|
1169
|
+
| `align` | no | string | CSS align-self value for the toggle icon |
|
|
1170
|
+
| `margin` | no | string | CSS margin around the toggle icon container |
|
|
1171
|
+
| `size` | no | number \| string | Toggle icon size. Default: 24px |
|
|
1172
|
+
|
|
1173
|
+
No additional properties.
|
|
1174
|
+
|
|
1175
|
+
## FileAllowCameraCapture
|
|
1176
|
+
|
|
1177
|
+
### Fields
|
|
1178
|
+
|
|
1179
|
+
| Name | Required | Type | Description |
|
|
1180
|
+
|---|---:|---|---|
|
|
1181
|
+
| `quality` | no | number | Captured image quality |
|
|
1182
|
+
|
|
1183
|
+
No additional properties.
|
|
1184
|
+
|
|
1185
|
+
## FileCropperConfig
|
|
1186
|
+
|
|
1187
|
+
Image cropper configuration
|
|
1188
|
+
|
|
1189
|
+
### Fields
|
|
1190
|
+
|
|
1191
|
+
| Name | Required | Type | Description |
|
|
1192
|
+
|---|---:|---|---|
|
|
1193
|
+
| `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper |
|
|
1194
|
+
| `enforceAspectRatio` | no | boolean | Enforce cropper aspect ratio |
|
|
1195
|
+
| `showUploadButton` | no | boolean | Show upload button on cropper |
|
|
1196
|
+
| `title` | no | string | Title for the cropper modal |
|
|
1197
|
+
|
|
1198
|
+
No additional properties.
|
|
1199
|
+
|
|
1200
|
+
## FileDefaultValue
|
|
1201
|
+
|
|
1202
|
+
### Fields
|
|
1203
|
+
|
|
1204
|
+
| Name | Required | Type | Description |
|
|
1205
|
+
|---|---:|---|---|
|
|
1206
|
+
| `name` | no | string | File name |
|
|
1207
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
1208
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
1209
|
+
| `isMultipart` | no | boolean | Whether this is a multipart upload |
|
|
1210
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
1211
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
1212
|
+
| `size` | no | number | File size in bytes |
|
|
1213
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
1214
|
+
| `type` | no | string | MIME type of the file |
|
|
1215
|
+
| `url` | no | string | URL of the uploaded file |
|
|
1216
|
+
|
|
1217
|
+
No additional properties.
|
|
1218
|
+
|
|
1219
|
+
## FileDropAllowCameraCapture
|
|
1220
|
+
|
|
1221
|
+
### Fields
|
|
1222
|
+
|
|
1223
|
+
| Name | Required | Type | Description |
|
|
1224
|
+
|---|---:|---|---|
|
|
1225
|
+
| `quality` | no | number | Captured image quality |
|
|
1226
|
+
|
|
1227
|
+
No additional properties.
|
|
1228
|
+
|
|
775
1229
|
## FileDropArg
|
|
776
1230
|
|
|
777
1231
|
### Fields
|
|
@@ -800,7 +1254,7 @@ Cropper configuration
|
|
|
800
1254
|
|
|
801
1255
|
| Name | Required | Type | Description |
|
|
802
1256
|
|---|---:|---|---|
|
|
803
|
-
| `aspectRatio` | no | [
|
|
1257
|
+
| `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
804
1258
|
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
805
1259
|
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
806
1260
|
| `title` | no | string | Title for the cropper modal |
|
|
@@ -841,6 +1295,25 @@ No additional properties.
|
|
|
841
1295
|
|
|
842
1296
|
No additional properties.
|
|
843
1297
|
|
|
1298
|
+
## FileValue
|
|
1299
|
+
|
|
1300
|
+
### Fields
|
|
1301
|
+
|
|
1302
|
+
| Name | Required | Type | Description |
|
|
1303
|
+
|---|---:|---|---|
|
|
1304
|
+
| `name` | no | string | File name |
|
|
1305
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
1306
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
1307
|
+
| `isMultipart` | no | boolean | Whether this is a multipart upload |
|
|
1308
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
1309
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
1310
|
+
| `size` | no | number | File size in bytes |
|
|
1311
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
1312
|
+
| `type` | no | string | MIME type of the file |
|
|
1313
|
+
| `url` | no | string | URL of the uploaded file |
|
|
1314
|
+
|
|
1315
|
+
No additional properties.
|
|
1316
|
+
|
|
844
1317
|
## FloatingButtonIcon
|
|
845
1318
|
|
|
846
1319
|
### Fields
|
|
@@ -858,8 +1331,12 @@ No additional properties.
|
|
|
858
1331
|
|
|
859
1332
|
| Name | Required | Type | Description |
|
|
860
1333
|
|---|---:|---|---|
|
|
1334
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
|
|
861
1335
|
| `content` | yes | string | Tooltip content text |
|
|
862
|
-
| `
|
|
1336
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent |
|
|
1337
|
+
| `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
|
|
1338
|
+
| `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
|
|
1339
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to button. Default: TOP_START |
|
|
863
1340
|
|
|
864
1341
|
No additional properties.
|
|
865
1342
|
|
|
@@ -874,7 +1351,7 @@ No additional properties.
|
|
|
874
1351
|
|
|
875
1352
|
No additional properties.
|
|
876
1353
|
|
|
877
|
-
##
|
|
1354
|
+
## FormCheckboxGroupList
|
|
878
1355
|
|
|
879
1356
|
### Fields
|
|
880
1357
|
|
|
@@ -884,7 +1361,7 @@ No additional properties.
|
|
|
884
1361
|
| `label` | yes | string | Display text for the checkbox option |
|
|
885
1362
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
886
1363
|
| `tag` | no | string \| [FormCheckboxGroupTag](./types.md#formcheckboxgrouptag) | Optional tag/label displayed with the option |
|
|
887
|
-
| `tip` | no | string | Tooltip
|
|
1364
|
+
| `tip` | no | string \| [FormCheckboxGroupTip](./types.md#formcheckboxgrouptip) | Tooltip shown on hover. Can be simple string text or a TipTypes object |
|
|
888
1365
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
889
1366
|
|
|
890
1367
|
No additional properties.
|
|
@@ -900,6 +1377,34 @@ No additional properties.
|
|
|
900
1377
|
|
|
901
1378
|
No additional properties.
|
|
902
1379
|
|
|
1380
|
+
## FormCheckboxGroupTip
|
|
1381
|
+
|
|
1382
|
+
### Fields
|
|
1383
|
+
|
|
1384
|
+
| Name | Required | Type | Description |
|
|
1385
|
+
|---|---:|---|---|
|
|
1386
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style. Default: LIGHT |
|
|
1387
|
+
| `content` | yes | string | Tooltip text content |
|
|
1388
|
+
| `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls. Default: false |
|
|
1389
|
+
| `isDelayed` | no | boolean | Add delay before showing tooltip. Default: false |
|
|
1390
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
|
|
1391
|
+
| `isPositionFixed` | no | boolean | Use fixed positioning relative to viewport. Default: false |
|
|
1392
|
+
| `isVisible` | no | boolean | Control tooltip visibility from state |
|
|
1393
|
+
| `maxHeight` | no | number \| string | Maximum height for tooltip content |
|
|
1394
|
+
| `maxWidth` | no | number \| string | Maximum width for tooltip content |
|
|
1395
|
+
| `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows. Default: false |
|
|
1396
|
+
| `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows. Default: false |
|
|
1397
|
+
| `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware. Default: false |
|
|
1398
|
+
| `padding` | no | string | CSS padding value for tooltip content |
|
|
1399
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to the checkbox option |
|
|
1400
|
+
| `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis. Default: false |
|
|
1401
|
+
| `tipHideDelay` | no | number | Milliseconds to wait before hiding tooltip when delayed |
|
|
1402
|
+
| `tipShowDelay` | no | number | Milliseconds to wait before showing tooltip when delayed |
|
|
1403
|
+
| `title` | no | string | Tooltip title text |
|
|
1404
|
+
| `truncateClassName` | no | string | CSS class when onlyIfOverflow is enabled |
|
|
1405
|
+
|
|
1406
|
+
No additional properties.
|
|
1407
|
+
|
|
903
1408
|
## FormCheckboxGroupValidationError
|
|
904
1409
|
|
|
905
1410
|
Map of rule name to error message
|
|
@@ -920,6 +1425,74 @@ _No fields._
|
|
|
920
1425
|
|
|
921
1426
|
Additional properties: string.
|
|
922
1427
|
|
|
1428
|
+
## FormCurrencyCurrencyTypeProp
|
|
1429
|
+
|
|
1430
|
+
Nested Select props for the currency selector
|
|
1431
|
+
|
|
1432
|
+
### Fields
|
|
1433
|
+
|
|
1434
|
+
| Name | Required | Type | Description |
|
|
1435
|
+
|---|---:|---|---|
|
|
1436
|
+
| `name` | no | string | Unique identifier for the currency selector |
|
|
1437
|
+
| `aria-describedby` | no | string | ID of element that describes the currency selector |
|
|
1438
|
+
| `aria-label` | no | string | Accessible label for the currency selector |
|
|
1439
|
+
| `aria-labelledby` | no | string | ID of element that labels the currency selector |
|
|
1440
|
+
| `canClear` | no | boolean | Show clear button to deselect |
|
|
1441
|
+
| `defaultSearchQuery` | no | string | Initial search input value |
|
|
1442
|
+
| `defaultValue` | no | unknown | Initial selected currency code |
|
|
1443
|
+
| `dropdownHeight` | no | number | Dropdown menu height in pixels |
|
|
1444
|
+
| `emptyListPlaceholder` | no | string \| [FormCurrencyEmptyListPlaceholder](./types.md#formcurrencyemptylistplaceholder) | Placeholder when dropdown list is empty |
|
|
1445
|
+
| `fuseOptions` | no | [FormCurrencyFuseOption](./types.md#formcurrencyfuseoption) | Fuse.js search options |
|
|
1446
|
+
| `isDisabled` | no | boolean | Disables the currency selector |
|
|
1447
|
+
| `isMenuDefaultOpen` | no | boolean | If true, dropdown menu opens by default |
|
|
1448
|
+
| `isPositionFixed` | no | boolean | Position dropdown relative to viewport |
|
|
1449
|
+
| `isReadOnly` | no | boolean | Makes the currency selector read-only |
|
|
1450
|
+
| `isRequired` | no | boolean | Marks the currency selector as required |
|
|
1451
|
+
| `isSearchable` | no | boolean | Enable type-to-search filtering |
|
|
1452
|
+
| `maxHeight` | no | string \| number | Dropdown max height |
|
|
1453
|
+
| `placeholder` | no | string | Placeholder text when empty |
|
|
1454
|
+
| `scrollThreshold` | no | number | Extra virtual scroll render threshold |
|
|
1455
|
+
| `shouldFocusFirstElement` | no | boolean | Auto-focus first menu item |
|
|
1456
|
+
| `shouldShowSearchIcon` | no | boolean | Show search icon prefix |
|
|
1457
|
+
| `shouldUsePortal` | no | boolean | Render dropdown in a React Portal |
|
|
1458
|
+
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Select input size variant. Default: M |
|
|
1459
|
+
| `value` | no | unknown | Currently selected currency code |
|
|
1460
|
+
|
|
1461
|
+
No additional properties.
|
|
1462
|
+
|
|
1463
|
+
## FormCurrencyDefaultValue
|
|
1464
|
+
|
|
1465
|
+
### Fields
|
|
1466
|
+
|
|
1467
|
+
| Name | Required | Type | Description |
|
|
1468
|
+
|---|---:|---|---|
|
|
1469
|
+
| `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
|
|
1470
|
+
| `value` | yes | string \| number | Currency amount value |
|
|
1471
|
+
|
|
1472
|
+
No additional properties.
|
|
1473
|
+
|
|
1474
|
+
## FormCurrencyEmptyListPlaceholder
|
|
1475
|
+
|
|
1476
|
+
### Fields
|
|
1477
|
+
|
|
1478
|
+
| Name | Required | Type | Description |
|
|
1479
|
+
|---|---:|---|---|
|
|
1480
|
+
| `onLoading` | no | string | Placeholder shown while list is loading |
|
|
1481
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query entered |
|
|
1482
|
+
| `onNoSearchResults` | no | string | Placeholder when search returns no results |
|
|
1483
|
+
|
|
1484
|
+
No additional properties.
|
|
1485
|
+
|
|
1486
|
+
## FormCurrencyFuseOption
|
|
1487
|
+
|
|
1488
|
+
Fuse.js search options
|
|
1489
|
+
|
|
1490
|
+
### Fields
|
|
1491
|
+
|
|
1492
|
+
_No fields._
|
|
1493
|
+
|
|
1494
|
+
Additional properties: unknown.
|
|
1495
|
+
|
|
923
1496
|
## FormCurrencyValidationError
|
|
924
1497
|
|
|
925
1498
|
Map of rule name to error message
|
|
@@ -930,6 +1503,17 @@ _No fields._
|
|
|
930
1503
|
|
|
931
1504
|
Additional properties: string.
|
|
932
1505
|
|
|
1506
|
+
## FormCurrencyValue
|
|
1507
|
+
|
|
1508
|
+
### Fields
|
|
1509
|
+
|
|
1510
|
+
| Name | Required | Type | Description |
|
|
1511
|
+
|---|---:|---|---|
|
|
1512
|
+
| `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
|
|
1513
|
+
| `value` | yes | string \| number | Currency amount value |
|
|
1514
|
+
|
|
1515
|
+
No additional properties.
|
|
1516
|
+
|
|
933
1517
|
## FormDateRangeValidationError
|
|
934
1518
|
|
|
935
1519
|
Map of rule name to error message
|
|
@@ -948,9 +1532,64 @@ Map of rule name to error message
|
|
|
948
1532
|
|
|
949
1533
|
_No fields._
|
|
950
1534
|
|
|
951
|
-
Additional properties: string.
|
|
1535
|
+
Additional properties: string.
|
|
1536
|
+
|
|
1537
|
+
## FormDaySelectorRenderProp
|
|
1538
|
+
|
|
1539
|
+
Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string)
|
|
1540
|
+
|
|
1541
|
+
### Fields
|
|
1542
|
+
|
|
1543
|
+
_No fields._
|
|
1544
|
+
|
|
1545
|
+
Additional properties: [FormDaySelectorRenderPropValue](./types.md#formdayselectorrenderpropvalue).
|
|
1546
|
+
|
|
1547
|
+
## FormDaySelectorRenderPropValue
|
|
1548
|
+
|
|
1549
|
+
### Fields
|
|
1550
|
+
|
|
1551
|
+
| Name | Required | Type | Description |
|
|
1552
|
+
|---|---:|---|---|
|
|
1553
|
+
| `isDisabled` | no | boolean | |
|
|
1554
|
+
| `tip` | no | [FormDaySelectorTip](./types.md#formdayselectortip) | |
|
|
1555
|
+
|
|
1556
|
+
No additional properties.
|
|
1557
|
+
|
|
1558
|
+
## FormDaySelectorTip
|
|
1559
|
+
|
|
1560
|
+
### Fields
|
|
1561
|
+
|
|
1562
|
+
| Name | Required | Type | Description |
|
|
1563
|
+
|---|---:|---|---|
|
|
1564
|
+
| `content` | yes | string | |
|
|
1565
|
+
|
|
1566
|
+
No additional properties.
|
|
1567
|
+
|
|
1568
|
+
## FormDaySelectorValidationError
|
|
1569
|
+
|
|
1570
|
+
Map of rule name to error message
|
|
1571
|
+
|
|
1572
|
+
### Fields
|
|
1573
|
+
|
|
1574
|
+
_No fields._
|
|
1575
|
+
|
|
1576
|
+
Additional properties: string.
|
|
1577
|
+
|
|
1578
|
+
## FormEmailStringPadding
|
|
1579
|
+
|
|
1580
|
+
Pads input value with character until reaching maxLength
|
|
1581
|
+
|
|
1582
|
+
### Fields
|
|
1583
|
+
|
|
1584
|
+
| Name | Required | Type | Description |
|
|
1585
|
+
|---|---:|---|---|
|
|
1586
|
+
| `character` | yes | string | Character to use for padding |
|
|
1587
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1588
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
1589
|
+
|
|
1590
|
+
No additional properties.
|
|
952
1591
|
|
|
953
|
-
##
|
|
1592
|
+
## FormEmailValidationError
|
|
954
1593
|
|
|
955
1594
|
Map of rule name to error message
|
|
956
1595
|
|
|
@@ -960,15 +1599,15 @@ _No fields._
|
|
|
960
1599
|
|
|
961
1600
|
Additional properties: string.
|
|
962
1601
|
|
|
963
|
-
##
|
|
964
|
-
|
|
965
|
-
Map of rule name to error message
|
|
1602
|
+
## FormFileAllowCameraCapture
|
|
966
1603
|
|
|
967
1604
|
### Fields
|
|
968
1605
|
|
|
969
|
-
|
|
1606
|
+
| Name | Required | Type | Description |
|
|
1607
|
+
|---|---:|---|---|
|
|
1608
|
+
| `quality` | no | number | Captured image quality |
|
|
970
1609
|
|
|
971
|
-
|
|
1610
|
+
No additional properties.
|
|
972
1611
|
|
|
973
1612
|
## FormFileCropperConfig
|
|
974
1613
|
|
|
@@ -978,7 +1617,7 @@ Cropper configuration
|
|
|
978
1617
|
|
|
979
1618
|
| Name | Required | Type | Description |
|
|
980
1619
|
|---|---:|---|---|
|
|
981
|
-
| `aspectRatio` | no | [
|
|
1620
|
+
| `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
982
1621
|
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
983
1622
|
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
984
1623
|
| `title` | no | string | Title for the cropper modal |
|
|
@@ -994,14 +1633,26 @@ No additional properties.
|
|
|
994
1633
|
| `name` | no | string | File name |
|
|
995
1634
|
| `content` | no | string | File content as a base64 data URL |
|
|
996
1635
|
| `hasError` | no | boolean | Whether the file has an error |
|
|
1636
|
+
| `isMultipart` | no | boolean | Whether this is a multipart upload |
|
|
997
1637
|
| `previewUrl` | no | string | Preview URL for the file |
|
|
998
1638
|
| `progress` | no | number | Upload progress 0-100 |
|
|
1639
|
+
| `size` | no | number | File size in bytes |
|
|
999
1640
|
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
1000
1641
|
| `type` | no | string | MIME type of the file |
|
|
1001
1642
|
| `url` | no | string | URL of the uploaded file |
|
|
1002
1643
|
|
|
1003
1644
|
No additional properties.
|
|
1004
1645
|
|
|
1646
|
+
## FormFileDropAllowCameraCapture
|
|
1647
|
+
|
|
1648
|
+
### Fields
|
|
1649
|
+
|
|
1650
|
+
| Name | Required | Type | Description |
|
|
1651
|
+
|---|---:|---|---|
|
|
1652
|
+
| `quality` | no | number | Captured image quality |
|
|
1653
|
+
|
|
1654
|
+
No additional properties.
|
|
1655
|
+
|
|
1005
1656
|
## FormFileDropCropperConfig
|
|
1006
1657
|
|
|
1007
1658
|
Cropper configuration
|
|
@@ -1010,7 +1661,7 @@ Cropper configuration
|
|
|
1010
1661
|
|
|
1011
1662
|
| Name | Required | Type | Description |
|
|
1012
1663
|
|---|---:|---|---|
|
|
1013
|
-
| `aspectRatio` | no | [
|
|
1664
|
+
| `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
1014
1665
|
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
1015
1666
|
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
1016
1667
|
| `title` | no | string | Title for the cropper modal |
|
|
@@ -1050,14 +1701,14 @@ Additional properties: string.
|
|
|
1050
1701
|
|
|
1051
1702
|
| Name | Required | Type | Description |
|
|
1052
1703
|
|---|---:|---|---|
|
|
1053
|
-
| `name` | no | string |
|
|
1054
|
-
| `content` | no | string |
|
|
1055
|
-
| `hasError` | no | boolean |
|
|
1056
|
-
| `previewUrl` | no | string |
|
|
1057
|
-
| `progress` | no | number |
|
|
1058
|
-
| `tooltipText` | no | string |
|
|
1059
|
-
| `type` | no | string |
|
|
1060
|
-
| `url` | no | string |
|
|
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
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
1708
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
1709
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
1710
|
+
| `type` | no | string | MIME type of the file |
|
|
1711
|
+
| `url` | no | string | URL of the uploaded file |
|
|
1061
1712
|
|
|
1062
1713
|
No additional properties.
|
|
1063
1714
|
|
|
@@ -1077,14 +1728,28 @@ Additional properties: string.
|
|
|
1077
1728
|
|
|
1078
1729
|
| Name | Required | Type | Description |
|
|
1079
1730
|
|---|---:|---|---|
|
|
1080
|
-
| `name` | no | string |
|
|
1081
|
-
| `content` | no | string |
|
|
1082
|
-
| `hasError` | no | boolean |
|
|
1083
|
-
| `
|
|
1084
|
-
| `
|
|
1085
|
-
| `
|
|
1086
|
-
| `
|
|
1087
|
-
| `
|
|
1731
|
+
| `name` | no | string | File name |
|
|
1732
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
1733
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
1734
|
+
| `isMultipart` | no | boolean | Whether this is a multipart upload |
|
|
1735
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
1736
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
1737
|
+
| `size` | no | number | File size in bytes |
|
|
1738
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
1739
|
+
| `type` | no | string | MIME type of the file |
|
|
1740
|
+
| `url` | no | string | URL of the uploaded file |
|
|
1741
|
+
|
|
1742
|
+
No additional properties.
|
|
1743
|
+
|
|
1744
|
+
## FormIcon
|
|
1745
|
+
|
|
1746
|
+
### Fields
|
|
1747
|
+
|
|
1748
|
+
| Name | Required | Type | Description |
|
|
1749
|
+
|---|---:|---|---|
|
|
1750
|
+
| `alignment` | no | [ButtonIconAlignment](./definitions.md#buttoniconalignment) | Icon alignment relative to button label. Default: LEFT |
|
|
1751
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
1752
|
+
| `type` | yes | string | Icon type name from Icon.TYPES |
|
|
1088
1753
|
|
|
1089
1754
|
No additional properties.
|
|
1090
1755
|
|
|
@@ -1153,6 +1818,20 @@ _No fields._
|
|
|
1153
1818
|
|
|
1154
1819
|
Additional properties: string.
|
|
1155
1820
|
|
|
1821
|
+
## FormNumberStringPadding
|
|
1822
|
+
|
|
1823
|
+
Adds padding characters to the input value
|
|
1824
|
+
|
|
1825
|
+
### Fields
|
|
1826
|
+
|
|
1827
|
+
| Name | Required | Type | Description |
|
|
1828
|
+
|---|---:|---|---|
|
|
1829
|
+
| `character` | yes | string | Character to use for padding |
|
|
1830
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1831
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Position to pad (start or end) |
|
|
1832
|
+
|
|
1833
|
+
No additional properties.
|
|
1834
|
+
|
|
1156
1835
|
## FormNumberValidationError
|
|
1157
1836
|
|
|
1158
1837
|
Map of rule name to error message
|
|
@@ -1163,6 +1842,20 @@ _No fields._
|
|
|
1163
1842
|
|
|
1164
1843
|
Additional properties: string.
|
|
1165
1844
|
|
|
1845
|
+
## FormPasswordStringPadding
|
|
1846
|
+
|
|
1847
|
+
Pads input value with character until reaching maxLength
|
|
1848
|
+
|
|
1849
|
+
### Fields
|
|
1850
|
+
|
|
1851
|
+
| Name | Required | Type | Description |
|
|
1852
|
+
|---|---:|---|---|
|
|
1853
|
+
| `character` | yes | string | Character to use for padding |
|
|
1854
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1855
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
1856
|
+
|
|
1857
|
+
No additional properties.
|
|
1858
|
+
|
|
1166
1859
|
## FormPasswordValidationError
|
|
1167
1860
|
|
|
1168
1861
|
Map of rule name to error message
|
|
@@ -1183,6 +1876,79 @@ _No fields._
|
|
|
1183
1876
|
|
|
1184
1877
|
Additional properties: string.
|
|
1185
1878
|
|
|
1879
|
+
## FormPhoneCountryCode
|
|
1880
|
+
|
|
1881
|
+
Country-code dropdown configuration preserving the serializable CountryCodeProp shape
|
|
1882
|
+
|
|
1883
|
+
### Fields
|
|
1884
|
+
|
|
1885
|
+
| Name | Required | Type | Description |
|
|
1886
|
+
|---|---:|---|---|
|
|
1887
|
+
| `name` | no | string | Name for the country-code select input |
|
|
1888
|
+
| `aria-describedby` | no | string | ID of the element that describes the country-code dropdown |
|
|
1889
|
+
| `aria-label` | no | string | Accessible label for the country-code dropdown |
|
|
1890
|
+
| `aria-labelledby` | no | string | ID of the element that labels the country-code dropdown |
|
|
1891
|
+
| `canClear` | no | boolean | Show clear button in the country-code dropdown |
|
|
1892
|
+
| `defaultSearchQuery` | no | string | Initial search query for the country-code dropdown |
|
|
1893
|
+
| `defaultValue` | no | string | Initial selected country code for the dropdown branch |
|
|
1894
|
+
| `dropdownHeight` | no | number | Country-code dropdown menu height in pixels |
|
|
1895
|
+
| `emptyListPlaceholder` | no | string \| [FormPhoneEmptyListPlaceholder](./types.md#formphoneemptylistplaceholder) | Placeholder shown when the country-code dropdown list is empty |
|
|
1896
|
+
| `fuseOptions` | no | [FormPhoneFuseOption](./types.md#formphonefuseoption) | Fuse.js search options for the country-code dropdown |
|
|
1897
|
+
| `id` | no | string | HTML id attribute for the country-code select input |
|
|
1898
|
+
| `isDisabled` | no | boolean | Disables the country-code dropdown |
|
|
1899
|
+
| `isMenuDefaultOpen` | no | boolean | If true, the country-code dropdown opens by default |
|
|
1900
|
+
| `isPositionFixed` | no | boolean | Position the country-code dropdown relative to the viewport |
|
|
1901
|
+
| `isReadOnly` | no | boolean | Makes the country-code dropdown read-only |
|
|
1902
|
+
| `isRequired` | no | boolean | Marks the country-code dropdown as required |
|
|
1903
|
+
| `maxHeight` | no | string \| number | Maximum dropdown height or chip container height as a CSS value |
|
|
1904
|
+
| `placement` | no | [AppGroupSelectPlacement](./definitions.md#appgroupselectplacement) | Country-code dropdown placement. Default: bottom-start |
|
|
1905
|
+
| `rows` | no | number | Minimum row count for the country-code dropdown |
|
|
1906
|
+
| `scrollThreshold` | no | number | Extra pixels rendered above and below the viewport in paginated mode |
|
|
1907
|
+
| `shouldFocusFirstElement` | no | boolean | Auto-focus the first dropdown item when the menu opens |
|
|
1908
|
+
| `shouldShowSearchIcon` | no | boolean | Show the search icon inside the country-code dropdown |
|
|
1909
|
+
| `shouldUsePortal` | no | boolean | Render the country-code dropdown in a React portal |
|
|
1910
|
+
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Country-code dropdown size. Default: M |
|
|
1911
|
+
| `theme` | no | [FormTimezoneTheme](./definitions.md#formtimezonetheme) | Country-code dropdown theme variant |
|
|
1912
|
+
| `value` | no | string | Controlled selected country code for the dropdown branch |
|
|
1913
|
+
|
|
1914
|
+
No additional properties.
|
|
1915
|
+
|
|
1916
|
+
## FormPhoneEmptyListPlaceholder
|
|
1917
|
+
|
|
1918
|
+
### Fields
|
|
1919
|
+
|
|
1920
|
+
| Name | Required | Type | Description |
|
|
1921
|
+
|---|---:|---|---|
|
|
1922
|
+
| `onLoading` | no | string | Placeholder shown while the dropdown list is loading |
|
|
1923
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query is entered |
|
|
1924
|
+
| `onNoSearchResults` | no | string | Placeholder shown when no matching regions are found |
|
|
1925
|
+
|
|
1926
|
+
No additional properties.
|
|
1927
|
+
|
|
1928
|
+
## FormPhoneFuseOption
|
|
1929
|
+
|
|
1930
|
+
Fuse.js search options for the country-code dropdown
|
|
1931
|
+
|
|
1932
|
+
### Fields
|
|
1933
|
+
|
|
1934
|
+
_No fields._
|
|
1935
|
+
|
|
1936
|
+
Additional properties: unknown.
|
|
1937
|
+
|
|
1938
|
+
## FormPhoneStringPadding
|
|
1939
|
+
|
|
1940
|
+
Pads input value with character until reaching maxLength
|
|
1941
|
+
|
|
1942
|
+
### Fields
|
|
1943
|
+
|
|
1944
|
+
| Name | Required | Type | Description |
|
|
1945
|
+
|---|---:|---|---|
|
|
1946
|
+
| `character` | yes | string | Character to use for padding |
|
|
1947
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1948
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
1949
|
+
|
|
1950
|
+
No additional properties.
|
|
1951
|
+
|
|
1186
1952
|
## FormPhoneValidationError
|
|
1187
1953
|
|
|
1188
1954
|
Map of rule name to error message
|
|
@@ -1193,7 +1959,7 @@ _No fields._
|
|
|
1193
1959
|
|
|
1194
1960
|
Additional properties: string.
|
|
1195
1961
|
|
|
1196
|
-
##
|
|
1962
|
+
## FormRadioList
|
|
1197
1963
|
|
|
1198
1964
|
### Fields
|
|
1199
1965
|
|
|
@@ -1230,7 +1996,7 @@ _No fields._
|
|
|
1230
1996
|
|
|
1231
1997
|
Additional properties: string.
|
|
1232
1998
|
|
|
1233
|
-
##
|
|
1999
|
+
## FormSegmentedControlList
|
|
1234
2000
|
|
|
1235
2001
|
### Fields
|
|
1236
2002
|
|
|
@@ -1246,6 +2012,19 @@ Additional properties: string.
|
|
|
1246
2012
|
|
|
1247
2013
|
No additional properties.
|
|
1248
2014
|
|
|
2015
|
+
## FormSegmentedControlRangeLabel
|
|
2016
|
+
|
|
2017
|
+
Labels to display at the start and end of the control range
|
|
2018
|
+
|
|
2019
|
+
### Fields
|
|
2020
|
+
|
|
2021
|
+
| Name | Required | Type | Description |
|
|
2022
|
+
|---|---:|---|---|
|
|
2023
|
+
| `end` | yes | string | Label at the end of the range |
|
|
2024
|
+
| `start` | yes | string | Label at the start of the range |
|
|
2025
|
+
|
|
2026
|
+
No additional properties.
|
|
2027
|
+
|
|
1249
2028
|
## FormSegmentedControlTip
|
|
1250
2029
|
|
|
1251
2030
|
Tooltip to show on hover for this option
|
|
@@ -1299,7 +2078,29 @@ Avatar configuration for the option
|
|
|
1299
2078
|
|
|
1300
2079
|
No additional properties.
|
|
1301
2080
|
|
|
1302
|
-
##
|
|
2081
|
+
## FormSelectEmptyListPlaceholder
|
|
2082
|
+
|
|
2083
|
+
### Fields
|
|
2084
|
+
|
|
2085
|
+
| Name | Required | Type | Description |
|
|
2086
|
+
|---|---:|---|---|
|
|
2087
|
+
| `onLoading` | no | string | Placeholder shown while list is loading |
|
|
2088
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query entered |
|
|
2089
|
+
| `onNoSearchResults` | no | string | Placeholder when search returns no results |
|
|
2090
|
+
|
|
2091
|
+
No additional properties.
|
|
2092
|
+
|
|
2093
|
+
## FormSelectFuseOption
|
|
2094
|
+
|
|
2095
|
+
Fuse.js search options for customizing fuzzy search behavior
|
|
2096
|
+
|
|
2097
|
+
### Fields
|
|
2098
|
+
|
|
2099
|
+
_No fields._
|
|
2100
|
+
|
|
2101
|
+
Additional properties: unknown.
|
|
2102
|
+
|
|
2103
|
+
## FormSelectList
|
|
1303
2104
|
|
|
1304
2105
|
### Fields
|
|
1305
2106
|
|
|
@@ -1388,9 +2189,10 @@ Additional properties: string.
|
|
|
1388
2189
|
|
|
1389
2190
|
| Name | Required | Type | Description |
|
|
1390
2191
|
|---|---:|---|---|
|
|
2192
|
+
| `icon` | no | string | Pebble icon name displayed for the option |
|
|
1391
2193
|
| `isDisabled` | no | boolean | Disable this specific option |
|
|
1392
2194
|
| `label` | no | string \| number | Display label for the option |
|
|
1393
|
-
| `selectionColor` | no | [
|
|
2195
|
+
| `selectionColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Override selected surface color token for this option |
|
|
1394
2196
|
| `value` | yes | string \| number | Value when selected |
|
|
1395
2197
|
|
|
1396
2198
|
No additional properties.
|
|
@@ -1418,6 +2220,30 @@ _No fields._
|
|
|
1418
2220
|
|
|
1419
2221
|
Additional properties: string.
|
|
1420
2222
|
|
|
2223
|
+
## FormSwitchTip
|
|
2224
|
+
|
|
2225
|
+
### Fields
|
|
2226
|
+
|
|
2227
|
+
| Name | Required | Type | Description |
|
|
2228
|
+
|---|---:|---|---|
|
|
2229
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip theme. Default: LIGHT |
|
|
2230
|
+
| `content` | yes | string | Tooltip text content |
|
|
2231
|
+
| `hideOnDocumentScroll` | no | boolean | Hide tooltip when the document is scrolled. Default: false |
|
|
2232
|
+
| `isDelayed` | no | boolean | Add delay before showing/hiding the tooltip. Default: false |
|
|
2233
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
|
|
2234
|
+
| `isPositionFixed` | no | boolean | Use fixed positioning for the tooltip. Default: false |
|
|
2235
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent. Overrides hover behavior when set |
|
|
2236
|
+
| `maxHeight` | no | number \| string | Max height of tooltip content. Number in px or CSS string |
|
|
2237
|
+
| `maxWidth` | no | number \| string | Max width of tooltip. Number in px or CSS string. Default: 360 |
|
|
2238
|
+
| `onlyIfChildOverflow` | no | boolean | Only show tooltip if a child element overflows. Default: false |
|
|
2239
|
+
| `onlyIfOverflow` | no | boolean | Only show tooltip if the trigger element overflows. Default: false |
|
|
2240
|
+
| `placement` | no | [TipPlacement](./definitions.md#tipplacement) | Tooltip position relative to child. Default: bottom |
|
|
2241
|
+
| `tipHideDelay` | no | number | Custom delay in ms before tooltip hides |
|
|
2242
|
+
| `tipShowDelay` | no | number | Custom delay in ms before tooltip appears |
|
|
2243
|
+
| `title` | no | string | Optional bold title above tooltip content |
|
|
2244
|
+
|
|
2245
|
+
No additional properties.
|
|
2246
|
+
|
|
1421
2247
|
## FormSwitchValidationError
|
|
1422
2248
|
|
|
1423
2249
|
Map of rule name to error message
|
|
@@ -1438,16 +2264,27 @@ _No fields._
|
|
|
1438
2264
|
|
|
1439
2265
|
Additional properties: string.
|
|
1440
2266
|
|
|
1441
|
-
##
|
|
2267
|
+
## FormTextAutoSuggestFuseOption
|
|
2268
|
+
|
|
2269
|
+
Fuse.js search options for customizing suggestion filtering
|
|
2270
|
+
|
|
2271
|
+
### Fields
|
|
2272
|
+
|
|
2273
|
+
_No fields._
|
|
2274
|
+
|
|
2275
|
+
Additional properties: unknown.
|
|
2276
|
+
|
|
2277
|
+
## FormTextAutoSuggestList
|
|
1442
2278
|
|
|
1443
2279
|
### Fields
|
|
1444
2280
|
|
|
1445
2281
|
| Name | Required | Type | Description |
|
|
1446
2282
|
|---|---:|---|---|
|
|
1447
|
-
| `
|
|
1448
|
-
| `
|
|
2283
|
+
| `isDisabled` | no | boolean | Disables selection for this suggestion item |
|
|
2284
|
+
| `label` | no | string | Display text shown for the suggestion item |
|
|
2285
|
+
| `value` | no | string \| number | Value written when the suggestion is selected |
|
|
1449
2286
|
|
|
1450
|
-
|
|
2287
|
+
Additional properties: unknown.
|
|
1451
2288
|
|
|
1452
2289
|
## FormTextAutoSuggestValidationError
|
|
1453
2290
|
|
|
@@ -1459,6 +2296,20 @@ _No fields._
|
|
|
1459
2296
|
|
|
1460
2297
|
Additional properties: string.
|
|
1461
2298
|
|
|
2299
|
+
## FormTextStringPadding
|
|
2300
|
+
|
|
2301
|
+
Pads input value with character until reaching maxLength
|
|
2302
|
+
|
|
2303
|
+
### Fields
|
|
2304
|
+
|
|
2305
|
+
| Name | Required | Type | Description |
|
|
2306
|
+
|---|---:|---|---|
|
|
2307
|
+
| `character` | yes | string | Character to use for padding |
|
|
2308
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
2309
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
2310
|
+
|
|
2311
|
+
No additional properties.
|
|
2312
|
+
|
|
1462
2313
|
## FormTextValidationError
|
|
1463
2314
|
|
|
1464
2315
|
Map of rule name to error message
|
|
@@ -1469,6 +2320,28 @@ _No fields._
|
|
|
1469
2320
|
|
|
1470
2321
|
Additional properties: string.
|
|
1471
2322
|
|
|
2323
|
+
## FormTimeShouldAllowTimeSelection
|
|
2324
|
+
|
|
2325
|
+
### Fields
|
|
2326
|
+
|
|
2327
|
+
| Name | Required | Type | Description |
|
|
2328
|
+
|---|---:|---|---|
|
|
2329
|
+
| `reference` | no | string | Reference ISO time for period labels |
|
|
2330
|
+
|
|
2331
|
+
No additional properties.
|
|
2332
|
+
|
|
2333
|
+
## FormTimeTimezone
|
|
2334
|
+
|
|
2335
|
+
### Fields
|
|
2336
|
+
|
|
2337
|
+
| Name | Required | Type | Description |
|
|
2338
|
+
|---|---:|---|---|
|
|
2339
|
+
| `name` | yes | string | Input name for the timezone selector |
|
|
2340
|
+
| `isRequired` | no | boolean | Marks the timezone selector as required |
|
|
2341
|
+
| `value` | no | string | Selected timezone value |
|
|
2342
|
+
|
|
2343
|
+
No additional properties.
|
|
2344
|
+
|
|
1472
2345
|
## FormTimeValidationError
|
|
1473
2346
|
|
|
1474
2347
|
Map of rule name to error message
|
|
@@ -1520,6 +2393,7 @@ Additional properties: unknown.
|
|
|
1520
2393
|
|---|---:|---|---|
|
|
1521
2394
|
| `disabledInfo` | no | string \| [FormTreeDisabledInfo](./types.md#formtreedisabledinfo) | Tooltip shown when item is disabled |
|
|
1522
2395
|
| `isDisabled` | no | boolean | Disable this item |
|
|
2396
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
1523
2397
|
| `label` | yes | string | Display label for the item |
|
|
1524
2398
|
| `parent` | no | string | Parent item value, null for root items |
|
|
1525
2399
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -1545,6 +2419,7 @@ Additional properties: unknown.
|
|
|
1545
2419
|
| Name | Required | Type | Description |
|
|
1546
2420
|
|---|---:|---|---|
|
|
1547
2421
|
| `isDisabled` | no | boolean | Disable this item |
|
|
2422
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
1548
2423
|
| `label` | yes | string | Display label for the item |
|
|
1549
2424
|
| `parent` | no | string | Parent item value, null for root items |
|
|
1550
2425
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -1603,6 +2478,30 @@ _No fields._
|
|
|
1603
2478
|
|
|
1604
2479
|
Additional properties: unknown.
|
|
1605
2480
|
|
|
2481
|
+
## FormWorkEmailDomainList
|
|
2482
|
+
|
|
2483
|
+
### Fields
|
|
2484
|
+
|
|
2485
|
+
| Name | Required | Type | Description |
|
|
2486
|
+
|---|---:|---|---|
|
|
2487
|
+
| `isDisabled` | no | boolean | Disables this specific domain option |
|
|
2488
|
+
| `label` | no | string | Display label for the domain option |
|
|
2489
|
+
| `tag` | no | string \| [FormWorkEmailTag](./types.md#formworkemailtag) | Optional tag shown with the domain option |
|
|
2490
|
+
| `value` | yes | string | Domain option value |
|
|
2491
|
+
|
|
2492
|
+
No additional properties.
|
|
2493
|
+
|
|
2494
|
+
## FormWorkEmailTag
|
|
2495
|
+
|
|
2496
|
+
### Fields
|
|
2497
|
+
|
|
2498
|
+
| Name | Required | Type | Description |
|
|
2499
|
+
|---|---:|---|---|
|
|
2500
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Optional semantic appearance for the tag |
|
|
2501
|
+
| `text` | yes | string | Tag text displayed with the domain option |
|
|
2502
|
+
|
|
2503
|
+
No additional properties.
|
|
2504
|
+
|
|
1606
2505
|
## FormWorkEmailValidationError
|
|
1607
2506
|
|
|
1608
2507
|
Map of rule name to error message
|
|
@@ -1656,6 +2555,19 @@ No additional properties.
|
|
|
1656
2555
|
|
|
1657
2556
|
No additional properties.
|
|
1658
2557
|
|
|
2558
|
+
## GridListVariant2
|
|
2559
|
+
|
|
2560
|
+
### Fields
|
|
2561
|
+
|
|
2562
|
+
| Name | Required | Type | Description |
|
|
2563
|
+
|---|---:|---|---|
|
|
2564
|
+
| `label` | yes | string \| number | Label displayed in the cell header. String or number value |
|
|
2565
|
+
| `props` | yes | [GridProp](./types.md#gridprop) | Props passed to TextRenderer: { value, color? }. Color must be a Pebble text/icon color token. |
|
|
2566
|
+
| `renderer` | no | "TEXT" | Renderer type for the cell value. TEXT displays plain text. Default: TEXT |
|
|
2567
|
+
| `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
|
|
2568
|
+
|
|
2569
|
+
No additional properties.
|
|
2570
|
+
|
|
1659
2571
|
## GridProp
|
|
1660
2572
|
|
|
1661
2573
|
Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
|
|
@@ -1669,7 +2581,7 @@ Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens
|
|
|
1669
2581
|
| `leftIcon` | no | string \| [GridLeftIcon](./types.md#gridlefticon) | Icon displayed on the left side of the label |
|
|
1670
2582
|
| `maxWidth` | no | string | Maximum width CSS value for truncation |
|
|
1671
2583
|
| `rightIcon` | no | string \| [GridRightIcon](./types.md#gridrighticon) | Icon displayed on the right side of the label |
|
|
1672
|
-
| `size` | no | [
|
|
2584
|
+
| `size` | no | [ChipSize](./definitions.md#chipsize) | Size of the label. Default: LARGE |
|
|
1673
2585
|
| `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
|
|
1674
2586
|
| `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
|
|
1675
2587
|
|
|
@@ -1758,8 +2670,12 @@ No additional properties.
|
|
|
1758
2670
|
|
|
1759
2671
|
| Name | Required | Type | Description |
|
|
1760
2672
|
|---|---:|---|---|
|
|
2673
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
|
|
1761
2674
|
| `content` | yes | string | Tooltip content text |
|
|
1762
|
-
| `
|
|
2675
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent |
|
|
2676
|
+
| `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
|
|
2677
|
+
| `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
|
|
2678
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to button. Default: TOP_START |
|
|
1763
2679
|
|
|
1764
2680
|
No additional properties.
|
|
1765
2681
|
|
|
@@ -1901,6 +2817,24 @@ No additional properties.
|
|
|
1901
2817
|
|
|
1902
2818
|
No additional properties.
|
|
1903
2819
|
|
|
2820
|
+
## LabelValue
|
|
2821
|
+
|
|
2822
|
+
Label chip displayed next to the title
|
|
2823
|
+
|
|
2824
|
+
### Fields
|
|
2825
|
+
|
|
2826
|
+
| Name | Required | Type | Description |
|
|
2827
|
+
|---|---:|---|---|
|
|
2828
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Label appearance. Default: NEUTRAL |
|
|
2829
|
+
| `children` | no | string | Label text displayed in the chip |
|
|
2830
|
+
| `leftIcon` | no | string \| [ObjectUIHeaderLeftIcon](./types.md#objectuiheaderlefticon) | Left icon shown inside the label |
|
|
2831
|
+
| `maxWidth` | no | string | Maximum label width as a CSS value |
|
|
2832
|
+
| `rightIcon` | no | string \| [ObjectUIHeaderRightIcon](./types.md#objectuiheaderrighticon) | Right icon shown inside the label |
|
|
2833
|
+
| `size` | no | [ChipSize](./definitions.md#chipsize) | Label size. Default: LARGE |
|
|
2834
|
+
| `tip` | no | string | Tooltip text for the label. String tip content only in SDUI |
|
|
2835
|
+
|
|
2836
|
+
No additional properties.
|
|
2837
|
+
|
|
1904
2838
|
## LayoutBorder
|
|
1905
2839
|
|
|
1906
2840
|
Structured border using strict token parts
|
|
@@ -1986,6 +2920,43 @@ No additional properties.
|
|
|
1986
2920
|
|
|
1987
2921
|
No additional properties.
|
|
1988
2922
|
|
|
2923
|
+
## LinkValue
|
|
2924
|
+
|
|
2925
|
+
### Fields
|
|
2926
|
+
|
|
2927
|
+
| Name | Required | Type | Description |
|
|
2928
|
+
|---|---:|---|---|
|
|
2929
|
+
| `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the nested link tab |
|
|
2930
|
+
| `title` | yes | string | Display text for the nested link tab |
|
|
2931
|
+
|
|
2932
|
+
No additional properties.
|
|
2933
|
+
|
|
2934
|
+
## ListVariant3
|
|
2935
|
+
|
|
2936
|
+
### Fields
|
|
2937
|
+
|
|
2938
|
+
| Name | Required | Type | Description |
|
|
2939
|
+
|---|---:|---|---|
|
|
2940
|
+
| `isSeparator` | yes | true | Render a visual separator |
|
|
2941
|
+
|
|
2942
|
+
No additional properties.
|
|
2943
|
+
|
|
2944
|
+
## LoadConfig
|
|
2945
|
+
|
|
2946
|
+
Semantic Lottie load configuration object
|
|
2947
|
+
|
|
2948
|
+
### Fields
|
|
2949
|
+
|
|
2950
|
+
| Name | Required | Type | Description |
|
|
2951
|
+
|---|---:|---|---|
|
|
2952
|
+
| `animationData` | no | [AnimationData](./types.md#animationdata) | Lottie animation JSON object. Required if path is not provided |
|
|
2953
|
+
| `autoplay` | no | boolean | Start playing automatically on load. Default: true |
|
|
2954
|
+
| `loop` | no | boolean \| number | Loop animation. true for infinite, false for once, or number for specific count |
|
|
2955
|
+
| `path` | no | string | URL or relative path to the Lottie JSON animation file. Required if animationData is not provided |
|
|
2956
|
+
| `renderer` | no | [LoadConfigRenderer](./definitions.md#loadconfigrenderer) | Rendering method for the animation. Default: svg |
|
|
2957
|
+
|
|
2958
|
+
No additional properties.
|
|
2959
|
+
|
|
1989
2960
|
## Location
|
|
1990
2961
|
|
|
1991
2962
|
Location object with nickname and address. Required for displaying location information
|
|
@@ -2058,7 +3029,7 @@ No additional properties.
|
|
|
2058
3029
|
| `secondaryLabel` | no | string | Secondary text shown below the label |
|
|
2059
3030
|
| `tag` | no | string | Tag label shown beside the item text |
|
|
2060
3031
|
| `tertiaryLabel` | no | string | Tertiary text shown below secondary label |
|
|
2061
|
-
| `type` | no | [
|
|
3032
|
+
| `type` | no | [DropdownFooterType](./definitions.md#dropdownfootertype) | Visual style type for the item (WARNING or ALERT) |
|
|
2062
3033
|
| `value` | yes | string | Unique value for the item |
|
|
2063
3034
|
|
|
2064
3035
|
No additional properties.
|
|
@@ -2073,6 +3044,20 @@ _No fields._
|
|
|
2073
3044
|
|
|
2074
3045
|
Additional properties: unknown.
|
|
2075
3046
|
|
|
3047
|
+
## NestedListToggleIcon
|
|
3048
|
+
|
|
3049
|
+
Toggle icon configuration
|
|
3050
|
+
|
|
3051
|
+
### Fields
|
|
3052
|
+
|
|
3053
|
+
| Name | Required | Type | Description |
|
|
3054
|
+
|---|---:|---|---|
|
|
3055
|
+
| `align` | no | string | CSS alignSelf value. Default: center |
|
|
3056
|
+
| `margin` | no | [BoxGap](./definitions.md#boxgap) | Margin spacing token for icon alignment |
|
|
3057
|
+
| `size` | no | [IconSize](./definitions.md#iconsize) | Icon size token. Default: 24 |
|
|
3058
|
+
|
|
3059
|
+
No additional properties.
|
|
3060
|
+
|
|
2076
3061
|
## NumberArg
|
|
2077
3062
|
|
|
2078
3063
|
### Fields
|
|
@@ -2103,7 +3088,7 @@ Adds padding characters to the input value
|
|
|
2103
3088
|
|---|---:|---|---|
|
|
2104
3089
|
| `character` | yes | string | Character to use for padding |
|
|
2105
3090
|
| `maxLength` | yes | number | Target length after padding |
|
|
2106
|
-
| `position` | yes | [
|
|
3091
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Position to pad (start or end) |
|
|
2107
3092
|
|
|
2108
3093
|
No additional properties.
|
|
2109
3094
|
|
|
@@ -2117,7 +3102,7 @@ Avatar configuration for the header
|
|
|
2117
3102
|
|---|---:|---|---|
|
|
2118
3103
|
| `icon` | no | string | Icon type string when type is ICON |
|
|
2119
3104
|
| `image` | no | string | Image URL for the avatar |
|
|
2120
|
-
| `imageBackground` | no | [
|
|
3105
|
+
| `imageBackground` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color token for avatar image background |
|
|
2121
3106
|
| `isRound` | no | boolean | If false, square avatar is shown. Default: true |
|
|
2122
3107
|
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
|
|
2123
3108
|
|
|
@@ -2133,12 +3118,54 @@ Avatar configuration for the header
|
|
|
2133
3118
|
|---|---:|---|---|
|
|
2134
3119
|
| `icon` | no | string | Icon type string when type is ICON |
|
|
2135
3120
|
| `image` | no | string | Image URL for the avatar |
|
|
2136
|
-
| `imageBackground` | no | [
|
|
3121
|
+
| `imageBackground` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color token for avatar image background |
|
|
2137
3122
|
| `isRound` | no | boolean | If false, square avatar is shown. Default: true |
|
|
2138
3123
|
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
|
|
2139
3124
|
|
|
2140
3125
|
No additional properties.
|
|
2141
3126
|
|
|
3127
|
+
## ObjectUIHeaderLeftIcon
|
|
3128
|
+
|
|
3129
|
+
### Fields
|
|
3130
|
+
|
|
3131
|
+
| Name | Required | Type | Description |
|
|
3132
|
+
|---|---:|---|---|
|
|
3133
|
+
| `aria-describedby` | no | string | ID of the element describing the icon |
|
|
3134
|
+
| `aria-label` | no | string | Accessible label for the icon |
|
|
3135
|
+
| `aria-labelledby` | no | string | ID of the element labelling the icon |
|
|
3136
|
+
| `color` | no | string | Optional icon color value |
|
|
3137
|
+
| `type` | yes | string | Icon type string to render inside the label |
|
|
3138
|
+
|
|
3139
|
+
No additional properties.
|
|
3140
|
+
|
|
3141
|
+
## ObjectUIHeaderPrimaryAction
|
|
3142
|
+
|
|
3143
|
+
Primary action button. Clicking it emits the primaryAction event
|
|
3144
|
+
|
|
3145
|
+
### Fields
|
|
3146
|
+
|
|
3147
|
+
| Name | Required | Type | Description |
|
|
3148
|
+
|---|---:|---|---|
|
|
3149
|
+
| `icon` | no | string | Icon type string for the primary button |
|
|
3150
|
+
| `label` | yes | string | Label of the primary button |
|
|
3151
|
+
| `size` | no | [ButtonSize](./definitions.md#buttonsize) | Primary button size. Default: M |
|
|
3152
|
+
|
|
3153
|
+
No additional properties.
|
|
3154
|
+
|
|
3155
|
+
## ObjectUIHeaderRightIcon
|
|
3156
|
+
|
|
3157
|
+
### Fields
|
|
3158
|
+
|
|
3159
|
+
| Name | Required | Type | Description |
|
|
3160
|
+
|---|---:|---|---|
|
|
3161
|
+
| `aria-describedby` | no | string | ID of the element describing the icon |
|
|
3162
|
+
| `aria-label` | no | string | Accessible label for the icon |
|
|
3163
|
+
| `aria-labelledby` | no | string | ID of the element labelling the icon |
|
|
3164
|
+
| `color` | no | string | Optional icon color value |
|
|
3165
|
+
| `type` | yes | string | Icon type string to render inside the label |
|
|
3166
|
+
|
|
3167
|
+
No additional properties.
|
|
3168
|
+
|
|
2142
3169
|
## ObjectUIStatsAction
|
|
2143
3170
|
|
|
2144
3171
|
### Fields
|
|
@@ -2182,6 +3209,19 @@ No additional properties.
|
|
|
2182
3209
|
|
|
2183
3210
|
No additional properties.
|
|
2184
3211
|
|
|
3212
|
+
## ObjectUIStatsListVariant2
|
|
3213
|
+
|
|
3214
|
+
### Fields
|
|
3215
|
+
|
|
3216
|
+
| Name | Required | Type | Description |
|
|
3217
|
+
|---|---:|---|---|
|
|
3218
|
+
| `label` | yes | string \| number | Label displayed in the cell header. String or number value |
|
|
3219
|
+
| `props` | yes | [ObjectUIStatsProp](./types.md#objectuistatsprop) | Props passed to TextRenderer: { value, color? }. Color must be a Pebble text/icon color token. |
|
|
3220
|
+
| `renderer` | no | "TEXT" | Renderer type for the cell value. TEXT displays plain text. Default: TEXT |
|
|
3221
|
+
| `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
|
|
3222
|
+
|
|
3223
|
+
No additional properties.
|
|
3224
|
+
|
|
2185
3225
|
## ObjectUIStatsProp
|
|
2186
3226
|
|
|
2187
3227
|
Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
|
|
@@ -2195,7 +3235,7 @@ Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens
|
|
|
2195
3235
|
| `leftIcon` | no | string \| [ObjectUIStatsLeftIcon](./types.md#objectuistatslefticon) | Icon displayed on the left side of the label |
|
|
2196
3236
|
| `maxWidth` | no | string | Maximum width CSS value for truncation |
|
|
2197
3237
|
| `rightIcon` | no | string \| [ObjectUIStatsRightIcon](./types.md#objectuistatsrighticon) | Icon displayed on the right side of the label |
|
|
2198
|
-
| `size` | no | [
|
|
3238
|
+
| `size` | no | [ChipSize](./definitions.md#chipsize) | Size of the label. Default: LARGE |
|
|
2199
3239
|
| `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
|
|
2200
3240
|
| `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
|
|
2201
3241
|
|
|
@@ -2236,7 +3276,7 @@ No additional properties.
|
|
|
2236
3276
|
|
|
2237
3277
|
| Name | Required | Type | Description |
|
|
2238
3278
|
|---|---:|---|---|
|
|
2239
|
-
| `actionType` | no | [PageHeaderActionActionType](./definitions.md#pageheaderactionactiontype) | Type of action
|
|
3279
|
+
| `actionType` | no | [PageHeaderActionActionType](./definitions.md#pageheaderactionactiontype) | JSON-only extension. Type of action renderer. Default: button |
|
|
2240
3280
|
| `appearance` | no | [AppNavBarActionAppearance](./definitions.md#appnavbaractionappearance) | Button visual style. Default: PRIMARY |
|
|
2241
3281
|
| `icon` | no | string | Icon name from Icon.TYPES (e.g. ADD, EDIT_OUTLINE) |
|
|
2242
3282
|
| `id` | yes | string | Unique identifier for the action. Written to actionClickedId state on click |
|
|
@@ -2298,7 +3338,7 @@ Pads input value with character until reaching maxLength
|
|
|
2298
3338
|
|---|---:|---|---|
|
|
2299
3339
|
| `character` | yes | string | Character to use for padding |
|
|
2300
3340
|
| `maxLength` | yes | number | Target length after padding |
|
|
2301
|
-
| `position` | yes | [
|
|
3341
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
2302
3342
|
|
|
2303
3343
|
No additional properties.
|
|
2304
3344
|
|
|
@@ -2342,23 +3382,58 @@ Additional properties: unknown.
|
|
|
2342
3382
|
|
|
2343
3383
|
No additional properties.
|
|
2344
3384
|
|
|
2345
|
-
##
|
|
3385
|
+
## PhoneCountryCode
|
|
2346
3386
|
|
|
2347
|
-
|
|
3387
|
+
Country-code dropdown configuration preserving the serializable CountryCodeProp shape
|
|
2348
3388
|
|
|
2349
3389
|
### Fields
|
|
2350
3390
|
|
|
2351
3391
|
| Name | Required | Type | Description |
|
|
2352
3392
|
|---|---:|---|---|
|
|
2353
|
-
| `
|
|
2354
|
-
| `
|
|
2355
|
-
| `
|
|
3393
|
+
| `name` | no | string | Name for the country-code select input |
|
|
3394
|
+
| `aria-describedby` | no | string | ID of the element that describes the country-code dropdown |
|
|
3395
|
+
| `aria-label` | no | string | Accessible label for the country-code dropdown |
|
|
3396
|
+
| `aria-labelledby` | no | string | ID of the element that labels the country-code dropdown |
|
|
3397
|
+
| `canClear` | no | boolean | Show clear button in the country-code dropdown |
|
|
3398
|
+
| `defaultSearchQuery` | no | string | Initial search query for the country-code dropdown |
|
|
3399
|
+
| `defaultValue` | no | string | Initial selected country code for the dropdown branch |
|
|
3400
|
+
| `dropdownHeight` | no | number | Country-code dropdown menu height in pixels |
|
|
3401
|
+
| `emptyListPlaceholder` | no | string \| [PhoneEmptyListPlaceholder](./types.md#phoneemptylistplaceholder) | Placeholder shown when the country-code dropdown list is empty |
|
|
3402
|
+
| `fuseOptions` | no | [PhoneFuseOption](./types.md#phonefuseoption) | Fuse.js search options for the country-code dropdown |
|
|
3403
|
+
| `id` | no | string | HTML id attribute for the country-code select input |
|
|
3404
|
+
| `isDisabled` | no | boolean | Disables the country-code dropdown |
|
|
3405
|
+
| `isMenuDefaultOpen` | no | boolean | If true, the country-code dropdown opens by default |
|
|
3406
|
+
| `isPositionFixed` | no | boolean | Position the country-code dropdown relative to the viewport |
|
|
3407
|
+
| `isReadOnly` | no | boolean | Makes the country-code dropdown read-only |
|
|
3408
|
+
| `isRequired` | no | boolean | Marks the country-code dropdown as required |
|
|
3409
|
+
| `maxHeight` | no | string \| number | Maximum dropdown height or chip container height as a CSS value |
|
|
3410
|
+
| `placement` | no | [AppGroupSelectPlacement](./definitions.md#appgroupselectplacement) | Country-code dropdown placement. Default: bottom-start |
|
|
3411
|
+
| `rows` | no | number | Minimum row count for the country-code dropdown |
|
|
3412
|
+
| `scrollThreshold` | no | number | Extra pixels rendered above and below the viewport in paginated mode |
|
|
3413
|
+
| `shouldFocusFirstElement` | no | boolean | Auto-focus the first dropdown item when the menu opens |
|
|
3414
|
+
| `shouldShowSearchIcon` | no | boolean | Show the search icon inside the country-code dropdown |
|
|
3415
|
+
| `shouldUsePortal` | no | boolean | Render the country-code dropdown in a React portal |
|
|
3416
|
+
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Country-code dropdown size. Default: M |
|
|
3417
|
+
| `theme` | no | [FormTimezoneTheme](./definitions.md#formtimezonetheme) | Country-code dropdown theme variant |
|
|
3418
|
+
| `value` | no | string | Controlled selected country code for the dropdown branch |
|
|
3419
|
+
|
|
3420
|
+
No additional properties.
|
|
3421
|
+
|
|
3422
|
+
## PhoneEmptyListPlaceholder
|
|
3423
|
+
|
|
3424
|
+
### Fields
|
|
3425
|
+
|
|
3426
|
+
| Name | Required | Type | Description |
|
|
3427
|
+
|---|---:|---|---|
|
|
3428
|
+
| `onLoading` | no | string | Placeholder shown while the dropdown list is loading |
|
|
3429
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query is entered |
|
|
3430
|
+
| `onNoSearchResults` | no | string | Placeholder shown when no matching regions are found |
|
|
2356
3431
|
|
|
2357
3432
|
No additional properties.
|
|
2358
3433
|
|
|
2359
|
-
##
|
|
3434
|
+
## PhoneFuseOption
|
|
2360
3435
|
|
|
2361
|
-
|
|
3436
|
+
Fuse.js search options for the country-code dropdown
|
|
2362
3437
|
|
|
2363
3438
|
### Fields
|
|
2364
3439
|
|
|
@@ -2366,16 +3441,30 @@ _No fields._
|
|
|
2366
3441
|
|
|
2367
3442
|
Additional properties: unknown.
|
|
2368
3443
|
|
|
2369
|
-
##
|
|
3444
|
+
## PhoneStringPadding
|
|
3445
|
+
|
|
3446
|
+
Pads input value with character until reaching maxLength
|
|
3447
|
+
|
|
3448
|
+
### Fields
|
|
3449
|
+
|
|
3450
|
+
| Name | Required | Type | Description |
|
|
3451
|
+
|---|---:|---|---|
|
|
3452
|
+
| `character` | yes | string | Character to use for padding |
|
|
3453
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
3454
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
3455
|
+
|
|
3456
|
+
No additional properties.
|
|
3457
|
+
|
|
3458
|
+
## PopperProp
|
|
3459
|
+
|
|
3460
|
+
Serializable popover options; middleware functions are not supported
|
|
2370
3461
|
|
|
2371
3462
|
### Fields
|
|
2372
3463
|
|
|
2373
3464
|
| Name | Required | Type | Description |
|
|
2374
3465
|
|---|---:|---|---|
|
|
2375
|
-
| `
|
|
2376
|
-
| `
|
|
2377
|
-
| `productId` | yes | string | Unique product object id for this thread. |
|
|
2378
|
-
| `productMetadata` | no | [ProductMetadata](./types.md#productmetadata) | Product metadata for this comment chain. |
|
|
3466
|
+
| `placement` | no | [FormTreeSelectPlacement](./definitions.md#formtreeselectplacement) | Popover placement |
|
|
3467
|
+
| `shouldFlipIfNoSpace` | no | boolean | Whether the popover flips when there is not enough space |
|
|
2379
3468
|
|
|
2380
3469
|
No additional properties.
|
|
2381
3470
|
|
|
@@ -2423,7 +3512,7 @@ Additional properties: unknown.
|
|
|
2423
3512
|
|
|
2424
3513
|
No additional properties.
|
|
2425
3514
|
|
|
2426
|
-
##
|
|
3515
|
+
## RadioList
|
|
2427
3516
|
|
|
2428
3517
|
### Fields
|
|
2429
3518
|
|
|
@@ -2480,37 +3569,6 @@ _No fields._
|
|
|
2480
3569
|
|
|
2481
3570
|
Additional properties: string.
|
|
2482
3571
|
|
|
2483
|
-
## RenderProp
|
|
2484
|
-
|
|
2485
|
-
Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string)
|
|
2486
|
-
|
|
2487
|
-
### Fields
|
|
2488
|
-
|
|
2489
|
-
_No fields._
|
|
2490
|
-
|
|
2491
|
-
Additional properties: [RenderPropValue](./types.md#renderpropvalue).
|
|
2492
|
-
|
|
2493
|
-
## RenderPropValue
|
|
2494
|
-
|
|
2495
|
-
### Fields
|
|
2496
|
-
|
|
2497
|
-
| Name | Required | Type | Description |
|
|
2498
|
-
|---|---:|---|---|
|
|
2499
|
-
| `isDisabled` | no | boolean | |
|
|
2500
|
-
| `tip` | no | [DaySelectorTip](./types.md#dayselectortip) | |
|
|
2501
|
-
|
|
2502
|
-
No additional properties.
|
|
2503
|
-
|
|
2504
|
-
## RequestOption
|
|
2505
|
-
|
|
2506
|
-
Request options passed to the comments API calls.
|
|
2507
|
-
|
|
2508
|
-
### Fields
|
|
2509
|
-
|
|
2510
|
-
_No fields._
|
|
2511
|
-
|
|
2512
|
-
Additional properties: unknown.
|
|
2513
|
-
|
|
2514
3572
|
## Role
|
|
2515
3573
|
|
|
2516
3574
|
### Fields
|
|
@@ -2566,6 +3624,22 @@ Additional properties: unknown.
|
|
|
2566
3624
|
|
|
2567
3625
|
No additional properties.
|
|
2568
3626
|
|
|
3627
|
+
## SegmentedControlList
|
|
3628
|
+
|
|
3629
|
+
### Fields
|
|
3630
|
+
|
|
3631
|
+
| Name | Required | Type | Description |
|
|
3632
|
+
|---|---:|---|---|
|
|
3633
|
+
| `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style for this specific option |
|
|
3634
|
+
| `aria-label` | no | string | Accessible label, required if label is not provided (e.g. for icon-only items) |
|
|
3635
|
+
| `icon` | no | string | Icon to display for icon-only items. Requires aria-label or label for accessibility |
|
|
3636
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
3637
|
+
| `label` | no | string | Display text for the option |
|
|
3638
|
+
| `tip` | no | [SegmentedControlTip](./types.md#segmentedcontroltip) | Tooltip to show on hover for this option |
|
|
3639
|
+
| `value` | yes | string | Value stored when option is selected |
|
|
3640
|
+
|
|
3641
|
+
No additional properties.
|
|
3642
|
+
|
|
2569
3643
|
## SegmentedControlOption
|
|
2570
3644
|
|
|
2571
3645
|
### Fields
|
|
@@ -2680,6 +3754,23 @@ No additional properties.
|
|
|
2680
3754
|
|
|
2681
3755
|
No additional properties.
|
|
2682
3756
|
|
|
3757
|
+
## SelectedEmoji
|
|
3758
|
+
|
|
3759
|
+
Bindable selected emoji data written before the change event emits
|
|
3760
|
+
|
|
3761
|
+
### Fields
|
|
3762
|
+
|
|
3763
|
+
| Name | Required | Type | Description |
|
|
3764
|
+
|---|---:|---|---|
|
|
3765
|
+
| `name` | yes | string | Descriptive emoji name |
|
|
3766
|
+
| `id` | yes | string | Unique identifier for the emoji |
|
|
3767
|
+
| `keywords` | yes | string[] | Search keywords for the emoji |
|
|
3768
|
+
| `native` | yes | string | Native emoji character |
|
|
3769
|
+
| `shortcodes` | yes | string | Short-form emoji representation |
|
|
3770
|
+
| `unified` | yes | string | Unicode representation for the emoji |
|
|
3771
|
+
|
|
3772
|
+
No additional properties.
|
|
3773
|
+
|
|
2683
3774
|
## SelectEmptyListPlaceholder
|
|
2684
3775
|
|
|
2685
3776
|
### Fields
|
|
@@ -2715,6 +3806,29 @@ _No fields._
|
|
|
2715
3806
|
|
|
2716
3807
|
Additional properties: unknown.
|
|
2717
3808
|
|
|
3809
|
+
## SelectList
|
|
3810
|
+
|
|
3811
|
+
### Fields
|
|
3812
|
+
|
|
3813
|
+
| Name | Required | Type | Description |
|
|
3814
|
+
|---|---:|---|---|
|
|
3815
|
+
| `avatarProps` | no | [SelectAvatarProp](./types.md#selectavatarprop) | Avatar configuration for the option |
|
|
3816
|
+
| `description` | no | string | Description text shown below the label |
|
|
3817
|
+
| `flag` | no | string | Two-letter country code for flag icon (e.g. "US", "IN") |
|
|
3818
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
3819
|
+
| `isRecommended` | no | boolean | Marks option as recommended with a badge |
|
|
3820
|
+
| `isSeparator` | no | boolean | Renders as a visual separator instead of selectable option |
|
|
3821
|
+
| `label` | yes | string | Display text for the option |
|
|
3822
|
+
| `labelIcon` | no | string | Icon glyph name to show next to the label |
|
|
3823
|
+
| `leftIconType` | no | string | Icon glyph name to show on the left. E.g. "CHECK_CIRCLE_OUTLINE" |
|
|
3824
|
+
| `quaternaryLabel` | no | string | Quaternary label shown below tertiary label |
|
|
3825
|
+
| `rightLabel` | no | string | Label aligned to the right side of the option |
|
|
3826
|
+
| `secondaryLabel` | no | string | Secondary label shown below the main label |
|
|
3827
|
+
| `tertiaryLabel` | no | string | Tertiary label shown below secondary label |
|
|
3828
|
+
| `value` | yes | unknown | Value stored when option is selected |
|
|
3829
|
+
|
|
3830
|
+
No additional properties.
|
|
3831
|
+
|
|
2718
3832
|
## SelectOption
|
|
2719
3833
|
|
|
2720
3834
|
### Fields
|
|
@@ -2814,6 +3928,18 @@ Horizontal size constraints for desktop layout. Object with optional default/min
|
|
|
2814
3928
|
|
|
2815
3929
|
No additional properties.
|
|
2816
3930
|
|
|
3931
|
+
## SkipButton
|
|
3932
|
+
|
|
3933
|
+
Secondary skip action. Click emits the skip event.
|
|
3934
|
+
|
|
3935
|
+
### Fields
|
|
3936
|
+
|
|
3937
|
+
| Name | Required | Type | Description |
|
|
3938
|
+
|---|---:|---|---|
|
|
3939
|
+
| `label` | no | string | Skip button label. Defaults to the Pebble skip label |
|
|
3940
|
+
|
|
3941
|
+
No additional properties.
|
|
3942
|
+
|
|
2817
3943
|
## Slide
|
|
2818
3944
|
|
|
2819
3945
|
### Fields
|
|
@@ -2902,21 +4028,6 @@ No additional properties.
|
|
|
2902
4028
|
|
|
2903
4029
|
No additional properties.
|
|
2904
4030
|
|
|
2905
|
-
## StatePath
|
|
2906
|
-
|
|
2907
|
-
Optional state paths written before emitting comment events.
|
|
2908
|
-
|
|
2909
|
-
### Fields
|
|
2910
|
-
|
|
2911
|
-
| Name | Required | Type | Description |
|
|
2912
|
-
|---|---:|---|---|
|
|
2913
|
-
| `commentChainId` | no | string | Path updated with the created comment chain id. |
|
|
2914
|
-
| `lastAddedComment` | no | string | Path updated with the most recently added comment. |
|
|
2915
|
-
| `lastEditedComment` | no | string | Path updated with the most recently edited comment. |
|
|
2916
|
-
| `lastRemovedComment` | no | string | Path updated with the most recently removed comment. |
|
|
2917
|
-
|
|
2918
|
-
No additional properties.
|
|
2919
|
-
|
|
2920
4031
|
## StepperAvatar
|
|
2921
4032
|
|
|
2922
4033
|
Avatar configuration to display with the step. Supports image URLs
|
|
@@ -2967,6 +4078,7 @@ Configuration for the form submit button
|
|
|
2967
4078
|
|
|
2968
4079
|
| Name | Required | Type | Description |
|
|
2969
4080
|
|---|---:|---|---|
|
|
4081
|
+
| `icon` | no | string \| [FormIcon](./types.md#formicon) | Icon to show in the submit button |
|
|
2970
4082
|
| `isDisabled` | no | boolean | Disable submit button |
|
|
2971
4083
|
| `isFluid` | no | boolean | Stretch submit button to fill width |
|
|
2972
4084
|
| `isLoading` | no | boolean | Show loading spinner on submit button. Bind to state for manual control. |
|
|
@@ -2986,6 +4098,18 @@ No additional properties.
|
|
|
2986
4098
|
|
|
2987
4099
|
No additional properties.
|
|
2988
4100
|
|
|
4101
|
+
## SupportLink
|
|
4102
|
+
|
|
4103
|
+
### Fields
|
|
4104
|
+
|
|
4105
|
+
| Name | Required | Type | Description |
|
|
4106
|
+
|---|---:|---|---|
|
|
4107
|
+
| `href` | no | string | URL for the support/help link |
|
|
4108
|
+
| `icon` | no | string | Pebble icon name for the support link |
|
|
4109
|
+
| `text` | no | string | Visible support link text override |
|
|
4110
|
+
|
|
4111
|
+
No additional properties.
|
|
4112
|
+
|
|
2989
4113
|
## SurveyArg
|
|
2990
4114
|
|
|
2991
4115
|
### Fields
|
|
@@ -3012,9 +4136,10 @@ No additional properties.
|
|
|
3012
4136
|
|
|
3013
4137
|
| Name | Required | Type | Description |
|
|
3014
4138
|
|---|---:|---|---|
|
|
4139
|
+
| `icon` | no | string | Pebble icon name displayed for the option |
|
|
3015
4140
|
| `isDisabled` | no | boolean | Disable this specific option |
|
|
3016
4141
|
| `label` | no | string \| number | Display label for the option |
|
|
3017
|
-
| `selectionColor` | no | [
|
|
4142
|
+
| `selectionColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Override selected surface color token for this option |
|
|
3018
4143
|
| `value` | yes | string \| number | Value when selected |
|
|
3019
4144
|
|
|
3020
4145
|
No additional properties.
|
|
@@ -3052,6 +4177,17 @@ Additional properties: unknown.
|
|
|
3052
4177
|
|
|
3053
4178
|
No additional properties.
|
|
3054
4179
|
|
|
4180
|
+
## SwitchTip
|
|
4181
|
+
|
|
4182
|
+
### Fields
|
|
4183
|
+
|
|
4184
|
+
| Name | Required | Type | Description |
|
|
4185
|
+
|---|---:|---|---|
|
|
4186
|
+
| `content` | yes | string | Tooltip text content |
|
|
4187
|
+
| `placement` | no | [SwitchTipPlacement](./definitions.md#switchtipplacement) | Tooltip placement relative to the switch |
|
|
4188
|
+
|
|
4189
|
+
No additional properties.
|
|
4190
|
+
|
|
3055
4191
|
## TabBadge
|
|
3056
4192
|
|
|
3057
4193
|
Badge to display on the tab
|
|
@@ -3072,11 +4208,24 @@ No additional properties.
|
|
|
3072
4208
|
| Name | Required | Type | Description |
|
|
3073
4209
|
|---|---:|---|---|
|
|
3074
4210
|
| `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the tab |
|
|
3075
|
-
| `
|
|
4211
|
+
| `href` | no | string | Semantic href for LINK tabs; navigation is prevented by Pebble Tabs |
|
|
3076
4212
|
| `icon` | no | string | Icon name for the tab (e.g., FOLDER_OUTLINE) |
|
|
3077
|
-
| `
|
|
4213
|
+
| `isDisabled` | no | boolean | Whether this tab is disabled |
|
|
3078
4214
|
| `tip` | no | string \| [TabTip](./types.md#tabtip) | Tooltip to show on hover |
|
|
3079
|
-
| `
|
|
4215
|
+
| `title` | yes | string | Display text for the tab |
|
|
4216
|
+
| `value` | yes | unknown | JSON-only tab value stored when the tab changes |
|
|
4217
|
+
|
|
4218
|
+
No additional properties.
|
|
4219
|
+
|
|
4220
|
+
## TabList
|
|
4221
|
+
|
|
4222
|
+
### Fields
|
|
4223
|
+
|
|
4224
|
+
| Name | Required | Type | Description |
|
|
4225
|
+
|---|---:|---|---|
|
|
4226
|
+
| `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the link tab |
|
|
4227
|
+
| `links` | no | [LinkValue](./types.md#linkvalue)[] | Nested link tabs for vertical LINK tabs |
|
|
4228
|
+
| `title` | yes | string | Display text for the link-style tab |
|
|
3080
4229
|
|
|
3081
4230
|
No additional properties.
|
|
3082
4231
|
|
|
@@ -3131,28 +4280,38 @@ Additional properties: unknown.
|
|
|
3131
4280
|
|
|
3132
4281
|
No additional properties.
|
|
3133
4282
|
|
|
3134
|
-
##
|
|
4283
|
+
## TextAutoSuggestFuseOption
|
|
3135
4284
|
|
|
3136
|
-
|
|
4285
|
+
Fuse.js search options for customizing suggestion filtering
|
|
4286
|
+
|
|
4287
|
+
### Fields
|
|
4288
|
+
|
|
4289
|
+
_No fields._
|
|
4290
|
+
|
|
4291
|
+
Additional properties: unknown.
|
|
4292
|
+
|
|
4293
|
+
## TextAutoSuggestList
|
|
3137
4294
|
|
|
3138
4295
|
### Fields
|
|
3139
4296
|
|
|
3140
4297
|
| Name | Required | Type | Description |
|
|
3141
4298
|
|---|---:|---|---|
|
|
3142
|
-
| `
|
|
3143
|
-
| `
|
|
3144
|
-
| `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Where to add padding: start or end |
|
|
4299
|
+
| `label` | yes | string | Display text for the suggestion |
|
|
4300
|
+
| `value` | yes | string \| number | Value stored when suggestion is selected |
|
|
3145
4301
|
|
|
3146
4302
|
No additional properties.
|
|
3147
4303
|
|
|
3148
|
-
##
|
|
4304
|
+
## TextAutoSuggestStringPadding
|
|
4305
|
+
|
|
4306
|
+
Pads input value with character until reaching maxLength
|
|
3149
4307
|
|
|
3150
4308
|
### Fields
|
|
3151
4309
|
|
|
3152
4310
|
| Name | Required | Type | Description |
|
|
3153
4311
|
|---|---:|---|---|
|
|
3154
|
-
| `
|
|
3155
|
-
| `
|
|
4312
|
+
| `character` | yes | string | Character to use for padding |
|
|
4313
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
4314
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
3156
4315
|
|
|
3157
4316
|
No additional properties.
|
|
3158
4317
|
|
|
@@ -3186,7 +4345,7 @@ Pads input value with character until reaching maxLength
|
|
|
3186
4345
|
|---|---:|---|---|
|
|
3187
4346
|
| `character` | yes | string | Character to use for padding |
|
|
3188
4347
|
| `maxLength` | yes | number | Target length after padding |
|
|
3189
|
-
| `position` | yes | [
|
|
4348
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
3190
4349
|
|
|
3191
4350
|
No additional properties.
|
|
3192
4351
|
|
|
@@ -3242,6 +4401,38 @@ Additional properties: unknown.
|
|
|
3242
4401
|
|
|
3243
4402
|
No additional properties.
|
|
3244
4403
|
|
|
4404
|
+
## TimeRangeShouldAllowTimeSelection
|
|
4405
|
+
|
|
4406
|
+
### Fields
|
|
4407
|
+
|
|
4408
|
+
| Name | Required | Type | Description |
|
|
4409
|
+
|---|---:|---|---|
|
|
4410
|
+
| `reference` | no | string | Reference ISO time for period labels |
|
|
4411
|
+
|
|
4412
|
+
No additional properties.
|
|
4413
|
+
|
|
4414
|
+
## TimeShouldAllowTimeSelection
|
|
4415
|
+
|
|
4416
|
+
### Fields
|
|
4417
|
+
|
|
4418
|
+
| Name | Required | Type | Description |
|
|
4419
|
+
|---|---:|---|---|
|
|
4420
|
+
| `reference` | no | string | Reference ISO time for period labels |
|
|
4421
|
+
|
|
4422
|
+
No additional properties.
|
|
4423
|
+
|
|
4424
|
+
## TimeTimezone
|
|
4425
|
+
|
|
4426
|
+
### Fields
|
|
4427
|
+
|
|
4428
|
+
| Name | Required | Type | Description |
|
|
4429
|
+
|---|---:|---|---|
|
|
4430
|
+
| `name` | yes | string | Input name for the timezone selector |
|
|
4431
|
+
| `isRequired` | no | boolean | Marks the timezone selector as required |
|
|
4432
|
+
| `value` | no | string | Selected timezone value |
|
|
4433
|
+
|
|
4434
|
+
No additional properties.
|
|
4435
|
+
|
|
3245
4436
|
## TimezoneArg
|
|
3246
4437
|
|
|
3247
4438
|
### Fields
|
|
@@ -3262,17 +4453,14 @@ Additional properties: unknown.
|
|
|
3262
4453
|
|
|
3263
4454
|
No additional properties.
|
|
3264
4455
|
|
|
3265
|
-
##
|
|
3266
|
-
|
|
3267
|
-
Toggle icon configuration
|
|
4456
|
+
## Title
|
|
3268
4457
|
|
|
3269
4458
|
### Fields
|
|
3270
4459
|
|
|
3271
4460
|
| Name | Required | Type | Description |
|
|
3272
4461
|
|---|---:|---|---|
|
|
3273
|
-
| `
|
|
3274
|
-
| `
|
|
3275
|
-
| `size` | no | [IconSize](./definitions.md#iconsize) | Icon size token. Default: 24 |
|
|
4462
|
+
| `kind` | yes | "BREADCRUMB" | Render the drawer title as a Breadcrumb |
|
|
4463
|
+
| `props` | yes | [DrawerProp](./types.md#drawerprop) | Breadcrumb props for the drawer title |
|
|
3276
4464
|
|
|
3277
4465
|
No additional properties.
|
|
3278
4466
|
|
|
@@ -3339,6 +4527,7 @@ Additional properties: unknown.
|
|
|
3339
4527
|
|---|---:|---|---|
|
|
3340
4528
|
| `disabledInfo` | no | string \| [TreeDisabledInfo](./types.md#treedisabledinfo) | Tooltip shown when item is disabled |
|
|
3341
4529
|
| `isDisabled` | no | boolean | Disable this item |
|
|
4530
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
3342
4531
|
| `label` | yes | string | Display label for the item |
|
|
3343
4532
|
| `parent` | no | string | Parent item value, null for root items |
|
|
3344
4533
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -3384,6 +4573,7 @@ Additional properties: unknown.
|
|
|
3384
4573
|
| Name | Required | Type | Description |
|
|
3385
4574
|
|---|---:|---|---|
|
|
3386
4575
|
| `isDisabled` | no | boolean | Disable this item |
|
|
4576
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
3387
4577
|
| `label` | yes | string | Display label for the item |
|
|
3388
4578
|
| `parent` | no | string | Parent item value, null for root items |
|
|
3389
4579
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -3473,3 +4663,27 @@ Additional properties: unknown.
|
|
|
3473
4663
|
| `type` | yes | string | |
|
|
3474
4664
|
|
|
3475
4665
|
No additional properties.
|
|
4666
|
+
|
|
4667
|
+
## WorkEmailDomainList
|
|
4668
|
+
|
|
4669
|
+
### Fields
|
|
4670
|
+
|
|
4671
|
+
| Name | Required | Type | Description |
|
|
4672
|
+
|---|---:|---|---|
|
|
4673
|
+
| `isDisabled` | no | boolean | Disables this specific domain option |
|
|
4674
|
+
| `label` | no | string | Display label for the domain option |
|
|
4675
|
+
| `tag` | no | string \| [WorkEmailTag](./types.md#workemailtag) | Optional tag shown with the domain option |
|
|
4676
|
+
| `value` | yes | string | Domain option value |
|
|
4677
|
+
|
|
4678
|
+
No additional properties.
|
|
4679
|
+
|
|
4680
|
+
## WorkEmailTag
|
|
4681
|
+
|
|
4682
|
+
### Fields
|
|
4683
|
+
|
|
4684
|
+
| Name | Required | Type | Description |
|
|
4685
|
+
|---|---:|---|---|
|
|
4686
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Optional semantic appearance for the tag |
|
|
4687
|
+
| `text` | yes | string | Tag text displayed with the domain option |
|
|
4688
|
+
|
|
4689
|
+
No additional properties.
|