@rippling/pebble-sdui-web 0.8.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/catalogs/ai_gateway/action-params.d.ts +5 -0
- package/dist/catalogs/ai_gateway/actions.d.ts +5 -0
- package/dist/catalogs/ai_gateway/catalog.d.ts +33 -0
- package/dist/catalogs/ai_gateway/component-events.d.ts +6 -0
- package/dist/catalogs/ai_gateway/component-props.d.ts +51 -0
- package/dist/catalogs/ai_gateway/components.d.ts +7 -0
- package/dist/catalogs/ai_gateway/function-params.d.ts +5 -0
- package/dist/catalogs/ai_gateway/functions.d.ts +5 -0
- package/dist/catalogs/ai_gateway/index.cjs +2 -0
- package/dist/catalogs/ai_gateway/index.cjs.map +1 -0
- package/dist/catalogs/ai_gateway/index.d.ts +11 -0
- package/dist/catalogs/ai_gateway/index.js +366 -0
- package/dist/catalogs/ai_gateway/index.js.map +1 -0
- package/dist/catalogs/ai_gateway/render.d.ts +20 -0
- 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/component-events.d.ts +15 -14
- package/dist/catalogs/custom-apps/component-props.d.ts +960 -219
- package/dist/catalogs/custom-apps/components.d.ts +4 -3
- package/dist/catalogs/custom-apps/index.cjs +3 -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 +5725 -1400
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/ai_gateway/actions.md +6 -0
- package/dist/docs/typescript/web/catalogs/ai_gateway/components.md +31 -0
- package/dist/docs/typescript/web/catalogs/ai_gateway/computed-functions.md +6 -0
- package/dist/docs/typescript/web/catalogs/ai_gateway/definitions.md +6 -0
- package/dist/docs/typescript/web/catalogs/ai_gateway/readme.md +16 -0
- package/dist/docs/typescript/web/catalogs/ai_gateway/types.md +75 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/actions.md +28 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +433 -287
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +250 -288
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +1307 -157
- package/package.json +6 -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 |
|
|
18
|
+
|
|
19
|
+
No additional properties.
|
|
20
|
+
|
|
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? } |
|
|
14
48
|
|
|
15
49
|
No additional properties.
|
|
16
50
|
|
|
17
|
-
##
|
|
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
|
|
|
@@ -196,13 +251,26 @@ Badge shown next to the nav item title
|
|
|
196
251
|
|
|
197
252
|
No additional properties.
|
|
198
253
|
|
|
254
|
+
## AvatarBadge
|
|
255
|
+
|
|
256
|
+
Badge overlay configuration for the avatar
|
|
257
|
+
|
|
258
|
+
### Fields
|
|
259
|
+
|
|
260
|
+
| Name | Required | Type | Description |
|
|
261
|
+
|---|---:|---|---|
|
|
262
|
+
| `aria-label` | yes | string | Accessible label for the badge |
|
|
263
|
+
| `char` | no | string | Single character to display in the badge overlay |
|
|
264
|
+
|
|
265
|
+
No additional properties.
|
|
266
|
+
|
|
199
267
|
## AvatarIcon
|
|
200
268
|
|
|
201
269
|
### Fields
|
|
202
270
|
|
|
203
271
|
| Name | Required | Type | Description |
|
|
204
272
|
|---|---:|---|---|
|
|
205
|
-
| `backgroundColor` | no | [
|
|
273
|
+
| `backgroundColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | |
|
|
206
274
|
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | |
|
|
207
275
|
| `type` | yes | string | |
|
|
208
276
|
|
|
@@ -338,6 +406,19 @@ No additional properties.
|
|
|
338
406
|
|
|
339
407
|
No additional properties.
|
|
340
408
|
|
|
409
|
+
## ButtonLabel
|
|
410
|
+
|
|
411
|
+
Labels for the expand and collapse buttons
|
|
412
|
+
|
|
413
|
+
### Fields
|
|
414
|
+
|
|
415
|
+
| Name | Required | Type | Description |
|
|
416
|
+
|---|---:|---|---|
|
|
417
|
+
| `collapse` | yes | string | Label for the collapse button. Default: Show less |
|
|
418
|
+
| `expand` | yes | string | Label for the expand button. Default: Show more |
|
|
419
|
+
|
|
420
|
+
No additional properties.
|
|
421
|
+
|
|
341
422
|
## ButtonTip
|
|
342
423
|
|
|
343
424
|
### Fields
|
|
@@ -427,7 +508,7 @@ Additional properties: unknown.
|
|
|
427
508
|
|
|
428
509
|
No additional properties.
|
|
429
510
|
|
|
430
|
-
##
|
|
511
|
+
## CheckboxGroupList
|
|
431
512
|
|
|
432
513
|
### Fields
|
|
433
514
|
|
|
@@ -437,7 +518,7 @@ No additional properties.
|
|
|
437
518
|
| `label` | yes | string | Display text for the checkbox option |
|
|
438
519
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
439
520
|
| `tag` | no | string \| [CheckboxGroupTag](./types.md#checkboxgrouptag) | Optional tag/label displayed with the option |
|
|
440
|
-
| `tip` | no | string | Tooltip
|
|
521
|
+
| `tip` | no | string \| [CheckboxGroupTip](./types.md#checkboxgrouptip) | Tooltip shown on hover. Can be simple string text or a TipTypes object |
|
|
441
522
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
442
523
|
|
|
443
524
|
No additional properties.
|
|
@@ -453,6 +534,34 @@ No additional properties.
|
|
|
453
534
|
|
|
454
535
|
No additional properties.
|
|
455
536
|
|
|
537
|
+
## CheckboxGroupTip
|
|
538
|
+
|
|
539
|
+
### Fields
|
|
540
|
+
|
|
541
|
+
| Name | Required | Type | Description |
|
|
542
|
+
|---|---:|---|---|
|
|
543
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style. Default: LIGHT |
|
|
544
|
+
| `content` | yes | string | Tooltip text content |
|
|
545
|
+
| `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls. Default: false |
|
|
546
|
+
| `isDelayed` | no | boolean | Add delay before showing tooltip. Default: false |
|
|
547
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
|
|
548
|
+
| `isPositionFixed` | no | boolean | Use fixed positioning relative to viewport. Default: false |
|
|
549
|
+
| `isVisible` | no | boolean | Control tooltip visibility from state |
|
|
550
|
+
| `maxHeight` | no | number \| string | Maximum height for tooltip content |
|
|
551
|
+
| `maxWidth` | no | number \| string | Maximum width for tooltip content |
|
|
552
|
+
| `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows. Default: false |
|
|
553
|
+
| `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows. Default: false |
|
|
554
|
+
| `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware. Default: false |
|
|
555
|
+
| `padding` | no | string | CSS padding value for tooltip content |
|
|
556
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to the checkbox option |
|
|
557
|
+
| `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis. Default: false |
|
|
558
|
+
| `tipHideDelay` | no | number | Milliseconds to wait before hiding tooltip when delayed |
|
|
559
|
+
| `tipShowDelay` | no | number | Milliseconds to wait before showing tooltip when delayed |
|
|
560
|
+
| `title` | no | string | Tooltip title text |
|
|
561
|
+
| `truncateClassName` | no | string | CSS class when onlyIfOverflow is enabled |
|
|
562
|
+
|
|
563
|
+
No additional properties.
|
|
564
|
+
|
|
456
565
|
## CheckListOption
|
|
457
566
|
|
|
458
567
|
Per-item input type overrides
|
|
@@ -518,6 +627,27 @@ No additional properties.
|
|
|
518
627
|
|
|
519
628
|
No additional properties.
|
|
520
629
|
|
|
630
|
+
## ClickedFile
|
|
631
|
+
|
|
632
|
+
Bindable clicked file metadata written before chipClick emits
|
|
633
|
+
|
|
634
|
+
### Fields
|
|
635
|
+
|
|
636
|
+
| Name | Required | Type | Description |
|
|
637
|
+
|---|---:|---|---|
|
|
638
|
+
| `name` | no | string | File name |
|
|
639
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
640
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
641
|
+
| `isMultipart` | no | boolean | Whether this is a multipart upload |
|
|
642
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
643
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
644
|
+
| `size` | no | number | File size in bytes |
|
|
645
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
646
|
+
| `type` | no | string | MIME type of the file |
|
|
647
|
+
| `url` | no | string | URL of the uploaded file |
|
|
648
|
+
|
|
649
|
+
No additional properties.
|
|
650
|
+
|
|
521
651
|
## CollapseBelow
|
|
522
652
|
|
|
523
653
|
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 +699,14 @@ No additional properties.
|
|
|
569
699
|
| Name | Required | Type | Description |
|
|
570
700
|
|---|---:|---|---|
|
|
571
701
|
| `alignment` | no | [CountryIconAlignment](./definitions.md#countryiconalignment) | Alignment of the icon within the container. Use "RIGHT" to push icon to the right. |
|
|
702
|
+
| `aria-describedby` | no | string | ID of element that describes the icon |
|
|
703
|
+
| `aria-label` | no | string | Accessible label for the icon |
|
|
704
|
+
| `aria-labelledby` | no | string | ID of element that labels the icon |
|
|
572
705
|
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
706
|
+
| `isDisabled` | no | boolean | Sets icon interactions as disabled |
|
|
707
|
+
| `isFocused` | no | boolean | Shows icon backdrop when focused |
|
|
708
|
+
| `showCursor` | no | boolean | Shows pointer cursor and hover background |
|
|
709
|
+
| `size` | no | number \| string | Icon size in pixels or CSS units |
|
|
573
710
|
| `tip` | no | string | Tooltip content shown on icon hover |
|
|
574
711
|
| `type` | yes | string | Icon type name (e.g. "INFO_CIRCLE_OUTLINE") |
|
|
575
712
|
|
|
@@ -595,6 +732,85 @@ Additional properties: unknown.
|
|
|
595
732
|
|
|
596
733
|
No additional properties.
|
|
597
734
|
|
|
735
|
+
## CurrencyCurrencyTypeProp
|
|
736
|
+
|
|
737
|
+
Nested Select props for the currency selector
|
|
738
|
+
|
|
739
|
+
### Fields
|
|
740
|
+
|
|
741
|
+
| Name | Required | Type | Description |
|
|
742
|
+
|---|---:|---|---|
|
|
743
|
+
| `name` | no | string | Unique identifier for the currency selector |
|
|
744
|
+
| `aria-describedby` | no | string | ID of element that describes the currency selector |
|
|
745
|
+
| `aria-label` | no | string | Accessible label for the currency selector |
|
|
746
|
+
| `aria-labelledby` | no | string | ID of element that labels the currency selector |
|
|
747
|
+
| `canClear` | no | boolean | Show clear button to deselect |
|
|
748
|
+
| `defaultSearchQuery` | no | string | Initial search input value |
|
|
749
|
+
| `defaultValue` | no | unknown | Initial selected currency code |
|
|
750
|
+
| `dropdownHeight` | no | number | Dropdown menu height in pixels |
|
|
751
|
+
| `emptyListPlaceholder` | no | string \| [CurrencyEmptyListPlaceholder](./types.md#currencyemptylistplaceholder) | Placeholder when dropdown list is empty |
|
|
752
|
+
| `fuseOptions` | no | [CurrencyFuseOption](./types.md#currencyfuseoption) | Fuse.js search options |
|
|
753
|
+
| `isDisabled` | no | boolean | Disables the currency selector |
|
|
754
|
+
| `isMenuDefaultOpen` | no | boolean | If true, dropdown menu opens by default |
|
|
755
|
+
| `isPositionFixed` | no | boolean | Position dropdown relative to viewport |
|
|
756
|
+
| `isReadOnly` | no | boolean | Makes the currency selector read-only |
|
|
757
|
+
| `isRequired` | no | boolean | Marks the currency selector as required |
|
|
758
|
+
| `isSearchable` | no | boolean | Enable type-to-search filtering |
|
|
759
|
+
| `maxHeight` | no | string \| number | Dropdown max height |
|
|
760
|
+
| `placeholder` | no | string | Placeholder text when empty |
|
|
761
|
+
| `scrollThreshold` | no | number | Extra virtual scroll render threshold |
|
|
762
|
+
| `shouldFocusFirstElement` | no | boolean | Auto-focus first menu item |
|
|
763
|
+
| `shouldShowSearchIcon` | no | boolean | Show search icon prefix |
|
|
764
|
+
| `shouldUsePortal` | no | boolean | Render dropdown in a React Portal |
|
|
765
|
+
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Select input size variant. Default: M |
|
|
766
|
+
| `value` | no | unknown | Currently selected currency code |
|
|
767
|
+
|
|
768
|
+
No additional properties.
|
|
769
|
+
|
|
770
|
+
## CurrencyDefaultValue
|
|
771
|
+
|
|
772
|
+
### Fields
|
|
773
|
+
|
|
774
|
+
| Name | Required | Type | Description |
|
|
775
|
+
|---|---:|---|---|
|
|
776
|
+
| `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
|
|
777
|
+
| `value` | yes | string \| number | Currency amount value |
|
|
778
|
+
|
|
779
|
+
No additional properties.
|
|
780
|
+
|
|
781
|
+
## CurrencyEmptyListPlaceholder
|
|
782
|
+
|
|
783
|
+
### Fields
|
|
784
|
+
|
|
785
|
+
| Name | Required | Type | Description |
|
|
786
|
+
|---|---:|---|---|
|
|
787
|
+
| `onLoading` | no | string | Placeholder shown while list is loading |
|
|
788
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query entered |
|
|
789
|
+
| `onNoSearchResults` | no | string | Placeholder when search returns no results |
|
|
790
|
+
|
|
791
|
+
No additional properties.
|
|
792
|
+
|
|
793
|
+
## CurrencyFuseOption
|
|
794
|
+
|
|
795
|
+
Fuse.js search options
|
|
796
|
+
|
|
797
|
+
### Fields
|
|
798
|
+
|
|
799
|
+
_No fields._
|
|
800
|
+
|
|
801
|
+
Additional properties: unknown.
|
|
802
|
+
|
|
803
|
+
## CurrencyValue
|
|
804
|
+
|
|
805
|
+
### Fields
|
|
806
|
+
|
|
807
|
+
| Name | Required | Type | Description |
|
|
808
|
+
|---|---:|---|---|
|
|
809
|
+
| `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
|
|
810
|
+
| `value` | yes | string \| number | Currency amount value |
|
|
811
|
+
|
|
812
|
+
No additional properties.
|
|
813
|
+
|
|
598
814
|
## DateArg
|
|
599
815
|
|
|
600
816
|
### Fields
|
|
@@ -675,6 +891,27 @@ Additional properties: unknown.
|
|
|
675
891
|
|
|
676
892
|
No additional properties.
|
|
677
893
|
|
|
894
|
+
## DaySelectorRenderProp
|
|
895
|
+
|
|
896
|
+
Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string)
|
|
897
|
+
|
|
898
|
+
### Fields
|
|
899
|
+
|
|
900
|
+
_No fields._
|
|
901
|
+
|
|
902
|
+
Additional properties: [DaySelectorRenderPropValue](./types.md#dayselectorrenderpropvalue).
|
|
903
|
+
|
|
904
|
+
## DaySelectorRenderPropValue
|
|
905
|
+
|
|
906
|
+
### Fields
|
|
907
|
+
|
|
908
|
+
| Name | Required | Type | Description |
|
|
909
|
+
|---|---:|---|---|
|
|
910
|
+
| `isDisabled` | no | boolean | |
|
|
911
|
+
| `tip` | no | [DaySelectorTip](./types.md#dayselectortip) | |
|
|
912
|
+
|
|
913
|
+
No additional properties.
|
|
914
|
+
|
|
678
915
|
## DaySelectorTip
|
|
679
916
|
|
|
680
917
|
### Fields
|
|
@@ -685,18 +922,18 @@ No additional properties.
|
|
|
685
922
|
|
|
686
923
|
No additional properties.
|
|
687
924
|
|
|
688
|
-
##
|
|
689
|
-
|
|
690
|
-
Optional display metadata for a multithreaded comment thread.
|
|
925
|
+
## DisabledTip
|
|
691
926
|
|
|
692
927
|
### Fields
|
|
693
928
|
|
|
694
929
|
| Name | Required | Type | Description |
|
|
695
930
|
|---|---:|---|---|
|
|
696
|
-
| `
|
|
697
|
-
| `
|
|
698
|
-
| `
|
|
699
|
-
| `
|
|
931
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance |
|
|
932
|
+
| `content` | yes | string | Tooltip content text |
|
|
933
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent |
|
|
934
|
+
| `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
|
|
935
|
+
| `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
|
|
936
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement |
|
|
700
937
|
|
|
701
938
|
No additional properties.
|
|
702
939
|
|
|
@@ -709,6 +946,68 @@ No additional properties.
|
|
|
709
946
|
| `id` | yes | string \| number | Unique identifier for the item |
|
|
710
947
|
| `label` | no | string | Display label for the item |
|
|
711
948
|
|
|
949
|
+
Additional properties: unknown.
|
|
950
|
+
|
|
951
|
+
## DraggableListTip
|
|
952
|
+
|
|
953
|
+
Tooltip configuration for the default chip renderer
|
|
954
|
+
|
|
955
|
+
### Fields
|
|
956
|
+
|
|
957
|
+
| Name | Required | Type | Description |
|
|
958
|
+
|---|---:|---|---|
|
|
959
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: DARK |
|
|
960
|
+
| `contentKey` | no | string | List item key used as tooltip content |
|
|
961
|
+
| `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls |
|
|
962
|
+
| `isDelayed` | no | boolean | Add delay before showing tooltip |
|
|
963
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices |
|
|
964
|
+
| `isPositionFixed` | no | boolean | Use fixed positioning relative to viewport |
|
|
965
|
+
| `isVisible` | no | boolean | Control tooltip visibility |
|
|
966
|
+
| `maxHeight` | no | number \| string | Maximum tooltip height |
|
|
967
|
+
| `maxWidth` | no | number \| string | Maximum tooltip width |
|
|
968
|
+
| `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows |
|
|
969
|
+
| `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows |
|
|
970
|
+
| `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware |
|
|
971
|
+
| `padding` | no | string | CSS padding value for tooltip content |
|
|
972
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement |
|
|
973
|
+
| `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis |
|
|
974
|
+
| `tipHideDelay` | no | number | Milliseconds to wait before hiding delayed tooltip |
|
|
975
|
+
| `tipShowDelay` | no | number | Milliseconds to wait before showing delayed tooltip |
|
|
976
|
+
| `title` | no | string | Static tooltip title |
|
|
977
|
+
| `titleKey` | no | string | List item key used as tooltip title |
|
|
978
|
+
| `truncateClassName` | no | string | CSS class when overflow-only tooltip is enabled |
|
|
979
|
+
|
|
980
|
+
No additional properties.
|
|
981
|
+
|
|
982
|
+
## DrawerItem
|
|
983
|
+
|
|
984
|
+
### Fields
|
|
985
|
+
|
|
986
|
+
| Name | Required | Type | Description |
|
|
987
|
+
|---|---:|---|---|
|
|
988
|
+
| `href` | no | string | URL to navigate to when clicked |
|
|
989
|
+
| `isDisabled` | no | boolean | Disables the breadcrumb item |
|
|
990
|
+
| `title` | yes | string | Display label for the breadcrumb item |
|
|
991
|
+
| `value` | yes | string | Unique value identifier for the item |
|
|
992
|
+
|
|
993
|
+
No additional properties.
|
|
994
|
+
|
|
995
|
+
## DrawerProp
|
|
996
|
+
|
|
997
|
+
Breadcrumb props for the drawer title
|
|
998
|
+
|
|
999
|
+
### Fields
|
|
1000
|
+
|
|
1001
|
+
| Name | Required | Type | Description |
|
|
1002
|
+
|---|---:|---|---|
|
|
1003
|
+
| `active` | no | string | Value of the active breadcrumb item |
|
|
1004
|
+
| `aria-describedby` | no | string | ID of element that describes the breadcrumb nav |
|
|
1005
|
+
| `aria-label` | no | string | Accessible label for the breadcrumb nav |
|
|
1006
|
+
| `aria-labelledby` | no | string | ID of element that labels the breadcrumb nav |
|
|
1007
|
+
| `items` | yes | [DrawerItem](./types.md#draweritem)[] | Breadcrumb items shown in the drawer header |
|
|
1008
|
+
| `noMargin` | no | boolean | Remove default breadcrumb margin |
|
|
1009
|
+
| `shouldCollapseMiddle` | no | boolean | Collapse middle breadcrumb items |
|
|
1010
|
+
|
|
712
1011
|
No additional properties.
|
|
713
1012
|
|
|
714
1013
|
## DropdownDisabledInfo
|
|
@@ -721,6 +1020,28 @@ No additional properties.
|
|
|
721
1020
|
|
|
722
1021
|
No additional properties.
|
|
723
1022
|
|
|
1023
|
+
## DropdownFooter
|
|
1024
|
+
|
|
1025
|
+
Footer item rendered at the bottom of the list
|
|
1026
|
+
|
|
1027
|
+
### Fields
|
|
1028
|
+
|
|
1029
|
+
| Name | Required | Type | Description |
|
|
1030
|
+
|---|---:|---|---|
|
|
1031
|
+
| `disabledInfo` | no | string \| [DropdownDisabledInfo](./types.md#dropdowndisabledinfo) | Tooltip content shown when the option is disabled |
|
|
1032
|
+
| `isDisabled` | no | boolean | Disables this option |
|
|
1033
|
+
| `label` | no | string | Display text for the option |
|
|
1034
|
+
| `labelIcon` | no | string | Icon name to show next to the label |
|
|
1035
|
+
| `leftIconType` | no | string | Icon name to show on the left side of the item |
|
|
1036
|
+
| `quaternaryLabel` | no | string | Quaternary text below the tertiary label |
|
|
1037
|
+
| `secondaryLabel` | no | string | Secondary text below the main label |
|
|
1038
|
+
| `tag` | no | string \| [DropdownTag](./types.md#dropdowntag) | Tag shown beside the option text |
|
|
1039
|
+
| `tertiaryLabel` | no | string | Tertiary text below the secondary label |
|
|
1040
|
+
| `type` | no | [DropdownFooterType](./definitions.md#dropdownfootertype) | Visual style type for the option (WARNING or ALERT) |
|
|
1041
|
+
| `value` | no | unknown | Value for the option |
|
|
1042
|
+
|
|
1043
|
+
Additional properties: unknown.
|
|
1044
|
+
|
|
724
1045
|
## DropdownList
|
|
725
1046
|
|
|
726
1047
|
### Fields
|
|
@@ -740,15 +1061,38 @@ No additional properties.
|
|
|
740
1061
|
|---|---:|---|---|
|
|
741
1062
|
| `disabledInfo` | no | string \| [DropdownDisabledInfo](./types.md#dropdowndisabledinfo) | Tooltip content shown when the option is disabled |
|
|
742
1063
|
| `isDisabled` | no | boolean | Disables this option |
|
|
743
|
-
| `label` |
|
|
1064
|
+
| `label` | no | string | Display text for the option |
|
|
744
1065
|
| `labelIcon` | no | string | Icon name to show next to the label |
|
|
745
1066
|
| `leftIconType` | no | string | Icon name to show on the left side of the item |
|
|
746
1067
|
| `quaternaryLabel` | no | string | Quaternary text below the tertiary label |
|
|
747
1068
|
| `secondaryLabel` | no | string | Secondary text below the main label |
|
|
748
|
-
| `tag` | no | string | Tag
|
|
1069
|
+
| `tag` | no | string \| [DropdownTag](./types.md#dropdowntag) | Tag shown beside the option text |
|
|
749
1070
|
| `tertiaryLabel` | no | string | Tertiary text below the secondary label |
|
|
750
|
-
| `type` | no | [
|
|
751
|
-
| `value` |
|
|
1071
|
+
| `type` | no | [DropdownFooterType](./definitions.md#dropdownfootertype) | Visual style type for the option (WARNING or ALERT) |
|
|
1072
|
+
| `value` | no | unknown | Value for the option |
|
|
1073
|
+
|
|
1074
|
+
Additional properties: unknown.
|
|
1075
|
+
|
|
1076
|
+
## DropdownTag
|
|
1077
|
+
|
|
1078
|
+
### Fields
|
|
1079
|
+
|
|
1080
|
+
| Name | Required | Type | Description |
|
|
1081
|
+
|---|---:|---|---|
|
|
1082
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance |
|
|
1083
|
+
| `text` | yes | string | Tag text |
|
|
1084
|
+
|
|
1085
|
+
No additional properties.
|
|
1086
|
+
|
|
1087
|
+
## EditButton
|
|
1088
|
+
|
|
1089
|
+
### Fields
|
|
1090
|
+
|
|
1091
|
+
| Name | Required | Type | Description |
|
|
1092
|
+
|---|---:|---|---|
|
|
1093
|
+
| `disabledTip` | no | string \| [DisabledTip](./types.md#disabledtip) | Tooltip shown when the settings edit button is disabled |
|
|
1094
|
+
| `isDisabled` | no | boolean | Disable the settings edit button |
|
|
1095
|
+
| `show` | no | boolean | Show or hide the settings edit button. Default: true |
|
|
752
1096
|
|
|
753
1097
|
No additional properties.
|
|
754
1098
|
|
|
@@ -772,6 +1116,88 @@ Additional properties: unknown.
|
|
|
772
1116
|
|
|
773
1117
|
No additional properties.
|
|
774
1118
|
|
|
1119
|
+
## EmailStringPadding
|
|
1120
|
+
|
|
1121
|
+
Pads input value with character until reaching maxLength
|
|
1122
|
+
|
|
1123
|
+
### Fields
|
|
1124
|
+
|
|
1125
|
+
| Name | Required | Type | Description |
|
|
1126
|
+
|---|---:|---|---|
|
|
1127
|
+
| `character` | yes | string | Character to use for padding |
|
|
1128
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1129
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
1130
|
+
|
|
1131
|
+
No additional properties.
|
|
1132
|
+
|
|
1133
|
+
## ExpansionPanelToggleIcon
|
|
1134
|
+
|
|
1135
|
+
Toggle icon layout options
|
|
1136
|
+
|
|
1137
|
+
### Fields
|
|
1138
|
+
|
|
1139
|
+
| Name | Required | Type | Description |
|
|
1140
|
+
|---|---:|---|---|
|
|
1141
|
+
| `align` | no | string | CSS align-self value for the toggle icon |
|
|
1142
|
+
| `margin` | no | string | CSS margin around the toggle icon container |
|
|
1143
|
+
| `size` | no | number \| string | Toggle icon size. Default: 24px |
|
|
1144
|
+
|
|
1145
|
+
No additional properties.
|
|
1146
|
+
|
|
1147
|
+
## FileAllowCameraCapture
|
|
1148
|
+
|
|
1149
|
+
### Fields
|
|
1150
|
+
|
|
1151
|
+
| Name | Required | Type | Description |
|
|
1152
|
+
|---|---:|---|---|
|
|
1153
|
+
| `quality` | no | number | Captured image quality |
|
|
1154
|
+
|
|
1155
|
+
No additional properties.
|
|
1156
|
+
|
|
1157
|
+
## FileCropperConfig
|
|
1158
|
+
|
|
1159
|
+
Image cropper configuration
|
|
1160
|
+
|
|
1161
|
+
### Fields
|
|
1162
|
+
|
|
1163
|
+
| Name | Required | Type | Description |
|
|
1164
|
+
|---|---:|---|---|
|
|
1165
|
+
| `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper |
|
|
1166
|
+
| `enforceAspectRatio` | no | boolean | Enforce cropper aspect ratio |
|
|
1167
|
+
| `showUploadButton` | no | boolean | Show upload button on cropper |
|
|
1168
|
+
| `title` | no | string | Title for the cropper modal |
|
|
1169
|
+
|
|
1170
|
+
No additional properties.
|
|
1171
|
+
|
|
1172
|
+
## FileDefaultValue
|
|
1173
|
+
|
|
1174
|
+
### Fields
|
|
1175
|
+
|
|
1176
|
+
| Name | Required | Type | Description |
|
|
1177
|
+
|---|---:|---|---|
|
|
1178
|
+
| `name` | no | string | File name |
|
|
1179
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
1180
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
1181
|
+
| `isMultipart` | no | boolean | Whether this is a multipart upload |
|
|
1182
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
1183
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
1184
|
+
| `size` | no | number | File size in bytes |
|
|
1185
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
1186
|
+
| `type` | no | string | MIME type of the file |
|
|
1187
|
+
| `url` | no | string | URL of the uploaded file |
|
|
1188
|
+
|
|
1189
|
+
No additional properties.
|
|
1190
|
+
|
|
1191
|
+
## FileDropAllowCameraCapture
|
|
1192
|
+
|
|
1193
|
+
### Fields
|
|
1194
|
+
|
|
1195
|
+
| Name | Required | Type | Description |
|
|
1196
|
+
|---|---:|---|---|
|
|
1197
|
+
| `quality` | no | number | Captured image quality |
|
|
1198
|
+
|
|
1199
|
+
No additional properties.
|
|
1200
|
+
|
|
775
1201
|
## FileDropArg
|
|
776
1202
|
|
|
777
1203
|
### Fields
|
|
@@ -800,7 +1226,7 @@ Cropper configuration
|
|
|
800
1226
|
|
|
801
1227
|
| Name | Required | Type | Description |
|
|
802
1228
|
|---|---:|---|---|
|
|
803
|
-
| `aspectRatio` | no | [
|
|
1229
|
+
| `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
804
1230
|
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
805
1231
|
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
806
1232
|
| `title` | no | string | Title for the cropper modal |
|
|
@@ -841,6 +1267,25 @@ No additional properties.
|
|
|
841
1267
|
|
|
842
1268
|
No additional properties.
|
|
843
1269
|
|
|
1270
|
+
## FileValue
|
|
1271
|
+
|
|
1272
|
+
### Fields
|
|
1273
|
+
|
|
1274
|
+
| Name | Required | Type | Description |
|
|
1275
|
+
|---|---:|---|---|
|
|
1276
|
+
| `name` | no | string | File name |
|
|
1277
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
1278
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
1279
|
+
| `isMultipart` | no | boolean | Whether this is a multipart upload |
|
|
1280
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
1281
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
1282
|
+
| `size` | no | number | File size in bytes |
|
|
1283
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
1284
|
+
| `type` | no | string | MIME type of the file |
|
|
1285
|
+
| `url` | no | string | URL of the uploaded file |
|
|
1286
|
+
|
|
1287
|
+
No additional properties.
|
|
1288
|
+
|
|
844
1289
|
## FloatingButtonIcon
|
|
845
1290
|
|
|
846
1291
|
### Fields
|
|
@@ -858,8 +1303,12 @@ No additional properties.
|
|
|
858
1303
|
|
|
859
1304
|
| Name | Required | Type | Description |
|
|
860
1305
|
|---|---:|---|---|
|
|
1306
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
|
|
861
1307
|
| `content` | yes | string | Tooltip content text |
|
|
862
|
-
| `
|
|
1308
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent |
|
|
1309
|
+
| `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
|
|
1310
|
+
| `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
|
|
1311
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to button. Default: TOP_START |
|
|
863
1312
|
|
|
864
1313
|
No additional properties.
|
|
865
1314
|
|
|
@@ -874,7 +1323,7 @@ No additional properties.
|
|
|
874
1323
|
|
|
875
1324
|
No additional properties.
|
|
876
1325
|
|
|
877
|
-
##
|
|
1326
|
+
## FormCheckboxGroupList
|
|
878
1327
|
|
|
879
1328
|
### Fields
|
|
880
1329
|
|
|
@@ -884,7 +1333,7 @@ No additional properties.
|
|
|
884
1333
|
| `label` | yes | string | Display text for the checkbox option |
|
|
885
1334
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
886
1335
|
| `tag` | no | string \| [FormCheckboxGroupTag](./types.md#formcheckboxgrouptag) | Optional tag/label displayed with the option |
|
|
887
|
-
| `tip` | no | string | Tooltip
|
|
1336
|
+
| `tip` | no | string \| [FormCheckboxGroupTip](./types.md#formcheckboxgrouptip) | Tooltip shown on hover. Can be simple string text or a TipTypes object |
|
|
888
1337
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
889
1338
|
|
|
890
1339
|
No additional properties.
|
|
@@ -900,6 +1349,34 @@ No additional properties.
|
|
|
900
1349
|
|
|
901
1350
|
No additional properties.
|
|
902
1351
|
|
|
1352
|
+
## FormCheckboxGroupTip
|
|
1353
|
+
|
|
1354
|
+
### Fields
|
|
1355
|
+
|
|
1356
|
+
| Name | Required | Type | Description |
|
|
1357
|
+
|---|---:|---|---|
|
|
1358
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style. Default: LIGHT |
|
|
1359
|
+
| `content` | yes | string | Tooltip text content |
|
|
1360
|
+
| `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls. Default: false |
|
|
1361
|
+
| `isDelayed` | no | boolean | Add delay before showing tooltip. Default: false |
|
|
1362
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
|
|
1363
|
+
| `isPositionFixed` | no | boolean | Use fixed positioning relative to viewport. Default: false |
|
|
1364
|
+
| `isVisible` | no | boolean | Control tooltip visibility from state |
|
|
1365
|
+
| `maxHeight` | no | number \| string | Maximum height for tooltip content |
|
|
1366
|
+
| `maxWidth` | no | number \| string | Maximum width for tooltip content |
|
|
1367
|
+
| `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows. Default: false |
|
|
1368
|
+
| `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows. Default: false |
|
|
1369
|
+
| `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware. Default: false |
|
|
1370
|
+
| `padding` | no | string | CSS padding value for tooltip content |
|
|
1371
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to the checkbox option |
|
|
1372
|
+
| `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis. Default: false |
|
|
1373
|
+
| `tipHideDelay` | no | number | Milliseconds to wait before hiding tooltip when delayed |
|
|
1374
|
+
| `tipShowDelay` | no | number | Milliseconds to wait before showing tooltip when delayed |
|
|
1375
|
+
| `title` | no | string | Tooltip title text |
|
|
1376
|
+
| `truncateClassName` | no | string | CSS class when onlyIfOverflow is enabled |
|
|
1377
|
+
|
|
1378
|
+
No additional properties.
|
|
1379
|
+
|
|
903
1380
|
## FormCheckboxGroupValidationError
|
|
904
1381
|
|
|
905
1382
|
Map of rule name to error message
|
|
@@ -920,6 +1397,74 @@ _No fields._
|
|
|
920
1397
|
|
|
921
1398
|
Additional properties: string.
|
|
922
1399
|
|
|
1400
|
+
## FormCurrencyCurrencyTypeProp
|
|
1401
|
+
|
|
1402
|
+
Nested Select props for the currency selector
|
|
1403
|
+
|
|
1404
|
+
### Fields
|
|
1405
|
+
|
|
1406
|
+
| Name | Required | Type | Description |
|
|
1407
|
+
|---|---:|---|---|
|
|
1408
|
+
| `name` | no | string | Unique identifier for the currency selector |
|
|
1409
|
+
| `aria-describedby` | no | string | ID of element that describes the currency selector |
|
|
1410
|
+
| `aria-label` | no | string | Accessible label for the currency selector |
|
|
1411
|
+
| `aria-labelledby` | no | string | ID of element that labels the currency selector |
|
|
1412
|
+
| `canClear` | no | boolean | Show clear button to deselect |
|
|
1413
|
+
| `defaultSearchQuery` | no | string | Initial search input value |
|
|
1414
|
+
| `defaultValue` | no | unknown | Initial selected currency code |
|
|
1415
|
+
| `dropdownHeight` | no | number | Dropdown menu height in pixels |
|
|
1416
|
+
| `emptyListPlaceholder` | no | string \| [FormCurrencyEmptyListPlaceholder](./types.md#formcurrencyemptylistplaceholder) | Placeholder when dropdown list is empty |
|
|
1417
|
+
| `fuseOptions` | no | [FormCurrencyFuseOption](./types.md#formcurrencyfuseoption) | Fuse.js search options |
|
|
1418
|
+
| `isDisabled` | no | boolean | Disables the currency selector |
|
|
1419
|
+
| `isMenuDefaultOpen` | no | boolean | If true, dropdown menu opens by default |
|
|
1420
|
+
| `isPositionFixed` | no | boolean | Position dropdown relative to viewport |
|
|
1421
|
+
| `isReadOnly` | no | boolean | Makes the currency selector read-only |
|
|
1422
|
+
| `isRequired` | no | boolean | Marks the currency selector as required |
|
|
1423
|
+
| `isSearchable` | no | boolean | Enable type-to-search filtering |
|
|
1424
|
+
| `maxHeight` | no | string \| number | Dropdown max height |
|
|
1425
|
+
| `placeholder` | no | string | Placeholder text when empty |
|
|
1426
|
+
| `scrollThreshold` | no | number | Extra virtual scroll render threshold |
|
|
1427
|
+
| `shouldFocusFirstElement` | no | boolean | Auto-focus first menu item |
|
|
1428
|
+
| `shouldShowSearchIcon` | no | boolean | Show search icon prefix |
|
|
1429
|
+
| `shouldUsePortal` | no | boolean | Render dropdown in a React Portal |
|
|
1430
|
+
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Select input size variant. Default: M |
|
|
1431
|
+
| `value` | no | unknown | Currently selected currency code |
|
|
1432
|
+
|
|
1433
|
+
No additional properties.
|
|
1434
|
+
|
|
1435
|
+
## FormCurrencyDefaultValue
|
|
1436
|
+
|
|
1437
|
+
### Fields
|
|
1438
|
+
|
|
1439
|
+
| Name | Required | Type | Description |
|
|
1440
|
+
|---|---:|---|---|
|
|
1441
|
+
| `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
|
|
1442
|
+
| `value` | yes | string \| number | Currency amount value |
|
|
1443
|
+
|
|
1444
|
+
No additional properties.
|
|
1445
|
+
|
|
1446
|
+
## FormCurrencyEmptyListPlaceholder
|
|
1447
|
+
|
|
1448
|
+
### Fields
|
|
1449
|
+
|
|
1450
|
+
| Name | Required | Type | Description |
|
|
1451
|
+
|---|---:|---|---|
|
|
1452
|
+
| `onLoading` | no | string | Placeholder shown while list is loading |
|
|
1453
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query entered |
|
|
1454
|
+
| `onNoSearchResults` | no | string | Placeholder when search returns no results |
|
|
1455
|
+
|
|
1456
|
+
No additional properties.
|
|
1457
|
+
|
|
1458
|
+
## FormCurrencyFuseOption
|
|
1459
|
+
|
|
1460
|
+
Fuse.js search options
|
|
1461
|
+
|
|
1462
|
+
### Fields
|
|
1463
|
+
|
|
1464
|
+
_No fields._
|
|
1465
|
+
|
|
1466
|
+
Additional properties: unknown.
|
|
1467
|
+
|
|
923
1468
|
## FormCurrencyValidationError
|
|
924
1469
|
|
|
925
1470
|
Map of rule name to error message
|
|
@@ -930,6 +1475,17 @@ _No fields._
|
|
|
930
1475
|
|
|
931
1476
|
Additional properties: string.
|
|
932
1477
|
|
|
1478
|
+
## FormCurrencyValue
|
|
1479
|
+
|
|
1480
|
+
### Fields
|
|
1481
|
+
|
|
1482
|
+
| Name | Required | Type | Description |
|
|
1483
|
+
|---|---:|---|---|
|
|
1484
|
+
| `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
|
|
1485
|
+
| `value` | yes | string \| number | Currency amount value |
|
|
1486
|
+
|
|
1487
|
+
No additional properties.
|
|
1488
|
+
|
|
933
1489
|
## FormDateRangeValidationError
|
|
934
1490
|
|
|
935
1491
|
Map of rule name to error message
|
|
@@ -950,15 +1506,60 @@ _No fields._
|
|
|
950
1506
|
|
|
951
1507
|
Additional properties: string.
|
|
952
1508
|
|
|
953
|
-
##
|
|
1509
|
+
## FormDaySelectorRenderProp
|
|
1510
|
+
|
|
1511
|
+
Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string)
|
|
1512
|
+
|
|
1513
|
+
### Fields
|
|
1514
|
+
|
|
1515
|
+
_No fields._
|
|
1516
|
+
|
|
1517
|
+
Additional properties: [FormDaySelectorRenderPropValue](./types.md#formdayselectorrenderpropvalue).
|
|
1518
|
+
|
|
1519
|
+
## FormDaySelectorRenderPropValue
|
|
1520
|
+
|
|
1521
|
+
### Fields
|
|
1522
|
+
|
|
1523
|
+
| Name | Required | Type | Description |
|
|
1524
|
+
|---|---:|---|---|
|
|
1525
|
+
| `isDisabled` | no | boolean | |
|
|
1526
|
+
| `tip` | no | [FormDaySelectorTip](./types.md#formdayselectortip) | |
|
|
1527
|
+
|
|
1528
|
+
No additional properties.
|
|
1529
|
+
|
|
1530
|
+
## FormDaySelectorTip
|
|
1531
|
+
|
|
1532
|
+
### Fields
|
|
1533
|
+
|
|
1534
|
+
| Name | Required | Type | Description |
|
|
1535
|
+
|---|---:|---|---|
|
|
1536
|
+
| `content` | yes | string | |
|
|
1537
|
+
|
|
1538
|
+
No additional properties.
|
|
1539
|
+
|
|
1540
|
+
## FormDaySelectorValidationError
|
|
1541
|
+
|
|
1542
|
+
Map of rule name to error message
|
|
1543
|
+
|
|
1544
|
+
### Fields
|
|
1545
|
+
|
|
1546
|
+
_No fields._
|
|
1547
|
+
|
|
1548
|
+
Additional properties: string.
|
|
1549
|
+
|
|
1550
|
+
## FormEmailStringPadding
|
|
954
1551
|
|
|
955
|
-
|
|
1552
|
+
Pads input value with character until reaching maxLength
|
|
956
1553
|
|
|
957
1554
|
### Fields
|
|
958
1555
|
|
|
959
|
-
|
|
1556
|
+
| Name | Required | Type | Description |
|
|
1557
|
+
|---|---:|---|---|
|
|
1558
|
+
| `character` | yes | string | Character to use for padding |
|
|
1559
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1560
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
960
1561
|
|
|
961
|
-
|
|
1562
|
+
No additional properties.
|
|
962
1563
|
|
|
963
1564
|
## FormEmailValidationError
|
|
964
1565
|
|
|
@@ -970,6 +1571,16 @@ _No fields._
|
|
|
970
1571
|
|
|
971
1572
|
Additional properties: string.
|
|
972
1573
|
|
|
1574
|
+
## FormFileAllowCameraCapture
|
|
1575
|
+
|
|
1576
|
+
### Fields
|
|
1577
|
+
|
|
1578
|
+
| Name | Required | Type | Description |
|
|
1579
|
+
|---|---:|---|---|
|
|
1580
|
+
| `quality` | no | number | Captured image quality |
|
|
1581
|
+
|
|
1582
|
+
No additional properties.
|
|
1583
|
+
|
|
973
1584
|
## FormFileCropperConfig
|
|
974
1585
|
|
|
975
1586
|
Cropper configuration
|
|
@@ -978,7 +1589,7 @@ Cropper configuration
|
|
|
978
1589
|
|
|
979
1590
|
| Name | Required | Type | Description |
|
|
980
1591
|
|---|---:|---|---|
|
|
981
|
-
| `aspectRatio` | no | [
|
|
1592
|
+
| `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
982
1593
|
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
983
1594
|
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
984
1595
|
| `title` | no | string | Title for the cropper modal |
|
|
@@ -994,14 +1605,26 @@ No additional properties.
|
|
|
994
1605
|
| `name` | no | string | File name |
|
|
995
1606
|
| `content` | no | string | File content as a base64 data URL |
|
|
996
1607
|
| `hasError` | no | boolean | Whether the file has an error |
|
|
1608
|
+
| `isMultipart` | no | boolean | Whether this is a multipart upload |
|
|
997
1609
|
| `previewUrl` | no | string | Preview URL for the file |
|
|
998
1610
|
| `progress` | no | number | Upload progress 0-100 |
|
|
1611
|
+
| `size` | no | number | File size in bytes |
|
|
999
1612
|
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
1000
1613
|
| `type` | no | string | MIME type of the file |
|
|
1001
1614
|
| `url` | no | string | URL of the uploaded file |
|
|
1002
1615
|
|
|
1003
1616
|
No additional properties.
|
|
1004
1617
|
|
|
1618
|
+
## FormFileDropAllowCameraCapture
|
|
1619
|
+
|
|
1620
|
+
### Fields
|
|
1621
|
+
|
|
1622
|
+
| Name | Required | Type | Description |
|
|
1623
|
+
|---|---:|---|---|
|
|
1624
|
+
| `quality` | no | number | Captured image quality |
|
|
1625
|
+
|
|
1626
|
+
No additional properties.
|
|
1627
|
+
|
|
1005
1628
|
## FormFileDropCropperConfig
|
|
1006
1629
|
|
|
1007
1630
|
Cropper configuration
|
|
@@ -1010,7 +1633,7 @@ Cropper configuration
|
|
|
1010
1633
|
|
|
1011
1634
|
| Name | Required | Type | Description |
|
|
1012
1635
|
|---|---:|---|---|
|
|
1013
|
-
| `aspectRatio` | no | [
|
|
1636
|
+
| `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
1014
1637
|
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
1015
1638
|
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
1016
1639
|
| `title` | no | string | Title for the cropper modal |
|
|
@@ -1050,14 +1673,14 @@ Additional properties: string.
|
|
|
1050
1673
|
|
|
1051
1674
|
| Name | Required | Type | Description |
|
|
1052
1675
|
|---|---:|---|---|
|
|
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 |
|
|
1676
|
+
| `name` | no | string | File name |
|
|
1677
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
1678
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
1679
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
1680
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
1681
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
1682
|
+
| `type` | no | string | MIME type of the file |
|
|
1683
|
+
| `url` | no | string | URL of the uploaded file |
|
|
1061
1684
|
|
|
1062
1685
|
No additional properties.
|
|
1063
1686
|
|
|
@@ -1077,14 +1700,28 @@ Additional properties: string.
|
|
|
1077
1700
|
|
|
1078
1701
|
| Name | Required | Type | Description |
|
|
1079
1702
|
|---|---:|---|---|
|
|
1080
|
-
| `name` | no | string |
|
|
1081
|
-
| `content` | no | string |
|
|
1082
|
-
| `hasError` | no | boolean |
|
|
1083
|
-
| `
|
|
1084
|
-
| `
|
|
1085
|
-
| `
|
|
1086
|
-
| `
|
|
1087
|
-
| `
|
|
1703
|
+
| `name` | no | string | File name |
|
|
1704
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
1705
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
1706
|
+
| `isMultipart` | no | boolean | Whether this is a multipart upload |
|
|
1707
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
1708
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
1709
|
+
| `size` | no | number | File size in bytes |
|
|
1710
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
1711
|
+
| `type` | no | string | MIME type of the file |
|
|
1712
|
+
| `url` | no | string | URL of the uploaded file |
|
|
1713
|
+
|
|
1714
|
+
No additional properties.
|
|
1715
|
+
|
|
1716
|
+
## FormIcon
|
|
1717
|
+
|
|
1718
|
+
### Fields
|
|
1719
|
+
|
|
1720
|
+
| Name | Required | Type | Description |
|
|
1721
|
+
|---|---:|---|---|
|
|
1722
|
+
| `alignment` | no | [ButtonIconAlignment](./definitions.md#buttoniconalignment) | Icon alignment relative to button label. Default: LEFT |
|
|
1723
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
1724
|
+
| `type` | yes | string | Icon type name from Icon.TYPES |
|
|
1088
1725
|
|
|
1089
1726
|
No additional properties.
|
|
1090
1727
|
|
|
@@ -1153,6 +1790,20 @@ _No fields._
|
|
|
1153
1790
|
|
|
1154
1791
|
Additional properties: string.
|
|
1155
1792
|
|
|
1793
|
+
## FormNumberStringPadding
|
|
1794
|
+
|
|
1795
|
+
Adds padding characters to the input value
|
|
1796
|
+
|
|
1797
|
+
### Fields
|
|
1798
|
+
|
|
1799
|
+
| Name | Required | Type | Description |
|
|
1800
|
+
|---|---:|---|---|
|
|
1801
|
+
| `character` | yes | string | Character to use for padding |
|
|
1802
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1803
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Position to pad (start or end) |
|
|
1804
|
+
|
|
1805
|
+
No additional properties.
|
|
1806
|
+
|
|
1156
1807
|
## FormNumberValidationError
|
|
1157
1808
|
|
|
1158
1809
|
Map of rule name to error message
|
|
@@ -1163,6 +1814,20 @@ _No fields._
|
|
|
1163
1814
|
|
|
1164
1815
|
Additional properties: string.
|
|
1165
1816
|
|
|
1817
|
+
## FormPasswordStringPadding
|
|
1818
|
+
|
|
1819
|
+
Pads input value with character until reaching maxLength
|
|
1820
|
+
|
|
1821
|
+
### Fields
|
|
1822
|
+
|
|
1823
|
+
| Name | Required | Type | Description |
|
|
1824
|
+
|---|---:|---|---|
|
|
1825
|
+
| `character` | yes | string | Character to use for padding |
|
|
1826
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1827
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
1828
|
+
|
|
1829
|
+
No additional properties.
|
|
1830
|
+
|
|
1166
1831
|
## FormPasswordValidationError
|
|
1167
1832
|
|
|
1168
1833
|
Map of rule name to error message
|
|
@@ -1183,6 +1848,79 @@ _No fields._
|
|
|
1183
1848
|
|
|
1184
1849
|
Additional properties: string.
|
|
1185
1850
|
|
|
1851
|
+
## FormPhoneCountryCode
|
|
1852
|
+
|
|
1853
|
+
Country-code dropdown configuration preserving the serializable CountryCodeProp shape
|
|
1854
|
+
|
|
1855
|
+
### Fields
|
|
1856
|
+
|
|
1857
|
+
| Name | Required | Type | Description |
|
|
1858
|
+
|---|---:|---|---|
|
|
1859
|
+
| `name` | no | string | Name for the country-code select input |
|
|
1860
|
+
| `aria-describedby` | no | string | ID of the element that describes the country-code dropdown |
|
|
1861
|
+
| `aria-label` | no | string | Accessible label for the country-code dropdown |
|
|
1862
|
+
| `aria-labelledby` | no | string | ID of the element that labels the country-code dropdown |
|
|
1863
|
+
| `canClear` | no | boolean | Show clear button in the country-code dropdown |
|
|
1864
|
+
| `defaultSearchQuery` | no | string | Initial search query for the country-code dropdown |
|
|
1865
|
+
| `defaultValue` | no | string | Initial selected country code for the dropdown branch |
|
|
1866
|
+
| `dropdownHeight` | no | number | Country-code dropdown menu height in pixels |
|
|
1867
|
+
| `emptyListPlaceholder` | no | string \| [FormPhoneEmptyListPlaceholder](./types.md#formphoneemptylistplaceholder) | Placeholder shown when the country-code dropdown list is empty |
|
|
1868
|
+
| `fuseOptions` | no | [FormPhoneFuseOption](./types.md#formphonefuseoption) | Fuse.js search options for the country-code dropdown |
|
|
1869
|
+
| `id` | no | string | HTML id attribute for the country-code select input |
|
|
1870
|
+
| `isDisabled` | no | boolean | Disables the country-code dropdown |
|
|
1871
|
+
| `isMenuDefaultOpen` | no | boolean | If true, the country-code dropdown opens by default |
|
|
1872
|
+
| `isPositionFixed` | no | boolean | Position the country-code dropdown relative to the viewport |
|
|
1873
|
+
| `isReadOnly` | no | boolean | Makes the country-code dropdown read-only |
|
|
1874
|
+
| `isRequired` | no | boolean | Marks the country-code dropdown as required |
|
|
1875
|
+
| `maxHeight` | no | string \| number | Maximum dropdown height or chip container height as a CSS value |
|
|
1876
|
+
| `placement` | no | [AppGroupSelectPlacement](./definitions.md#appgroupselectplacement) | Country-code dropdown placement. Default: bottom-start |
|
|
1877
|
+
| `rows` | no | number | Minimum row count for the country-code dropdown |
|
|
1878
|
+
| `scrollThreshold` | no | number | Extra pixels rendered above and below the viewport in paginated mode |
|
|
1879
|
+
| `shouldFocusFirstElement` | no | boolean | Auto-focus the first dropdown item when the menu opens |
|
|
1880
|
+
| `shouldShowSearchIcon` | no | boolean | Show the search icon inside the country-code dropdown |
|
|
1881
|
+
| `shouldUsePortal` | no | boolean | Render the country-code dropdown in a React portal |
|
|
1882
|
+
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Country-code dropdown size. Default: M |
|
|
1883
|
+
| `theme` | no | [FormTimezoneTheme](./definitions.md#formtimezonetheme) | Country-code dropdown theme variant |
|
|
1884
|
+
| `value` | no | string | Controlled selected country code for the dropdown branch |
|
|
1885
|
+
|
|
1886
|
+
No additional properties.
|
|
1887
|
+
|
|
1888
|
+
## FormPhoneEmptyListPlaceholder
|
|
1889
|
+
|
|
1890
|
+
### Fields
|
|
1891
|
+
|
|
1892
|
+
| Name | Required | Type | Description |
|
|
1893
|
+
|---|---:|---|---|
|
|
1894
|
+
| `onLoading` | no | string | Placeholder shown while the dropdown list is loading |
|
|
1895
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query is entered |
|
|
1896
|
+
| `onNoSearchResults` | no | string | Placeholder shown when no matching regions are found |
|
|
1897
|
+
|
|
1898
|
+
No additional properties.
|
|
1899
|
+
|
|
1900
|
+
## FormPhoneFuseOption
|
|
1901
|
+
|
|
1902
|
+
Fuse.js search options for the country-code dropdown
|
|
1903
|
+
|
|
1904
|
+
### Fields
|
|
1905
|
+
|
|
1906
|
+
_No fields._
|
|
1907
|
+
|
|
1908
|
+
Additional properties: unknown.
|
|
1909
|
+
|
|
1910
|
+
## FormPhoneStringPadding
|
|
1911
|
+
|
|
1912
|
+
Pads input value with character until reaching maxLength
|
|
1913
|
+
|
|
1914
|
+
### Fields
|
|
1915
|
+
|
|
1916
|
+
| Name | Required | Type | Description |
|
|
1917
|
+
|---|---:|---|---|
|
|
1918
|
+
| `character` | yes | string | Character to use for padding |
|
|
1919
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1920
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
1921
|
+
|
|
1922
|
+
No additional properties.
|
|
1923
|
+
|
|
1186
1924
|
## FormPhoneValidationError
|
|
1187
1925
|
|
|
1188
1926
|
Map of rule name to error message
|
|
@@ -1193,7 +1931,7 @@ _No fields._
|
|
|
1193
1931
|
|
|
1194
1932
|
Additional properties: string.
|
|
1195
1933
|
|
|
1196
|
-
##
|
|
1934
|
+
## FormRadioList
|
|
1197
1935
|
|
|
1198
1936
|
### Fields
|
|
1199
1937
|
|
|
@@ -1230,7 +1968,7 @@ _No fields._
|
|
|
1230
1968
|
|
|
1231
1969
|
Additional properties: string.
|
|
1232
1970
|
|
|
1233
|
-
##
|
|
1971
|
+
## FormSegmentedControlList
|
|
1234
1972
|
|
|
1235
1973
|
### Fields
|
|
1236
1974
|
|
|
@@ -1246,6 +1984,19 @@ Additional properties: string.
|
|
|
1246
1984
|
|
|
1247
1985
|
No additional properties.
|
|
1248
1986
|
|
|
1987
|
+
## FormSegmentedControlRangeLabel
|
|
1988
|
+
|
|
1989
|
+
Labels to display at the start and end of the control range
|
|
1990
|
+
|
|
1991
|
+
### Fields
|
|
1992
|
+
|
|
1993
|
+
| Name | Required | Type | Description |
|
|
1994
|
+
|---|---:|---|---|
|
|
1995
|
+
| `end` | yes | string | Label at the end of the range |
|
|
1996
|
+
| `start` | yes | string | Label at the start of the range |
|
|
1997
|
+
|
|
1998
|
+
No additional properties.
|
|
1999
|
+
|
|
1249
2000
|
## FormSegmentedControlTip
|
|
1250
2001
|
|
|
1251
2002
|
Tooltip to show on hover for this option
|
|
@@ -1299,7 +2050,29 @@ Avatar configuration for the option
|
|
|
1299
2050
|
|
|
1300
2051
|
No additional properties.
|
|
1301
2052
|
|
|
1302
|
-
##
|
|
2053
|
+
## FormSelectEmptyListPlaceholder
|
|
2054
|
+
|
|
2055
|
+
### Fields
|
|
2056
|
+
|
|
2057
|
+
| Name | Required | Type | Description |
|
|
2058
|
+
|---|---:|---|---|
|
|
2059
|
+
| `onLoading` | no | string | Placeholder shown while list is loading |
|
|
2060
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query entered |
|
|
2061
|
+
| `onNoSearchResults` | no | string | Placeholder when search returns no results |
|
|
2062
|
+
|
|
2063
|
+
No additional properties.
|
|
2064
|
+
|
|
2065
|
+
## FormSelectFuseOption
|
|
2066
|
+
|
|
2067
|
+
Fuse.js search options for customizing fuzzy search behavior
|
|
2068
|
+
|
|
2069
|
+
### Fields
|
|
2070
|
+
|
|
2071
|
+
_No fields._
|
|
2072
|
+
|
|
2073
|
+
Additional properties: unknown.
|
|
2074
|
+
|
|
2075
|
+
## FormSelectList
|
|
1303
2076
|
|
|
1304
2077
|
### Fields
|
|
1305
2078
|
|
|
@@ -1388,9 +2161,10 @@ Additional properties: string.
|
|
|
1388
2161
|
|
|
1389
2162
|
| Name | Required | Type | Description |
|
|
1390
2163
|
|---|---:|---|---|
|
|
2164
|
+
| `icon` | no | string | Pebble icon name displayed for the option |
|
|
1391
2165
|
| `isDisabled` | no | boolean | Disable this specific option |
|
|
1392
2166
|
| `label` | no | string \| number | Display label for the option |
|
|
1393
|
-
| `selectionColor` | no | [
|
|
2167
|
+
| `selectionColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Override selected surface color token for this option |
|
|
1394
2168
|
| `value` | yes | string \| number | Value when selected |
|
|
1395
2169
|
|
|
1396
2170
|
No additional properties.
|
|
@@ -1418,6 +2192,30 @@ _No fields._
|
|
|
1418
2192
|
|
|
1419
2193
|
Additional properties: string.
|
|
1420
2194
|
|
|
2195
|
+
## FormSwitchTip
|
|
2196
|
+
|
|
2197
|
+
### Fields
|
|
2198
|
+
|
|
2199
|
+
| Name | Required | Type | Description |
|
|
2200
|
+
|---|---:|---|---|
|
|
2201
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip theme. Default: LIGHT |
|
|
2202
|
+
| `content` | yes | string | Tooltip text content |
|
|
2203
|
+
| `hideOnDocumentScroll` | no | boolean | Hide tooltip when the document is scrolled. Default: false |
|
|
2204
|
+
| `isDelayed` | no | boolean | Add delay before showing/hiding the tooltip. Default: false |
|
|
2205
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
|
|
2206
|
+
| `isPositionFixed` | no | boolean | Use fixed positioning for the tooltip. Default: false |
|
|
2207
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent. Overrides hover behavior when set |
|
|
2208
|
+
| `maxHeight` | no | number \| string | Max height of tooltip content. Number in px or CSS string |
|
|
2209
|
+
| `maxWidth` | no | number \| string | Max width of tooltip. Number in px or CSS string. Default: 360 |
|
|
2210
|
+
| `onlyIfChildOverflow` | no | boolean | Only show tooltip if a child element overflows. Default: false |
|
|
2211
|
+
| `onlyIfOverflow` | no | boolean | Only show tooltip if the trigger element overflows. Default: false |
|
|
2212
|
+
| `placement` | no | [TipPlacement](./definitions.md#tipplacement) | Tooltip position relative to child. Default: bottom |
|
|
2213
|
+
| `tipHideDelay` | no | number | Custom delay in ms before tooltip hides |
|
|
2214
|
+
| `tipShowDelay` | no | number | Custom delay in ms before tooltip appears |
|
|
2215
|
+
| `title` | no | string | Optional bold title above tooltip content |
|
|
2216
|
+
|
|
2217
|
+
No additional properties.
|
|
2218
|
+
|
|
1421
2219
|
## FormSwitchValidationError
|
|
1422
2220
|
|
|
1423
2221
|
Map of rule name to error message
|
|
@@ -1438,16 +2236,27 @@ _No fields._
|
|
|
1438
2236
|
|
|
1439
2237
|
Additional properties: string.
|
|
1440
2238
|
|
|
1441
|
-
##
|
|
2239
|
+
## FormTextAutoSuggestFuseOption
|
|
2240
|
+
|
|
2241
|
+
Fuse.js search options for customizing suggestion filtering
|
|
2242
|
+
|
|
2243
|
+
### Fields
|
|
2244
|
+
|
|
2245
|
+
_No fields._
|
|
2246
|
+
|
|
2247
|
+
Additional properties: unknown.
|
|
2248
|
+
|
|
2249
|
+
## FormTextAutoSuggestList
|
|
1442
2250
|
|
|
1443
2251
|
### Fields
|
|
1444
2252
|
|
|
1445
2253
|
| Name | Required | Type | Description |
|
|
1446
2254
|
|---|---:|---|---|
|
|
1447
|
-
| `
|
|
1448
|
-
| `
|
|
2255
|
+
| `isDisabled` | no | boolean | Disables selection for this suggestion item |
|
|
2256
|
+
| `label` | no | string | Display text shown for the suggestion item |
|
|
2257
|
+
| `value` | no | string \| number | Value written when the suggestion is selected |
|
|
1449
2258
|
|
|
1450
|
-
|
|
2259
|
+
Additional properties: unknown.
|
|
1451
2260
|
|
|
1452
2261
|
## FormTextAutoSuggestValidationError
|
|
1453
2262
|
|
|
@@ -1459,6 +2268,20 @@ _No fields._
|
|
|
1459
2268
|
|
|
1460
2269
|
Additional properties: string.
|
|
1461
2270
|
|
|
2271
|
+
## FormTextStringPadding
|
|
2272
|
+
|
|
2273
|
+
Pads input value with character until reaching maxLength
|
|
2274
|
+
|
|
2275
|
+
### Fields
|
|
2276
|
+
|
|
2277
|
+
| Name | Required | Type | Description |
|
|
2278
|
+
|---|---:|---|---|
|
|
2279
|
+
| `character` | yes | string | Character to use for padding |
|
|
2280
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
2281
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
2282
|
+
|
|
2283
|
+
No additional properties.
|
|
2284
|
+
|
|
1462
2285
|
## FormTextValidationError
|
|
1463
2286
|
|
|
1464
2287
|
Map of rule name to error message
|
|
@@ -1469,6 +2292,28 @@ _No fields._
|
|
|
1469
2292
|
|
|
1470
2293
|
Additional properties: string.
|
|
1471
2294
|
|
|
2295
|
+
## FormTimeShouldAllowTimeSelection
|
|
2296
|
+
|
|
2297
|
+
### Fields
|
|
2298
|
+
|
|
2299
|
+
| Name | Required | Type | Description |
|
|
2300
|
+
|---|---:|---|---|
|
|
2301
|
+
| `reference` | no | string | Reference ISO time for period labels |
|
|
2302
|
+
|
|
2303
|
+
No additional properties.
|
|
2304
|
+
|
|
2305
|
+
## FormTimeTimezone
|
|
2306
|
+
|
|
2307
|
+
### Fields
|
|
2308
|
+
|
|
2309
|
+
| Name | Required | Type | Description |
|
|
2310
|
+
|---|---:|---|---|
|
|
2311
|
+
| `name` | yes | string | Input name for the timezone selector |
|
|
2312
|
+
| `isRequired` | no | boolean | Marks the timezone selector as required |
|
|
2313
|
+
| `value` | no | string | Selected timezone value |
|
|
2314
|
+
|
|
2315
|
+
No additional properties.
|
|
2316
|
+
|
|
1472
2317
|
## FormTimeValidationError
|
|
1473
2318
|
|
|
1474
2319
|
Map of rule name to error message
|
|
@@ -1520,6 +2365,7 @@ Additional properties: unknown.
|
|
|
1520
2365
|
|---|---:|---|---|
|
|
1521
2366
|
| `disabledInfo` | no | string \| [FormTreeDisabledInfo](./types.md#formtreedisabledinfo) | Tooltip shown when item is disabled |
|
|
1522
2367
|
| `isDisabled` | no | boolean | Disable this item |
|
|
2368
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
1523
2369
|
| `label` | yes | string | Display label for the item |
|
|
1524
2370
|
| `parent` | no | string | Parent item value, null for root items |
|
|
1525
2371
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -1545,6 +2391,7 @@ Additional properties: unknown.
|
|
|
1545
2391
|
| Name | Required | Type | Description |
|
|
1546
2392
|
|---|---:|---|---|
|
|
1547
2393
|
| `isDisabled` | no | boolean | Disable this item |
|
|
2394
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
1548
2395
|
| `label` | yes | string | Display label for the item |
|
|
1549
2396
|
| `parent` | no | string | Parent item value, null for root items |
|
|
1550
2397
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -1603,6 +2450,30 @@ _No fields._
|
|
|
1603
2450
|
|
|
1604
2451
|
Additional properties: unknown.
|
|
1605
2452
|
|
|
2453
|
+
## FormWorkEmailDomainList
|
|
2454
|
+
|
|
2455
|
+
### Fields
|
|
2456
|
+
|
|
2457
|
+
| Name | Required | Type | Description |
|
|
2458
|
+
|---|---:|---|---|
|
|
2459
|
+
| `isDisabled` | no | boolean | Disables this specific domain option |
|
|
2460
|
+
| `label` | no | string | Display label for the domain option |
|
|
2461
|
+
| `tag` | no | string \| [FormWorkEmailTag](./types.md#formworkemailtag) | Optional tag shown with the domain option |
|
|
2462
|
+
| `value` | yes | string | Domain option value |
|
|
2463
|
+
|
|
2464
|
+
No additional properties.
|
|
2465
|
+
|
|
2466
|
+
## FormWorkEmailTag
|
|
2467
|
+
|
|
2468
|
+
### Fields
|
|
2469
|
+
|
|
2470
|
+
| Name | Required | Type | Description |
|
|
2471
|
+
|---|---:|---|---|
|
|
2472
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Optional semantic appearance for the tag |
|
|
2473
|
+
| `text` | yes | string | Tag text displayed with the domain option |
|
|
2474
|
+
|
|
2475
|
+
No additional properties.
|
|
2476
|
+
|
|
1606
2477
|
## FormWorkEmailValidationError
|
|
1607
2478
|
|
|
1608
2479
|
Map of rule name to error message
|
|
@@ -1669,7 +2540,7 @@ Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens
|
|
|
1669
2540
|
| `leftIcon` | no | string \| [GridLeftIcon](./types.md#gridlefticon) | Icon displayed on the left side of the label |
|
|
1670
2541
|
| `maxWidth` | no | string | Maximum width CSS value for truncation |
|
|
1671
2542
|
| `rightIcon` | no | string \| [GridRightIcon](./types.md#gridrighticon) | Icon displayed on the right side of the label |
|
|
1672
|
-
| `size` | no | [
|
|
2543
|
+
| `size` | no | [ChipSize](./definitions.md#chipsize) | Size of the label. Default: LARGE |
|
|
1673
2544
|
| `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
|
|
1674
2545
|
| `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
|
|
1675
2546
|
|
|
@@ -1758,8 +2629,12 @@ No additional properties.
|
|
|
1758
2629
|
|
|
1759
2630
|
| Name | Required | Type | Description |
|
|
1760
2631
|
|---|---:|---|---|
|
|
2632
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
|
|
1761
2633
|
| `content` | yes | string | Tooltip content text |
|
|
1762
|
-
| `
|
|
2634
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent |
|
|
2635
|
+
| `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
|
|
2636
|
+
| `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
|
|
2637
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to button. Default: TOP_START |
|
|
1763
2638
|
|
|
1764
2639
|
No additional properties.
|
|
1765
2640
|
|
|
@@ -1901,6 +2776,24 @@ No additional properties.
|
|
|
1901
2776
|
|
|
1902
2777
|
No additional properties.
|
|
1903
2778
|
|
|
2779
|
+
## LabelValue
|
|
2780
|
+
|
|
2781
|
+
Label chip displayed next to the title
|
|
2782
|
+
|
|
2783
|
+
### Fields
|
|
2784
|
+
|
|
2785
|
+
| Name | Required | Type | Description |
|
|
2786
|
+
|---|---:|---|---|
|
|
2787
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Label appearance. Default: NEUTRAL |
|
|
2788
|
+
| `children` | no | string | Label text displayed in the chip |
|
|
2789
|
+
| `leftIcon` | no | string \| [ObjectUIHeaderLeftIcon](./types.md#objectuiheaderlefticon) | Left icon shown inside the label |
|
|
2790
|
+
| `maxWidth` | no | string | Maximum label width as a CSS value |
|
|
2791
|
+
| `rightIcon` | no | string \| [ObjectUIHeaderRightIcon](./types.md#objectuiheaderrighticon) | Right icon shown inside the label |
|
|
2792
|
+
| `size` | no | [ChipSize](./definitions.md#chipsize) | Label size. Default: LARGE |
|
|
2793
|
+
| `tip` | no | string | Tooltip text for the label. String tip content only in SDUI |
|
|
2794
|
+
|
|
2795
|
+
No additional properties.
|
|
2796
|
+
|
|
1904
2797
|
## LayoutBorder
|
|
1905
2798
|
|
|
1906
2799
|
Structured border using strict token parts
|
|
@@ -1971,18 +2864,45 @@ No additional properties.
|
|
|
1971
2864
|
|
|
1972
2865
|
| Name | Required | Type | Description |
|
|
1973
2866
|
|---|---:|---|---|
|
|
1974
|
-
| `border` | no | string | CSS border applied to the block wrapper, e.g. "1px solid #E0E0E0". |
|
|
1975
|
-
| `height` | no | number | Height in grid units. Default: 1 |
|
|
1976
|
-
| `identifier` | yes | string | Unique identifier for this layout entry. MUST exactly match the spec id of one of the board's direct child elements — that child is rendered inside this block. |
|
|
1977
|
-
| `maxHeight` | no | number | Maximum height in grid units |
|
|
1978
|
-
| `maxWidth` | no | number | Maximum width in grid units |
|
|
1979
|
-
| `minHeight` | no | number | Minimum height in grid units |
|
|
1980
|
-
| `minWidth` | no | number | Minimum width in grid units |
|
|
1981
|
-
| `shadow` | no | [LayoutValueShadow](./definitions.md#layoutvalueshadow) | Shadow token applied to the block wrapper, e.g. "shadowSm". |
|
|
1982
|
-
| `shapeCorner` | no | [BoxRadius](./definitions.md#boxradius) | Shape-corner radius token for this block, e.g. "shapeCornerMd". Overrides the parent board `blockShapeCorner` for this entry only. |
|
|
1983
|
-
| `width` | no | number | Width in grid units (1–12). Default: 3 |
|
|
1984
|
-
| `x` | no | number | Horizontal position in grid units. Auto-calculated when omitted. |
|
|
1985
|
-
| `y` | no | number | Vertical position in grid units. Auto-calculated when omitted. |
|
|
2867
|
+
| `border` | no | string | CSS border applied to the block wrapper, e.g. "1px solid #E0E0E0". |
|
|
2868
|
+
| `height` | no | number | Height in grid units. Default: 1 |
|
|
2869
|
+
| `identifier` | yes | string | Unique identifier for this layout entry. MUST exactly match the spec id of one of the board's direct child elements — that child is rendered inside this block. |
|
|
2870
|
+
| `maxHeight` | no | number | Maximum height in grid units |
|
|
2871
|
+
| `maxWidth` | no | number | Maximum width in grid units |
|
|
2872
|
+
| `minHeight` | no | number | Minimum height in grid units |
|
|
2873
|
+
| `minWidth` | no | number | Minimum width in grid units |
|
|
2874
|
+
| `shadow` | no | [LayoutValueShadow](./definitions.md#layoutvalueshadow) | Shadow token applied to the block wrapper, e.g. "shadowSm". |
|
|
2875
|
+
| `shapeCorner` | no | [BoxRadius](./definitions.md#boxradius) | Shape-corner radius token for this block, e.g. "shapeCornerMd". Overrides the parent board `blockShapeCorner` for this entry only. |
|
|
2876
|
+
| `width` | no | number | Width in grid units (1–12). Default: 3 |
|
|
2877
|
+
| `x` | no | number | Horizontal position in grid units. Auto-calculated when omitted. |
|
|
2878
|
+
| `y` | no | number | Vertical position in grid units. Auto-calculated when omitted. |
|
|
2879
|
+
|
|
2880
|
+
No additional properties.
|
|
2881
|
+
|
|
2882
|
+
## LinkValue
|
|
2883
|
+
|
|
2884
|
+
### Fields
|
|
2885
|
+
|
|
2886
|
+
| Name | Required | Type | Description |
|
|
2887
|
+
|---|---:|---|---|
|
|
2888
|
+
| `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the nested link tab |
|
|
2889
|
+
| `title` | yes | string | Display text for the nested link tab |
|
|
2890
|
+
|
|
2891
|
+
No additional properties.
|
|
2892
|
+
|
|
2893
|
+
## LoadConfig
|
|
2894
|
+
|
|
2895
|
+
Semantic Lottie load configuration object
|
|
2896
|
+
|
|
2897
|
+
### Fields
|
|
2898
|
+
|
|
2899
|
+
| Name | Required | Type | Description |
|
|
2900
|
+
|---|---:|---|---|
|
|
2901
|
+
| `animationData` | no | [AnimationData](./types.md#animationdata) | Lottie animation JSON object. Required if path is not provided |
|
|
2902
|
+
| `autoplay` | no | boolean | Start playing automatically on load. Default: true |
|
|
2903
|
+
| `loop` | no | boolean \| number | Loop animation. true for infinite, false for once, or number for specific count |
|
|
2904
|
+
| `path` | no | string | URL or relative path to the Lottie JSON animation file. Required if animationData is not provided |
|
|
2905
|
+
| `renderer` | no | [LoadConfigRenderer](./definitions.md#loadconfigrenderer) | Rendering method for the animation. Default: svg |
|
|
1986
2906
|
|
|
1987
2907
|
No additional properties.
|
|
1988
2908
|
|
|
@@ -2058,7 +2978,7 @@ No additional properties.
|
|
|
2058
2978
|
| `secondaryLabel` | no | string | Secondary text shown below the label |
|
|
2059
2979
|
| `tag` | no | string | Tag label shown beside the item text |
|
|
2060
2980
|
| `tertiaryLabel` | no | string | Tertiary text shown below secondary label |
|
|
2061
|
-
| `type` | no | [
|
|
2981
|
+
| `type` | no | [DropdownFooterType](./definitions.md#dropdownfootertype) | Visual style type for the item (WARNING or ALERT) |
|
|
2062
2982
|
| `value` | yes | string | Unique value for the item |
|
|
2063
2983
|
|
|
2064
2984
|
No additional properties.
|
|
@@ -2073,6 +2993,20 @@ _No fields._
|
|
|
2073
2993
|
|
|
2074
2994
|
Additional properties: unknown.
|
|
2075
2995
|
|
|
2996
|
+
## NestedListToggleIcon
|
|
2997
|
+
|
|
2998
|
+
Toggle icon configuration
|
|
2999
|
+
|
|
3000
|
+
### Fields
|
|
3001
|
+
|
|
3002
|
+
| Name | Required | Type | Description |
|
|
3003
|
+
|---|---:|---|---|
|
|
3004
|
+
| `align` | no | string | CSS alignSelf value. Default: center |
|
|
3005
|
+
| `margin` | no | [BoxGap](./definitions.md#boxgap) | Margin spacing token for icon alignment |
|
|
3006
|
+
| `size` | no | [IconSize](./definitions.md#iconsize) | Icon size token. Default: 24 |
|
|
3007
|
+
|
|
3008
|
+
No additional properties.
|
|
3009
|
+
|
|
2076
3010
|
## NumberArg
|
|
2077
3011
|
|
|
2078
3012
|
### Fields
|
|
@@ -2103,7 +3037,7 @@ Adds padding characters to the input value
|
|
|
2103
3037
|
|---|---:|---|---|
|
|
2104
3038
|
| `character` | yes | string | Character to use for padding |
|
|
2105
3039
|
| `maxLength` | yes | number | Target length after padding |
|
|
2106
|
-
| `position` | yes | [
|
|
3040
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Position to pad (start or end) |
|
|
2107
3041
|
|
|
2108
3042
|
No additional properties.
|
|
2109
3043
|
|
|
@@ -2117,7 +3051,7 @@ Avatar configuration for the header
|
|
|
2117
3051
|
|---|---:|---|---|
|
|
2118
3052
|
| `icon` | no | string | Icon type string when type is ICON |
|
|
2119
3053
|
| `image` | no | string | Image URL for the avatar |
|
|
2120
|
-
| `imageBackground` | no | [
|
|
3054
|
+
| `imageBackground` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color token for avatar image background |
|
|
2121
3055
|
| `isRound` | no | boolean | If false, square avatar is shown. Default: true |
|
|
2122
3056
|
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
|
|
2123
3057
|
|
|
@@ -2133,12 +3067,54 @@ Avatar configuration for the header
|
|
|
2133
3067
|
|---|---:|---|---|
|
|
2134
3068
|
| `icon` | no | string | Icon type string when type is ICON |
|
|
2135
3069
|
| `image` | no | string | Image URL for the avatar |
|
|
2136
|
-
| `imageBackground` | no | [
|
|
3070
|
+
| `imageBackground` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color token for avatar image background |
|
|
2137
3071
|
| `isRound` | no | boolean | If false, square avatar is shown. Default: true |
|
|
2138
3072
|
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
|
|
2139
3073
|
|
|
2140
3074
|
No additional properties.
|
|
2141
3075
|
|
|
3076
|
+
## ObjectUIHeaderLeftIcon
|
|
3077
|
+
|
|
3078
|
+
### Fields
|
|
3079
|
+
|
|
3080
|
+
| Name | Required | Type | Description |
|
|
3081
|
+
|---|---:|---|---|
|
|
3082
|
+
| `aria-describedby` | no | string | ID of the element describing the icon |
|
|
3083
|
+
| `aria-label` | no | string | Accessible label for the icon |
|
|
3084
|
+
| `aria-labelledby` | no | string | ID of the element labelling the icon |
|
|
3085
|
+
| `color` | no | string | Optional icon color value |
|
|
3086
|
+
| `type` | yes | string | Icon type string to render inside the label |
|
|
3087
|
+
|
|
3088
|
+
No additional properties.
|
|
3089
|
+
|
|
3090
|
+
## ObjectUIHeaderPrimaryAction
|
|
3091
|
+
|
|
3092
|
+
Primary action button. Clicking it emits the primaryAction event
|
|
3093
|
+
|
|
3094
|
+
### Fields
|
|
3095
|
+
|
|
3096
|
+
| Name | Required | Type | Description |
|
|
3097
|
+
|---|---:|---|---|
|
|
3098
|
+
| `icon` | no | string | Icon type string for the primary button |
|
|
3099
|
+
| `label` | yes | string | Label of the primary button |
|
|
3100
|
+
| `size` | no | [ButtonSize](./definitions.md#buttonsize) | Primary button size. Default: M |
|
|
3101
|
+
|
|
3102
|
+
No additional properties.
|
|
3103
|
+
|
|
3104
|
+
## ObjectUIHeaderRightIcon
|
|
3105
|
+
|
|
3106
|
+
### Fields
|
|
3107
|
+
|
|
3108
|
+
| Name | Required | Type | Description |
|
|
3109
|
+
|---|---:|---|---|
|
|
3110
|
+
| `aria-describedby` | no | string | ID of the element describing the icon |
|
|
3111
|
+
| `aria-label` | no | string | Accessible label for the icon |
|
|
3112
|
+
| `aria-labelledby` | no | string | ID of the element labelling the icon |
|
|
3113
|
+
| `color` | no | string | Optional icon color value |
|
|
3114
|
+
| `type` | yes | string | Icon type string to render inside the label |
|
|
3115
|
+
|
|
3116
|
+
No additional properties.
|
|
3117
|
+
|
|
2142
3118
|
## ObjectUIStatsAction
|
|
2143
3119
|
|
|
2144
3120
|
### Fields
|
|
@@ -2195,7 +3171,7 @@ Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens
|
|
|
2195
3171
|
| `leftIcon` | no | string \| [ObjectUIStatsLeftIcon](./types.md#objectuistatslefticon) | Icon displayed on the left side of the label |
|
|
2196
3172
|
| `maxWidth` | no | string | Maximum width CSS value for truncation |
|
|
2197
3173
|
| `rightIcon` | no | string \| [ObjectUIStatsRightIcon](./types.md#objectuistatsrighticon) | Icon displayed on the right side of the label |
|
|
2198
|
-
| `size` | no | [
|
|
3174
|
+
| `size` | no | [ChipSize](./definitions.md#chipsize) | Size of the label. Default: LARGE |
|
|
2199
3175
|
| `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
|
|
2200
3176
|
| `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
|
|
2201
3177
|
|
|
@@ -2236,7 +3212,7 @@ No additional properties.
|
|
|
2236
3212
|
|
|
2237
3213
|
| Name | Required | Type | Description |
|
|
2238
3214
|
|---|---:|---|---|
|
|
2239
|
-
| `actionType` | no | [PageHeaderActionActionType](./definitions.md#pageheaderactionactiontype) | Type of action
|
|
3215
|
+
| `actionType` | no | [PageHeaderActionActionType](./definitions.md#pageheaderactionactiontype) | JSON-only extension. Type of action renderer. Default: button |
|
|
2240
3216
|
| `appearance` | no | [AppNavBarActionAppearance](./definitions.md#appnavbaractionappearance) | Button visual style. Default: PRIMARY |
|
|
2241
3217
|
| `icon` | no | string | Icon name from Icon.TYPES (e.g. ADD, EDIT_OUTLINE) |
|
|
2242
3218
|
| `id` | yes | string | Unique identifier for the action. Written to actionClickedId state on click |
|
|
@@ -2298,7 +3274,7 @@ Pads input value with character until reaching maxLength
|
|
|
2298
3274
|
|---|---:|---|---|
|
|
2299
3275
|
| `character` | yes | string | Character to use for padding |
|
|
2300
3276
|
| `maxLength` | yes | number | Target length after padding |
|
|
2301
|
-
| `position` | yes | [
|
|
3277
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
2302
3278
|
|
|
2303
3279
|
No additional properties.
|
|
2304
3280
|
|
|
@@ -2342,23 +3318,58 @@ Additional properties: unknown.
|
|
|
2342
3318
|
|
|
2343
3319
|
No additional properties.
|
|
2344
3320
|
|
|
2345
|
-
##
|
|
3321
|
+
## PhoneCountryCode
|
|
2346
3322
|
|
|
2347
|
-
|
|
3323
|
+
Country-code dropdown configuration preserving the serializable CountryCodeProp shape
|
|
2348
3324
|
|
|
2349
3325
|
### Fields
|
|
2350
3326
|
|
|
2351
3327
|
| Name | Required | Type | Description |
|
|
2352
3328
|
|---|---:|---|---|
|
|
2353
|
-
| `
|
|
2354
|
-
| `
|
|
2355
|
-
| `
|
|
3329
|
+
| `name` | no | string | Name for the country-code select input |
|
|
3330
|
+
| `aria-describedby` | no | string | ID of the element that describes the country-code dropdown |
|
|
3331
|
+
| `aria-label` | no | string | Accessible label for the country-code dropdown |
|
|
3332
|
+
| `aria-labelledby` | no | string | ID of the element that labels the country-code dropdown |
|
|
3333
|
+
| `canClear` | no | boolean | Show clear button in the country-code dropdown |
|
|
3334
|
+
| `defaultSearchQuery` | no | string | Initial search query for the country-code dropdown |
|
|
3335
|
+
| `defaultValue` | no | string | Initial selected country code for the dropdown branch |
|
|
3336
|
+
| `dropdownHeight` | no | number | Country-code dropdown menu height in pixels |
|
|
3337
|
+
| `emptyListPlaceholder` | no | string \| [PhoneEmptyListPlaceholder](./types.md#phoneemptylistplaceholder) | Placeholder shown when the country-code dropdown list is empty |
|
|
3338
|
+
| `fuseOptions` | no | [PhoneFuseOption](./types.md#phonefuseoption) | Fuse.js search options for the country-code dropdown |
|
|
3339
|
+
| `id` | no | string | HTML id attribute for the country-code select input |
|
|
3340
|
+
| `isDisabled` | no | boolean | Disables the country-code dropdown |
|
|
3341
|
+
| `isMenuDefaultOpen` | no | boolean | If true, the country-code dropdown opens by default |
|
|
3342
|
+
| `isPositionFixed` | no | boolean | Position the country-code dropdown relative to the viewport |
|
|
3343
|
+
| `isReadOnly` | no | boolean | Makes the country-code dropdown read-only |
|
|
3344
|
+
| `isRequired` | no | boolean | Marks the country-code dropdown as required |
|
|
3345
|
+
| `maxHeight` | no | string \| number | Maximum dropdown height or chip container height as a CSS value |
|
|
3346
|
+
| `placement` | no | [AppGroupSelectPlacement](./definitions.md#appgroupselectplacement) | Country-code dropdown placement. Default: bottom-start |
|
|
3347
|
+
| `rows` | no | number | Minimum row count for the country-code dropdown |
|
|
3348
|
+
| `scrollThreshold` | no | number | Extra pixels rendered above and below the viewport in paginated mode |
|
|
3349
|
+
| `shouldFocusFirstElement` | no | boolean | Auto-focus the first dropdown item when the menu opens |
|
|
3350
|
+
| `shouldShowSearchIcon` | no | boolean | Show the search icon inside the country-code dropdown |
|
|
3351
|
+
| `shouldUsePortal` | no | boolean | Render the country-code dropdown in a React portal |
|
|
3352
|
+
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Country-code dropdown size. Default: M |
|
|
3353
|
+
| `theme` | no | [FormTimezoneTheme](./definitions.md#formtimezonetheme) | Country-code dropdown theme variant |
|
|
3354
|
+
| `value` | no | string | Controlled selected country code for the dropdown branch |
|
|
3355
|
+
|
|
3356
|
+
No additional properties.
|
|
3357
|
+
|
|
3358
|
+
## PhoneEmptyListPlaceholder
|
|
3359
|
+
|
|
3360
|
+
### Fields
|
|
3361
|
+
|
|
3362
|
+
| Name | Required | Type | Description |
|
|
3363
|
+
|---|---:|---|---|
|
|
3364
|
+
| `onLoading` | no | string | Placeholder shown while the dropdown list is loading |
|
|
3365
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query is entered |
|
|
3366
|
+
| `onNoSearchResults` | no | string | Placeholder shown when no matching regions are found |
|
|
2356
3367
|
|
|
2357
3368
|
No additional properties.
|
|
2358
3369
|
|
|
2359
|
-
##
|
|
3370
|
+
## PhoneFuseOption
|
|
2360
3371
|
|
|
2361
|
-
|
|
3372
|
+
Fuse.js search options for the country-code dropdown
|
|
2362
3373
|
|
|
2363
3374
|
### Fields
|
|
2364
3375
|
|
|
@@ -2366,16 +3377,30 @@ _No fields._
|
|
|
2366
3377
|
|
|
2367
3378
|
Additional properties: unknown.
|
|
2368
3379
|
|
|
2369
|
-
##
|
|
3380
|
+
## PhoneStringPadding
|
|
3381
|
+
|
|
3382
|
+
Pads input value with character until reaching maxLength
|
|
3383
|
+
|
|
3384
|
+
### Fields
|
|
3385
|
+
|
|
3386
|
+
| Name | Required | Type | Description |
|
|
3387
|
+
|---|---:|---|---|
|
|
3388
|
+
| `character` | yes | string | Character to use for padding |
|
|
3389
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
3390
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
3391
|
+
|
|
3392
|
+
No additional properties.
|
|
3393
|
+
|
|
3394
|
+
## PopperProp
|
|
3395
|
+
|
|
3396
|
+
Serializable popover options; middleware functions are not supported
|
|
2370
3397
|
|
|
2371
3398
|
### Fields
|
|
2372
3399
|
|
|
2373
3400
|
| Name | Required | Type | Description |
|
|
2374
3401
|
|---|---:|---|---|
|
|
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. |
|
|
3402
|
+
| `placement` | no | [FormTreeSelectPlacement](./definitions.md#formtreeselectplacement) | Popover placement |
|
|
3403
|
+
| `shouldFlipIfNoSpace` | no | boolean | Whether the popover flips when there is not enough space |
|
|
2379
3404
|
|
|
2380
3405
|
No additional properties.
|
|
2381
3406
|
|
|
@@ -2423,7 +3448,7 @@ Additional properties: unknown.
|
|
|
2423
3448
|
|
|
2424
3449
|
No additional properties.
|
|
2425
3450
|
|
|
2426
|
-
##
|
|
3451
|
+
## RadioList
|
|
2427
3452
|
|
|
2428
3453
|
### Fields
|
|
2429
3454
|
|
|
@@ -2480,37 +3505,6 @@ _No fields._
|
|
|
2480
3505
|
|
|
2481
3506
|
Additional properties: string.
|
|
2482
3507
|
|
|
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
3508
|
## Role
|
|
2515
3509
|
|
|
2516
3510
|
### Fields
|
|
@@ -2566,6 +3560,22 @@ Additional properties: unknown.
|
|
|
2566
3560
|
|
|
2567
3561
|
No additional properties.
|
|
2568
3562
|
|
|
3563
|
+
## SegmentedControlList
|
|
3564
|
+
|
|
3565
|
+
### Fields
|
|
3566
|
+
|
|
3567
|
+
| Name | Required | Type | Description |
|
|
3568
|
+
|---|---:|---|---|
|
|
3569
|
+
| `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style for this specific option |
|
|
3570
|
+
| `aria-label` | no | string | Accessible label, required if label is not provided (e.g. for icon-only items) |
|
|
3571
|
+
| `icon` | no | string | Icon to display for icon-only items. Requires aria-label or label for accessibility |
|
|
3572
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
3573
|
+
| `label` | no | string | Display text for the option |
|
|
3574
|
+
| `tip` | no | [SegmentedControlTip](./types.md#segmentedcontroltip) | Tooltip to show on hover for this option |
|
|
3575
|
+
| `value` | yes | string | Value stored when option is selected |
|
|
3576
|
+
|
|
3577
|
+
No additional properties.
|
|
3578
|
+
|
|
2569
3579
|
## SegmentedControlOption
|
|
2570
3580
|
|
|
2571
3581
|
### Fields
|
|
@@ -2680,6 +3690,23 @@ No additional properties.
|
|
|
2680
3690
|
|
|
2681
3691
|
No additional properties.
|
|
2682
3692
|
|
|
3693
|
+
## SelectedEmoji
|
|
3694
|
+
|
|
3695
|
+
Bindable selected emoji data written before the change event emits
|
|
3696
|
+
|
|
3697
|
+
### Fields
|
|
3698
|
+
|
|
3699
|
+
| Name | Required | Type | Description |
|
|
3700
|
+
|---|---:|---|---|
|
|
3701
|
+
| `name` | yes | string | Descriptive emoji name |
|
|
3702
|
+
| `id` | yes | string | Unique identifier for the emoji |
|
|
3703
|
+
| `keywords` | yes | string[] | Search keywords for the emoji |
|
|
3704
|
+
| `native` | yes | string | Native emoji character |
|
|
3705
|
+
| `shortcodes` | yes | string | Short-form emoji representation |
|
|
3706
|
+
| `unified` | yes | string | Unicode representation for the emoji |
|
|
3707
|
+
|
|
3708
|
+
No additional properties.
|
|
3709
|
+
|
|
2683
3710
|
## SelectEmptyListPlaceholder
|
|
2684
3711
|
|
|
2685
3712
|
### Fields
|
|
@@ -2715,6 +3742,29 @@ _No fields._
|
|
|
2715
3742
|
|
|
2716
3743
|
Additional properties: unknown.
|
|
2717
3744
|
|
|
3745
|
+
## SelectList
|
|
3746
|
+
|
|
3747
|
+
### Fields
|
|
3748
|
+
|
|
3749
|
+
| Name | Required | Type | Description |
|
|
3750
|
+
|---|---:|---|---|
|
|
3751
|
+
| `avatarProps` | no | [SelectAvatarProp](./types.md#selectavatarprop) | Avatar configuration for the option |
|
|
3752
|
+
| `description` | no | string | Description text shown below the label |
|
|
3753
|
+
| `flag` | no | string | Two-letter country code for flag icon (e.g. "US", "IN") |
|
|
3754
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
3755
|
+
| `isRecommended` | no | boolean | Marks option as recommended with a badge |
|
|
3756
|
+
| `isSeparator` | no | boolean | Renders as a visual separator instead of selectable option |
|
|
3757
|
+
| `label` | yes | string | Display text for the option |
|
|
3758
|
+
| `labelIcon` | no | string | Icon glyph name to show next to the label |
|
|
3759
|
+
| `leftIconType` | no | string | Icon glyph name to show on the left. E.g. "CHECK_CIRCLE_OUTLINE" |
|
|
3760
|
+
| `quaternaryLabel` | no | string | Quaternary label shown below tertiary label |
|
|
3761
|
+
| `rightLabel` | no | string | Label aligned to the right side of the option |
|
|
3762
|
+
| `secondaryLabel` | no | string | Secondary label shown below the main label |
|
|
3763
|
+
| `tertiaryLabel` | no | string | Tertiary label shown below secondary label |
|
|
3764
|
+
| `value` | yes | unknown | Value stored when option is selected |
|
|
3765
|
+
|
|
3766
|
+
No additional properties.
|
|
3767
|
+
|
|
2718
3768
|
## SelectOption
|
|
2719
3769
|
|
|
2720
3770
|
### Fields
|
|
@@ -2814,6 +3864,18 @@ Horizontal size constraints for desktop layout. Object with optional default/min
|
|
|
2814
3864
|
|
|
2815
3865
|
No additional properties.
|
|
2816
3866
|
|
|
3867
|
+
## SkipButton
|
|
3868
|
+
|
|
3869
|
+
Secondary skip action. Click emits the skip event.
|
|
3870
|
+
|
|
3871
|
+
### Fields
|
|
3872
|
+
|
|
3873
|
+
| Name | Required | Type | Description |
|
|
3874
|
+
|---|---:|---|---|
|
|
3875
|
+
| `label` | no | string | Skip button label. Defaults to the Pebble skip label |
|
|
3876
|
+
|
|
3877
|
+
No additional properties.
|
|
3878
|
+
|
|
2817
3879
|
## Slide
|
|
2818
3880
|
|
|
2819
3881
|
### Fields
|
|
@@ -2902,21 +3964,6 @@ No additional properties.
|
|
|
2902
3964
|
|
|
2903
3965
|
No additional properties.
|
|
2904
3966
|
|
|
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
3967
|
## StepperAvatar
|
|
2921
3968
|
|
|
2922
3969
|
Avatar configuration to display with the step. Supports image URLs
|
|
@@ -2967,6 +4014,7 @@ Configuration for the form submit button
|
|
|
2967
4014
|
|
|
2968
4015
|
| Name | Required | Type | Description |
|
|
2969
4016
|
|---|---:|---|---|
|
|
4017
|
+
| `icon` | no | string \| [FormIcon](./types.md#formicon) | Icon to show in the submit button |
|
|
2970
4018
|
| `isDisabled` | no | boolean | Disable submit button |
|
|
2971
4019
|
| `isFluid` | no | boolean | Stretch submit button to fill width |
|
|
2972
4020
|
| `isLoading` | no | boolean | Show loading spinner on submit button. Bind to state for manual control. |
|
|
@@ -2986,6 +4034,18 @@ No additional properties.
|
|
|
2986
4034
|
|
|
2987
4035
|
No additional properties.
|
|
2988
4036
|
|
|
4037
|
+
## SupportLink
|
|
4038
|
+
|
|
4039
|
+
### Fields
|
|
4040
|
+
|
|
4041
|
+
| Name | Required | Type | Description |
|
|
4042
|
+
|---|---:|---|---|
|
|
4043
|
+
| `href` | no | string | URL for the support/help link |
|
|
4044
|
+
| `icon` | no | string | Pebble icon name for the support link |
|
|
4045
|
+
| `text` | no | string | Visible support link text override |
|
|
4046
|
+
|
|
4047
|
+
No additional properties.
|
|
4048
|
+
|
|
2989
4049
|
## SurveyArg
|
|
2990
4050
|
|
|
2991
4051
|
### Fields
|
|
@@ -3012,9 +4072,10 @@ No additional properties.
|
|
|
3012
4072
|
|
|
3013
4073
|
| Name | Required | Type | Description |
|
|
3014
4074
|
|---|---:|---|---|
|
|
4075
|
+
| `icon` | no | string | Pebble icon name displayed for the option |
|
|
3015
4076
|
| `isDisabled` | no | boolean | Disable this specific option |
|
|
3016
4077
|
| `label` | no | string \| number | Display label for the option |
|
|
3017
|
-
| `selectionColor` | no | [
|
|
4078
|
+
| `selectionColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Override selected surface color token for this option |
|
|
3018
4079
|
| `value` | yes | string \| number | Value when selected |
|
|
3019
4080
|
|
|
3020
4081
|
No additional properties.
|
|
@@ -3052,6 +4113,17 @@ Additional properties: unknown.
|
|
|
3052
4113
|
|
|
3053
4114
|
No additional properties.
|
|
3054
4115
|
|
|
4116
|
+
## SwitchTip
|
|
4117
|
+
|
|
4118
|
+
### Fields
|
|
4119
|
+
|
|
4120
|
+
| Name | Required | Type | Description |
|
|
4121
|
+
|---|---:|---|---|
|
|
4122
|
+
| `content` | yes | string | Tooltip text content |
|
|
4123
|
+
| `placement` | no | [SwitchTipPlacement](./definitions.md#switchtipplacement) | Tooltip placement relative to the switch |
|
|
4124
|
+
|
|
4125
|
+
No additional properties.
|
|
4126
|
+
|
|
3055
4127
|
## TabBadge
|
|
3056
4128
|
|
|
3057
4129
|
Badge to display on the tab
|
|
@@ -3072,11 +4144,24 @@ No additional properties.
|
|
|
3072
4144
|
| Name | Required | Type | Description |
|
|
3073
4145
|
|---|---:|---|---|
|
|
3074
4146
|
| `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the tab |
|
|
3075
|
-
| `
|
|
4147
|
+
| `href` | no | string | Semantic href for LINK tabs; navigation is prevented by Pebble Tabs |
|
|
3076
4148
|
| `icon` | no | string | Icon name for the tab (e.g., FOLDER_OUTLINE) |
|
|
3077
|
-
| `
|
|
4149
|
+
| `isDisabled` | no | boolean | Whether this tab is disabled |
|
|
3078
4150
|
| `tip` | no | string \| [TabTip](./types.md#tabtip) | Tooltip to show on hover |
|
|
3079
|
-
| `
|
|
4151
|
+
| `title` | yes | string | Display text for the tab |
|
|
4152
|
+
| `value` | yes | unknown | JSON-only tab value stored when the tab changes |
|
|
4153
|
+
|
|
4154
|
+
No additional properties.
|
|
4155
|
+
|
|
4156
|
+
## TabList
|
|
4157
|
+
|
|
4158
|
+
### Fields
|
|
4159
|
+
|
|
4160
|
+
| Name | Required | Type | Description |
|
|
4161
|
+
|---|---:|---|---|
|
|
4162
|
+
| `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the link tab |
|
|
4163
|
+
| `links` | no | [LinkValue](./types.md#linkvalue)[] | Nested link tabs for vertical LINK tabs |
|
|
4164
|
+
| `title` | yes | string | Display text for the link-style tab |
|
|
3080
4165
|
|
|
3081
4166
|
No additional properties.
|
|
3082
4167
|
|
|
@@ -3131,28 +4216,38 @@ Additional properties: unknown.
|
|
|
3131
4216
|
|
|
3132
4217
|
No additional properties.
|
|
3133
4218
|
|
|
3134
|
-
##
|
|
4219
|
+
## TextAutoSuggestFuseOption
|
|
3135
4220
|
|
|
3136
|
-
|
|
4221
|
+
Fuse.js search options for customizing suggestion filtering
|
|
4222
|
+
|
|
4223
|
+
### Fields
|
|
4224
|
+
|
|
4225
|
+
_No fields._
|
|
4226
|
+
|
|
4227
|
+
Additional properties: unknown.
|
|
4228
|
+
|
|
4229
|
+
## TextAutoSuggestList
|
|
3137
4230
|
|
|
3138
4231
|
### Fields
|
|
3139
4232
|
|
|
3140
4233
|
| Name | Required | Type | Description |
|
|
3141
4234
|
|---|---:|---|---|
|
|
3142
|
-
| `
|
|
3143
|
-
| `
|
|
3144
|
-
| `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Where to add padding: start or end |
|
|
4235
|
+
| `label` | yes | string | Display text for the suggestion |
|
|
4236
|
+
| `value` | yes | string \| number | Value stored when suggestion is selected |
|
|
3145
4237
|
|
|
3146
4238
|
No additional properties.
|
|
3147
4239
|
|
|
3148
|
-
##
|
|
4240
|
+
## TextAutoSuggestStringPadding
|
|
4241
|
+
|
|
4242
|
+
Pads input value with character until reaching maxLength
|
|
3149
4243
|
|
|
3150
4244
|
### Fields
|
|
3151
4245
|
|
|
3152
4246
|
| Name | Required | Type | Description |
|
|
3153
4247
|
|---|---:|---|---|
|
|
3154
|
-
| `
|
|
3155
|
-
| `
|
|
4248
|
+
| `character` | yes | string | Character to use for padding |
|
|
4249
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
4250
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
3156
4251
|
|
|
3157
4252
|
No additional properties.
|
|
3158
4253
|
|
|
@@ -3186,7 +4281,7 @@ Pads input value with character until reaching maxLength
|
|
|
3186
4281
|
|---|---:|---|---|
|
|
3187
4282
|
| `character` | yes | string | Character to use for padding |
|
|
3188
4283
|
| `maxLength` | yes | number | Target length after padding |
|
|
3189
|
-
| `position` | yes | [
|
|
4284
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
3190
4285
|
|
|
3191
4286
|
No additional properties.
|
|
3192
4287
|
|
|
@@ -3242,6 +4337,38 @@ Additional properties: unknown.
|
|
|
3242
4337
|
|
|
3243
4338
|
No additional properties.
|
|
3244
4339
|
|
|
4340
|
+
## TimeRangeShouldAllowTimeSelection
|
|
4341
|
+
|
|
4342
|
+
### Fields
|
|
4343
|
+
|
|
4344
|
+
| Name | Required | Type | Description |
|
|
4345
|
+
|---|---:|---|---|
|
|
4346
|
+
| `reference` | no | string | Reference ISO time for period labels |
|
|
4347
|
+
|
|
4348
|
+
No additional properties.
|
|
4349
|
+
|
|
4350
|
+
## TimeShouldAllowTimeSelection
|
|
4351
|
+
|
|
4352
|
+
### Fields
|
|
4353
|
+
|
|
4354
|
+
| Name | Required | Type | Description |
|
|
4355
|
+
|---|---:|---|---|
|
|
4356
|
+
| `reference` | no | string | Reference ISO time for period labels |
|
|
4357
|
+
|
|
4358
|
+
No additional properties.
|
|
4359
|
+
|
|
4360
|
+
## TimeTimezone
|
|
4361
|
+
|
|
4362
|
+
### Fields
|
|
4363
|
+
|
|
4364
|
+
| Name | Required | Type | Description |
|
|
4365
|
+
|---|---:|---|---|
|
|
4366
|
+
| `name` | yes | string | Input name for the timezone selector |
|
|
4367
|
+
| `isRequired` | no | boolean | Marks the timezone selector as required |
|
|
4368
|
+
| `value` | no | string | Selected timezone value |
|
|
4369
|
+
|
|
4370
|
+
No additional properties.
|
|
4371
|
+
|
|
3245
4372
|
## TimezoneArg
|
|
3246
4373
|
|
|
3247
4374
|
### Fields
|
|
@@ -3262,17 +4389,14 @@ Additional properties: unknown.
|
|
|
3262
4389
|
|
|
3263
4390
|
No additional properties.
|
|
3264
4391
|
|
|
3265
|
-
##
|
|
3266
|
-
|
|
3267
|
-
Toggle icon configuration
|
|
4392
|
+
## Title
|
|
3268
4393
|
|
|
3269
4394
|
### Fields
|
|
3270
4395
|
|
|
3271
4396
|
| Name | Required | Type | Description |
|
|
3272
4397
|
|---|---:|---|---|
|
|
3273
|
-
| `
|
|
3274
|
-
| `
|
|
3275
|
-
| `size` | no | [IconSize](./definitions.md#iconsize) | Icon size token. Default: 24 |
|
|
4398
|
+
| `kind` | yes | "BREADCRUMB" | Render the drawer title as a Breadcrumb |
|
|
4399
|
+
| `props` | yes | [DrawerProp](./types.md#drawerprop) | Breadcrumb props for the drawer title |
|
|
3276
4400
|
|
|
3277
4401
|
No additional properties.
|
|
3278
4402
|
|
|
@@ -3339,6 +4463,7 @@ Additional properties: unknown.
|
|
|
3339
4463
|
|---|---:|---|---|
|
|
3340
4464
|
| `disabledInfo` | no | string \| [TreeDisabledInfo](./types.md#treedisabledinfo) | Tooltip shown when item is disabled |
|
|
3341
4465
|
| `isDisabled` | no | boolean | Disable this item |
|
|
4466
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
3342
4467
|
| `label` | yes | string | Display label for the item |
|
|
3343
4468
|
| `parent` | no | string | Parent item value, null for root items |
|
|
3344
4469
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -3384,6 +4509,7 @@ Additional properties: unknown.
|
|
|
3384
4509
|
| Name | Required | Type | Description |
|
|
3385
4510
|
|---|---:|---|---|
|
|
3386
4511
|
| `isDisabled` | no | boolean | Disable this item |
|
|
4512
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
3387
4513
|
| `label` | yes | string | Display label for the item |
|
|
3388
4514
|
| `parent` | no | string | Parent item value, null for root items |
|
|
3389
4515
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -3473,3 +4599,27 @@ Additional properties: unknown.
|
|
|
3473
4599
|
| `type` | yes | string | |
|
|
3474
4600
|
|
|
3475
4601
|
No additional properties.
|
|
4602
|
+
|
|
4603
|
+
## WorkEmailDomainList
|
|
4604
|
+
|
|
4605
|
+
### Fields
|
|
4606
|
+
|
|
4607
|
+
| Name | Required | Type | Description |
|
|
4608
|
+
|---|---:|---|---|
|
|
4609
|
+
| `isDisabled` | no | boolean | Disables this specific domain option |
|
|
4610
|
+
| `label` | no | string | Display label for the domain option |
|
|
4611
|
+
| `tag` | no | string \| [WorkEmailTag](./types.md#workemailtag) | Optional tag shown with the domain option |
|
|
4612
|
+
| `value` | yes | string | Domain option value |
|
|
4613
|
+
|
|
4614
|
+
No additional properties.
|
|
4615
|
+
|
|
4616
|
+
## WorkEmailTag
|
|
4617
|
+
|
|
4618
|
+
### Fields
|
|
4619
|
+
|
|
4620
|
+
| Name | Required | Type | Description |
|
|
4621
|
+
|---|---:|---|---|
|
|
4622
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Optional semantic appearance for the tag |
|
|
4623
|
+
| `text` | yes | string | Tag text displayed with the domain option |
|
|
4624
|
+
|
|
4625
|
+
No additional properties.
|