@rippling/pebble-sdui-web 0.7.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/catalog.d.ts +1 -1
- package/dist/catalogs/custom-apps/component-events.d.ts +16 -13
- package/dist/catalogs/custom-apps/component-props.d.ts +973 -161
- package/dist/catalogs/custom-apps/components.d.ts +5 -2
- 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 +5951 -1306
- 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 +450 -222
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +274 -242
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +1329 -116
- 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,6 +922,21 @@ No additional properties.
|
|
|
685
922
|
|
|
686
923
|
No additional properties.
|
|
687
924
|
|
|
925
|
+
## DisabledTip
|
|
926
|
+
|
|
927
|
+
### Fields
|
|
928
|
+
|
|
929
|
+
| Name | Required | Type | Description |
|
|
930
|
+
|---|---:|---|---|
|
|
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 |
|
|
937
|
+
|
|
938
|
+
No additional properties.
|
|
939
|
+
|
|
688
940
|
## DraggableListList
|
|
689
941
|
|
|
690
942
|
### Fields
|
|
@@ -694,6 +946,68 @@ No additional properties.
|
|
|
694
946
|
| `id` | yes | string \| number | Unique identifier for the item |
|
|
695
947
|
| `label` | no | string | Display label for the item |
|
|
696
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
|
+
|
|
697
1011
|
No additional properties.
|
|
698
1012
|
|
|
699
1013
|
## DropdownDisabledInfo
|
|
@@ -706,6 +1020,28 @@ No additional properties.
|
|
|
706
1020
|
|
|
707
1021
|
No additional properties.
|
|
708
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
|
+
|
|
709
1045
|
## DropdownList
|
|
710
1046
|
|
|
711
1047
|
### Fields
|
|
@@ -725,15 +1061,38 @@ No additional properties.
|
|
|
725
1061
|
|---|---:|---|---|
|
|
726
1062
|
| `disabledInfo` | no | string \| [DropdownDisabledInfo](./types.md#dropdowndisabledinfo) | Tooltip content shown when the option is disabled |
|
|
727
1063
|
| `isDisabled` | no | boolean | Disables this option |
|
|
728
|
-
| `label` |
|
|
1064
|
+
| `label` | no | string | Display text for the option |
|
|
729
1065
|
| `labelIcon` | no | string | Icon name to show next to the label |
|
|
730
1066
|
| `leftIconType` | no | string | Icon name to show on the left side of the item |
|
|
731
1067
|
| `quaternaryLabel` | no | string | Quaternary text below the tertiary label |
|
|
732
1068
|
| `secondaryLabel` | no | string | Secondary text below the main label |
|
|
733
|
-
| `tag` | no | string | Tag
|
|
1069
|
+
| `tag` | no | string \| [DropdownTag](./types.md#dropdowntag) | Tag shown beside the option text |
|
|
734
1070
|
| `tertiaryLabel` | no | string | Tertiary text below the secondary label |
|
|
735
|
-
| `type` | no | [
|
|
736
|
-
| `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 |
|
|
737
1096
|
|
|
738
1097
|
No additional properties.
|
|
739
1098
|
|
|
@@ -757,6 +1116,88 @@ Additional properties: unknown.
|
|
|
757
1116
|
|
|
758
1117
|
No additional properties.
|
|
759
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
|
+
|
|
760
1201
|
## FileDropArg
|
|
761
1202
|
|
|
762
1203
|
### Fields
|
|
@@ -785,7 +1226,7 @@ Cropper configuration
|
|
|
785
1226
|
|
|
786
1227
|
| Name | Required | Type | Description |
|
|
787
1228
|
|---|---:|---|---|
|
|
788
|
-
| `aspectRatio` | no | [
|
|
1229
|
+
| `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
789
1230
|
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
790
1231
|
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
791
1232
|
| `title` | no | string | Title for the cropper modal |
|
|
@@ -826,6 +1267,25 @@ No additional properties.
|
|
|
826
1267
|
|
|
827
1268
|
No additional properties.
|
|
828
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
|
+
|
|
829
1289
|
## FloatingButtonIcon
|
|
830
1290
|
|
|
831
1291
|
### Fields
|
|
@@ -843,8 +1303,12 @@ No additional properties.
|
|
|
843
1303
|
|
|
844
1304
|
| Name | Required | Type | Description |
|
|
845
1305
|
|---|---:|---|---|
|
|
1306
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
|
|
846
1307
|
| `content` | yes | string | Tooltip content text |
|
|
847
|
-
| `
|
|
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 |
|
|
848
1312
|
|
|
849
1313
|
No additional properties.
|
|
850
1314
|
|
|
@@ -859,7 +1323,7 @@ No additional properties.
|
|
|
859
1323
|
|
|
860
1324
|
No additional properties.
|
|
861
1325
|
|
|
862
|
-
##
|
|
1326
|
+
## FormCheckboxGroupList
|
|
863
1327
|
|
|
864
1328
|
### Fields
|
|
865
1329
|
|
|
@@ -869,23 +1333,160 @@ No additional properties.
|
|
|
869
1333
|
| `label` | yes | string | Display text for the checkbox option |
|
|
870
1334
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
871
1335
|
| `tag` | no | string \| [FormCheckboxGroupTag](./types.md#formcheckboxgrouptag) | Optional tag/label displayed with the option |
|
|
872
|
-
| `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 |
|
|
873
1337
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
874
1338
|
|
|
875
|
-
No additional properties.
|
|
1339
|
+
No additional properties.
|
|
1340
|
+
|
|
1341
|
+
## FormCheckboxGroupTag
|
|
1342
|
+
|
|
1343
|
+
### Fields
|
|
1344
|
+
|
|
1345
|
+
| Name | Required | Type | Description |
|
|
1346
|
+
|---|---:|---|---|
|
|
1347
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
|
|
1348
|
+
| `label` | yes | string | Tag label text |
|
|
1349
|
+
|
|
1350
|
+
No additional properties.
|
|
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
|
+
|
|
1380
|
+
## FormCheckboxGroupValidationError
|
|
1381
|
+
|
|
1382
|
+
Map of rule name to error message
|
|
1383
|
+
|
|
1384
|
+
### Fields
|
|
1385
|
+
|
|
1386
|
+
_No fields._
|
|
1387
|
+
|
|
1388
|
+
Additional properties: string.
|
|
1389
|
+
|
|
1390
|
+
## FormCheckboxValidationError
|
|
1391
|
+
|
|
1392
|
+
Map of rule name to error message
|
|
1393
|
+
|
|
1394
|
+
### Fields
|
|
1395
|
+
|
|
1396
|
+
_No fields._
|
|
1397
|
+
|
|
1398
|
+
Additional properties: string.
|
|
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
|
+
|
|
1468
|
+
## FormCurrencyValidationError
|
|
1469
|
+
|
|
1470
|
+
Map of rule name to error message
|
|
1471
|
+
|
|
1472
|
+
### Fields
|
|
1473
|
+
|
|
1474
|
+
_No fields._
|
|
876
1475
|
|
|
877
|
-
|
|
1476
|
+
Additional properties: string.
|
|
1477
|
+
|
|
1478
|
+
## FormCurrencyValue
|
|
878
1479
|
|
|
879
1480
|
### Fields
|
|
880
1481
|
|
|
881
1482
|
| Name | Required | Type | Description |
|
|
882
1483
|
|---|---:|---|---|
|
|
883
|
-
| `
|
|
884
|
-
| `
|
|
1484
|
+
| `type` | yes | string | Currency code paired with the amount, e.g. USD or EUR |
|
|
1485
|
+
| `value` | yes | string \| number | Currency amount value |
|
|
885
1486
|
|
|
886
1487
|
No additional properties.
|
|
887
1488
|
|
|
888
|
-
##
|
|
1489
|
+
## FormDateRangeValidationError
|
|
889
1490
|
|
|
890
1491
|
Map of rule name to error message
|
|
891
1492
|
|
|
@@ -895,7 +1496,7 @@ _No fields._
|
|
|
895
1496
|
|
|
896
1497
|
Additional properties: string.
|
|
897
1498
|
|
|
898
|
-
##
|
|
1499
|
+
## FormDateValidationError
|
|
899
1500
|
|
|
900
1501
|
Map of rule name to error message
|
|
901
1502
|
|
|
@@ -905,27 +1506,38 @@ _No fields._
|
|
|
905
1506
|
|
|
906
1507
|
Additional properties: string.
|
|
907
1508
|
|
|
908
|
-
##
|
|
1509
|
+
## FormDaySelectorRenderProp
|
|
909
1510
|
|
|
910
|
-
|
|
1511
|
+
Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string)
|
|
911
1512
|
|
|
912
1513
|
### Fields
|
|
913
1514
|
|
|
914
1515
|
_No fields._
|
|
915
1516
|
|
|
916
|
-
Additional properties:
|
|
1517
|
+
Additional properties: [FormDaySelectorRenderPropValue](./types.md#formdayselectorrenderpropvalue).
|
|
917
1518
|
|
|
918
|
-
##
|
|
1519
|
+
## FormDaySelectorRenderPropValue
|
|
919
1520
|
|
|
920
|
-
|
|
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
|
|
921
1531
|
|
|
922
1532
|
### Fields
|
|
923
1533
|
|
|
924
|
-
|
|
1534
|
+
| Name | Required | Type | Description |
|
|
1535
|
+
|---|---:|---|---|
|
|
1536
|
+
| `content` | yes | string | |
|
|
925
1537
|
|
|
926
|
-
|
|
1538
|
+
No additional properties.
|
|
927
1539
|
|
|
928
|
-
##
|
|
1540
|
+
## FormDaySelectorValidationError
|
|
929
1541
|
|
|
930
1542
|
Map of rule name to error message
|
|
931
1543
|
|
|
@@ -935,15 +1547,19 @@ _No fields._
|
|
|
935
1547
|
|
|
936
1548
|
Additional properties: string.
|
|
937
1549
|
|
|
938
|
-
##
|
|
1550
|
+
## FormEmailStringPadding
|
|
939
1551
|
|
|
940
|
-
|
|
1552
|
+
Pads input value with character until reaching maxLength
|
|
941
1553
|
|
|
942
1554
|
### Fields
|
|
943
1555
|
|
|
944
|
-
|
|
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 |
|
|
945
1561
|
|
|
946
|
-
|
|
1562
|
+
No additional properties.
|
|
947
1563
|
|
|
948
1564
|
## FormEmailValidationError
|
|
949
1565
|
|
|
@@ -955,6 +1571,16 @@ _No fields._
|
|
|
955
1571
|
|
|
956
1572
|
Additional properties: string.
|
|
957
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
|
+
|
|
958
1584
|
## FormFileCropperConfig
|
|
959
1585
|
|
|
960
1586
|
Cropper configuration
|
|
@@ -963,7 +1589,7 @@ Cropper configuration
|
|
|
963
1589
|
|
|
964
1590
|
| Name | Required | Type | Description |
|
|
965
1591
|
|---|---:|---|---|
|
|
966
|
-
| `aspectRatio` | no | [
|
|
1592
|
+
| `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
967
1593
|
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
968
1594
|
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
969
1595
|
| `title` | no | string | Title for the cropper modal |
|
|
@@ -979,14 +1605,26 @@ No additional properties.
|
|
|
979
1605
|
| `name` | no | string | File name |
|
|
980
1606
|
| `content` | no | string | File content as a base64 data URL |
|
|
981
1607
|
| `hasError` | no | boolean | Whether the file has an error |
|
|
1608
|
+
| `isMultipart` | no | boolean | Whether this is a multipart upload |
|
|
982
1609
|
| `previewUrl` | no | string | Preview URL for the file |
|
|
983
1610
|
| `progress` | no | number | Upload progress 0-100 |
|
|
1611
|
+
| `size` | no | number | File size in bytes |
|
|
984
1612
|
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
985
1613
|
| `type` | no | string | MIME type of the file |
|
|
986
1614
|
| `url` | no | string | URL of the uploaded file |
|
|
987
1615
|
|
|
988
1616
|
No additional properties.
|
|
989
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
|
+
|
|
990
1628
|
## FormFileDropCropperConfig
|
|
991
1629
|
|
|
992
1630
|
Cropper configuration
|
|
@@ -995,7 +1633,7 @@ Cropper configuration
|
|
|
995
1633
|
|
|
996
1634
|
| Name | Required | Type | Description |
|
|
997
1635
|
|---|---:|---|---|
|
|
998
|
-
| `aspectRatio` | no | [
|
|
1636
|
+
| `aspectRatio` | no | [FileCropperConfigAspectRatio](./definitions.md#filecropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
999
1637
|
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
1000
1638
|
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
1001
1639
|
| `title` | no | string | Title for the cropper modal |
|
|
@@ -1035,14 +1673,14 @@ Additional properties: string.
|
|
|
1035
1673
|
|
|
1036
1674
|
| Name | Required | Type | Description |
|
|
1037
1675
|
|---|---:|---|---|
|
|
1038
|
-
| `name` | no | string |
|
|
1039
|
-
| `content` | no | string |
|
|
1040
|
-
| `hasError` | no | boolean |
|
|
1041
|
-
| `previewUrl` | no | string |
|
|
1042
|
-
| `progress` | no | number |
|
|
1043
|
-
| `tooltipText` | no | string |
|
|
1044
|
-
| `type` | no | string |
|
|
1045
|
-
| `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 |
|
|
1046
1684
|
|
|
1047
1685
|
No additional properties.
|
|
1048
1686
|
|
|
@@ -1062,14 +1700,28 @@ Additional properties: string.
|
|
|
1062
1700
|
|
|
1063
1701
|
| Name | Required | Type | Description |
|
|
1064
1702
|
|---|---:|---|---|
|
|
1065
|
-
| `name` | no | string |
|
|
1066
|
-
| `content` | no | string |
|
|
1067
|
-
| `hasError` | no | boolean |
|
|
1068
|
-
| `
|
|
1069
|
-
| `
|
|
1070
|
-
| `
|
|
1071
|
-
| `
|
|
1072
|
-
| `
|
|
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 |
|
|
1073
1725
|
|
|
1074
1726
|
No additional properties.
|
|
1075
1727
|
|
|
@@ -1138,6 +1790,20 @@ _No fields._
|
|
|
1138
1790
|
|
|
1139
1791
|
Additional properties: string.
|
|
1140
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
|
+
|
|
1141
1807
|
## FormNumberValidationError
|
|
1142
1808
|
|
|
1143
1809
|
Map of rule name to error message
|
|
@@ -1148,6 +1814,20 @@ _No fields._
|
|
|
1148
1814
|
|
|
1149
1815
|
Additional properties: string.
|
|
1150
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
|
+
|
|
1151
1831
|
## FormPasswordValidationError
|
|
1152
1832
|
|
|
1153
1833
|
Map of rule name to error message
|
|
@@ -1168,6 +1848,79 @@ _No fields._
|
|
|
1168
1848
|
|
|
1169
1849
|
Additional properties: string.
|
|
1170
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
|
+
|
|
1171
1924
|
## FormPhoneValidationError
|
|
1172
1925
|
|
|
1173
1926
|
Map of rule name to error message
|
|
@@ -1178,7 +1931,7 @@ _No fields._
|
|
|
1178
1931
|
|
|
1179
1932
|
Additional properties: string.
|
|
1180
1933
|
|
|
1181
|
-
##
|
|
1934
|
+
## FormRadioList
|
|
1182
1935
|
|
|
1183
1936
|
### Fields
|
|
1184
1937
|
|
|
@@ -1215,7 +1968,7 @@ _No fields._
|
|
|
1215
1968
|
|
|
1216
1969
|
Additional properties: string.
|
|
1217
1970
|
|
|
1218
|
-
##
|
|
1971
|
+
## FormSegmentedControlList
|
|
1219
1972
|
|
|
1220
1973
|
### Fields
|
|
1221
1974
|
|
|
@@ -1231,6 +1984,19 @@ Additional properties: string.
|
|
|
1231
1984
|
|
|
1232
1985
|
No additional properties.
|
|
1233
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
|
+
|
|
1234
2000
|
## FormSegmentedControlTip
|
|
1235
2001
|
|
|
1236
2002
|
Tooltip to show on hover for this option
|
|
@@ -1284,7 +2050,29 @@ Avatar configuration for the option
|
|
|
1284
2050
|
|
|
1285
2051
|
No additional properties.
|
|
1286
2052
|
|
|
1287
|
-
##
|
|
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
|
|
1288
2076
|
|
|
1289
2077
|
### Fields
|
|
1290
2078
|
|
|
@@ -1373,9 +2161,10 @@ Additional properties: string.
|
|
|
1373
2161
|
|
|
1374
2162
|
| Name | Required | Type | Description |
|
|
1375
2163
|
|---|---:|---|---|
|
|
2164
|
+
| `icon` | no | string | Pebble icon name displayed for the option |
|
|
1376
2165
|
| `isDisabled` | no | boolean | Disable this specific option |
|
|
1377
2166
|
| `label` | no | string \| number | Display label for the option |
|
|
1378
|
-
| `selectionColor` | no | [
|
|
2167
|
+
| `selectionColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Override selected surface color token for this option |
|
|
1379
2168
|
| `value` | yes | string \| number | Value when selected |
|
|
1380
2169
|
|
|
1381
2170
|
No additional properties.
|
|
@@ -1403,6 +2192,30 @@ _No fields._
|
|
|
1403
2192
|
|
|
1404
2193
|
Additional properties: string.
|
|
1405
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
|
+
|
|
1406
2219
|
## FormSwitchValidationError
|
|
1407
2220
|
|
|
1408
2221
|
Map of rule name to error message
|
|
@@ -1423,16 +2236,27 @@ _No fields._
|
|
|
1423
2236
|
|
|
1424
2237
|
Additional properties: string.
|
|
1425
2238
|
|
|
1426
|
-
##
|
|
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
|
|
1427
2250
|
|
|
1428
2251
|
### Fields
|
|
1429
2252
|
|
|
1430
2253
|
| Name | Required | Type | Description |
|
|
1431
2254
|
|---|---:|---|---|
|
|
1432
|
-
| `
|
|
1433
|
-
| `
|
|
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 |
|
|
1434
2258
|
|
|
1435
|
-
|
|
2259
|
+
Additional properties: unknown.
|
|
1436
2260
|
|
|
1437
2261
|
## FormTextAutoSuggestValidationError
|
|
1438
2262
|
|
|
@@ -1444,6 +2268,20 @@ _No fields._
|
|
|
1444
2268
|
|
|
1445
2269
|
Additional properties: string.
|
|
1446
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
|
+
|
|
1447
2285
|
## FormTextValidationError
|
|
1448
2286
|
|
|
1449
2287
|
Map of rule name to error message
|
|
@@ -1454,6 +2292,28 @@ _No fields._
|
|
|
1454
2292
|
|
|
1455
2293
|
Additional properties: string.
|
|
1456
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
|
+
|
|
1457
2317
|
## FormTimeValidationError
|
|
1458
2318
|
|
|
1459
2319
|
Map of rule name to error message
|
|
@@ -1505,6 +2365,7 @@ Additional properties: unknown.
|
|
|
1505
2365
|
|---|---:|---|---|
|
|
1506
2366
|
| `disabledInfo` | no | string \| [FormTreeDisabledInfo](./types.md#formtreedisabledinfo) | Tooltip shown when item is disabled |
|
|
1507
2367
|
| `isDisabled` | no | boolean | Disable this item |
|
|
2368
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
1508
2369
|
| `label` | yes | string | Display label for the item |
|
|
1509
2370
|
| `parent` | no | string | Parent item value, null for root items |
|
|
1510
2371
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -1530,6 +2391,7 @@ Additional properties: unknown.
|
|
|
1530
2391
|
| Name | Required | Type | Description |
|
|
1531
2392
|
|---|---:|---|---|
|
|
1532
2393
|
| `isDisabled` | no | boolean | Disable this item |
|
|
2394
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
1533
2395
|
| `label` | yes | string | Display label for the item |
|
|
1534
2396
|
| `parent` | no | string | Parent item value, null for root items |
|
|
1535
2397
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -1588,6 +2450,30 @@ _No fields._
|
|
|
1588
2450
|
|
|
1589
2451
|
Additional properties: unknown.
|
|
1590
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
|
+
|
|
1591
2477
|
## FormWorkEmailValidationError
|
|
1592
2478
|
|
|
1593
2479
|
Map of rule name to error message
|
|
@@ -1654,7 +2540,7 @@ Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens
|
|
|
1654
2540
|
| `leftIcon` | no | string \| [GridLeftIcon](./types.md#gridlefticon) | Icon displayed on the left side of the label |
|
|
1655
2541
|
| `maxWidth` | no | string | Maximum width CSS value for truncation |
|
|
1656
2542
|
| `rightIcon` | no | string \| [GridRightIcon](./types.md#gridrighticon) | Icon displayed on the right side of the label |
|
|
1657
|
-
| `size` | no | [
|
|
2543
|
+
| `size` | no | [ChipSize](./definitions.md#chipsize) | Size of the label. Default: LARGE |
|
|
1658
2544
|
| `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
|
|
1659
2545
|
| `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
|
|
1660
2546
|
|
|
@@ -1743,8 +2629,12 @@ No additional properties.
|
|
|
1743
2629
|
|
|
1744
2630
|
| Name | Required | Type | Description |
|
|
1745
2631
|
|---|---:|---|---|
|
|
2632
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
|
|
1746
2633
|
| `content` | yes | string | Tooltip content text |
|
|
1747
|
-
| `
|
|
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 |
|
|
1748
2638
|
|
|
1749
2639
|
No additional properties.
|
|
1750
2640
|
|
|
@@ -1886,6 +2776,24 @@ No additional properties.
|
|
|
1886
2776
|
|
|
1887
2777
|
No additional properties.
|
|
1888
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
|
+
|
|
1889
2797
|
## LayoutBorder
|
|
1890
2798
|
|
|
1891
2799
|
Structured border using strict token parts
|
|
@@ -1971,6 +2879,33 @@ No additional properties.
|
|
|
1971
2879
|
|
|
1972
2880
|
No additional properties.
|
|
1973
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 |
|
|
2906
|
+
|
|
2907
|
+
No additional properties.
|
|
2908
|
+
|
|
1974
2909
|
## Location
|
|
1975
2910
|
|
|
1976
2911
|
Location object with nickname and address. Required for displaying location information
|
|
@@ -2043,7 +2978,7 @@ No additional properties.
|
|
|
2043
2978
|
| `secondaryLabel` | no | string | Secondary text shown below the label |
|
|
2044
2979
|
| `tag` | no | string | Tag label shown beside the item text |
|
|
2045
2980
|
| `tertiaryLabel` | no | string | Tertiary text shown below secondary label |
|
|
2046
|
-
| `type` | no | [
|
|
2981
|
+
| `type` | no | [DropdownFooterType](./definitions.md#dropdownfootertype) | Visual style type for the item (WARNING or ALERT) |
|
|
2047
2982
|
| `value` | yes | string | Unique value for the item |
|
|
2048
2983
|
|
|
2049
2984
|
No additional properties.
|
|
@@ -2058,6 +2993,20 @@ _No fields._
|
|
|
2058
2993
|
|
|
2059
2994
|
Additional properties: unknown.
|
|
2060
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
|
+
|
|
2061
3010
|
## NumberArg
|
|
2062
3011
|
|
|
2063
3012
|
### Fields
|
|
@@ -2088,7 +3037,7 @@ Adds padding characters to the input value
|
|
|
2088
3037
|
|---|---:|---|---|
|
|
2089
3038
|
| `character` | yes | string | Character to use for padding |
|
|
2090
3039
|
| `maxLength` | yes | number | Target length after padding |
|
|
2091
|
-
| `position` | yes | [
|
|
3040
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Position to pad (start or end) |
|
|
2092
3041
|
|
|
2093
3042
|
No additional properties.
|
|
2094
3043
|
|
|
@@ -2102,7 +3051,7 @@ Avatar configuration for the header
|
|
|
2102
3051
|
|---|---:|---|---|
|
|
2103
3052
|
| `icon` | no | string | Icon type string when type is ICON |
|
|
2104
3053
|
| `image` | no | string | Image URL for the avatar |
|
|
2105
|
-
| `imageBackground` | no | [
|
|
3054
|
+
| `imageBackground` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color token for avatar image background |
|
|
2106
3055
|
| `isRound` | no | boolean | If false, square avatar is shown. Default: true |
|
|
2107
3056
|
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
|
|
2108
3057
|
|
|
@@ -2118,12 +3067,54 @@ Avatar configuration for the header
|
|
|
2118
3067
|
|---|---:|---|---|
|
|
2119
3068
|
| `icon` | no | string | Icon type string when type is ICON |
|
|
2120
3069
|
| `image` | no | string | Image URL for the avatar |
|
|
2121
|
-
| `imageBackground` | no | [
|
|
3070
|
+
| `imageBackground` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color token for avatar image background |
|
|
2122
3071
|
| `isRound` | no | boolean | If false, square avatar is shown. Default: true |
|
|
2123
3072
|
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
|
|
2124
3073
|
|
|
2125
3074
|
No additional properties.
|
|
2126
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
|
+
|
|
2127
3118
|
## ObjectUIStatsAction
|
|
2128
3119
|
|
|
2129
3120
|
### Fields
|
|
@@ -2180,7 +3171,7 @@ Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens
|
|
|
2180
3171
|
| `leftIcon` | no | string \| [ObjectUIStatsLeftIcon](./types.md#objectuistatslefticon) | Icon displayed on the left side of the label |
|
|
2181
3172
|
| `maxWidth` | no | string | Maximum width CSS value for truncation |
|
|
2182
3173
|
| `rightIcon` | no | string \| [ObjectUIStatsRightIcon](./types.md#objectuistatsrighticon) | Icon displayed on the right side of the label |
|
|
2183
|
-
| `size` | no | [
|
|
3174
|
+
| `size` | no | [ChipSize](./definitions.md#chipsize) | Size of the label. Default: LARGE |
|
|
2184
3175
|
| `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
|
|
2185
3176
|
| `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
|
|
2186
3177
|
|
|
@@ -2221,7 +3212,7 @@ No additional properties.
|
|
|
2221
3212
|
|
|
2222
3213
|
| Name | Required | Type | Description |
|
|
2223
3214
|
|---|---:|---|---|
|
|
2224
|
-
| `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 |
|
|
2225
3216
|
| `appearance` | no | [AppNavBarActionAppearance](./definitions.md#appnavbaractionappearance) | Button visual style. Default: PRIMARY |
|
|
2226
3217
|
| `icon` | no | string | Icon name from Icon.TYPES (e.g. ADD, EDIT_OUTLINE) |
|
|
2227
3218
|
| `id` | yes | string | Unique identifier for the action. Written to actionClickedId state on click |
|
|
@@ -2283,7 +3274,7 @@ Pads input value with character until reaching maxLength
|
|
|
2283
3274
|
|---|---:|---|---|
|
|
2284
3275
|
| `character` | yes | string | Character to use for padding |
|
|
2285
3276
|
| `maxLength` | yes | number | Target length after padding |
|
|
2286
|
-
| `position` | yes | [
|
|
3277
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
2287
3278
|
|
|
2288
3279
|
No additional properties.
|
|
2289
3280
|
|
|
@@ -2327,6 +3318,65 @@ Additional properties: unknown.
|
|
|
2327
3318
|
|
|
2328
3319
|
No additional properties.
|
|
2329
3320
|
|
|
3321
|
+
## PhoneCountryCode
|
|
3322
|
+
|
|
3323
|
+
Country-code dropdown configuration preserving the serializable CountryCodeProp shape
|
|
3324
|
+
|
|
3325
|
+
### Fields
|
|
3326
|
+
|
|
3327
|
+
| Name | Required | Type | Description |
|
|
3328
|
+
|---|---:|---|---|
|
|
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 |
|
|
3367
|
+
|
|
3368
|
+
No additional properties.
|
|
3369
|
+
|
|
3370
|
+
## PhoneFuseOption
|
|
3371
|
+
|
|
3372
|
+
Fuse.js search options for the country-code dropdown
|
|
3373
|
+
|
|
3374
|
+
### Fields
|
|
3375
|
+
|
|
3376
|
+
_No fields._
|
|
3377
|
+
|
|
3378
|
+
Additional properties: unknown.
|
|
3379
|
+
|
|
2330
3380
|
## PhoneStringPadding
|
|
2331
3381
|
|
|
2332
3382
|
Pads input value with character until reaching maxLength
|
|
@@ -2337,7 +3387,20 @@ Pads input value with character until reaching maxLength
|
|
|
2337
3387
|
|---|---:|---|---|
|
|
2338
3388
|
| `character` | yes | string | Character to use for padding |
|
|
2339
3389
|
| `maxLength` | yes | number | Target length after padding |
|
|
2340
|
-
| `position` | yes | [
|
|
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
|
|
3397
|
+
|
|
3398
|
+
### Fields
|
|
3399
|
+
|
|
3400
|
+
| Name | Required | Type | Description |
|
|
3401
|
+
|---|---:|---|---|
|
|
3402
|
+
| `placement` | no | [FormTreeSelectPlacement](./definitions.md#formtreeselectplacement) | Popover placement |
|
|
3403
|
+
| `shouldFlipIfNoSpace` | no | boolean | Whether the popover flips when there is not enough space |
|
|
2341
3404
|
|
|
2342
3405
|
No additional properties.
|
|
2343
3406
|
|
|
@@ -2385,7 +3448,7 @@ Additional properties: unknown.
|
|
|
2385
3448
|
|
|
2386
3449
|
No additional properties.
|
|
2387
3450
|
|
|
2388
|
-
##
|
|
3451
|
+
## RadioList
|
|
2389
3452
|
|
|
2390
3453
|
### Fields
|
|
2391
3454
|
|
|
@@ -2442,27 +3505,6 @@ _No fields._
|
|
|
2442
3505
|
|
|
2443
3506
|
Additional properties: string.
|
|
2444
3507
|
|
|
2445
|
-
## RenderProp
|
|
2446
|
-
|
|
2447
|
-
Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string)
|
|
2448
|
-
|
|
2449
|
-
### Fields
|
|
2450
|
-
|
|
2451
|
-
_No fields._
|
|
2452
|
-
|
|
2453
|
-
Additional properties: [RenderPropValue](./types.md#renderpropvalue).
|
|
2454
|
-
|
|
2455
|
-
## RenderPropValue
|
|
2456
|
-
|
|
2457
|
-
### Fields
|
|
2458
|
-
|
|
2459
|
-
| Name | Required | Type | Description |
|
|
2460
|
-
|---|---:|---|---|
|
|
2461
|
-
| `isDisabled` | no | boolean | |
|
|
2462
|
-
| `tip` | no | [DaySelectorTip](./types.md#dayselectortip) | |
|
|
2463
|
-
|
|
2464
|
-
No additional properties.
|
|
2465
|
-
|
|
2466
3508
|
## Role
|
|
2467
3509
|
|
|
2468
3510
|
### Fields
|
|
@@ -2518,6 +3560,22 @@ Additional properties: unknown.
|
|
|
2518
3560
|
|
|
2519
3561
|
No additional properties.
|
|
2520
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
|
+
|
|
2521
3579
|
## SegmentedControlOption
|
|
2522
3580
|
|
|
2523
3581
|
### Fields
|
|
@@ -2632,6 +3690,23 @@ No additional properties.
|
|
|
2632
3690
|
|
|
2633
3691
|
No additional properties.
|
|
2634
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
|
+
|
|
2635
3710
|
## SelectEmptyListPlaceholder
|
|
2636
3711
|
|
|
2637
3712
|
### Fields
|
|
@@ -2667,6 +3742,29 @@ _No fields._
|
|
|
2667
3742
|
|
|
2668
3743
|
Additional properties: unknown.
|
|
2669
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
|
+
|
|
2670
3768
|
## SelectOption
|
|
2671
3769
|
|
|
2672
3770
|
### Fields
|
|
@@ -2766,6 +3864,18 @@ Horizontal size constraints for desktop layout. Object with optional default/min
|
|
|
2766
3864
|
|
|
2767
3865
|
No additional properties.
|
|
2768
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
|
+
|
|
2769
3879
|
## Slide
|
|
2770
3880
|
|
|
2771
3881
|
### Fields
|
|
@@ -2904,6 +4014,7 @@ Configuration for the form submit button
|
|
|
2904
4014
|
|
|
2905
4015
|
| Name | Required | Type | Description |
|
|
2906
4016
|
|---|---:|---|---|
|
|
4017
|
+
| `icon` | no | string \| [FormIcon](./types.md#formicon) | Icon to show in the submit button |
|
|
2907
4018
|
| `isDisabled` | no | boolean | Disable submit button |
|
|
2908
4019
|
| `isFluid` | no | boolean | Stretch submit button to fill width |
|
|
2909
4020
|
| `isLoading` | no | boolean | Show loading spinner on submit button. Bind to state for manual control. |
|
|
@@ -2923,6 +4034,18 @@ No additional properties.
|
|
|
2923
4034
|
|
|
2924
4035
|
No additional properties.
|
|
2925
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
|
+
|
|
2926
4049
|
## SurveyArg
|
|
2927
4050
|
|
|
2928
4051
|
### Fields
|
|
@@ -2949,9 +4072,10 @@ No additional properties.
|
|
|
2949
4072
|
|
|
2950
4073
|
| Name | Required | Type | Description |
|
|
2951
4074
|
|---|---:|---|---|
|
|
4075
|
+
| `icon` | no | string | Pebble icon name displayed for the option |
|
|
2952
4076
|
| `isDisabled` | no | boolean | Disable this specific option |
|
|
2953
4077
|
| `label` | no | string \| number | Display label for the option |
|
|
2954
|
-
| `selectionColor` | no | [
|
|
4078
|
+
| `selectionColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Override selected surface color token for this option |
|
|
2955
4079
|
| `value` | yes | string \| number | Value when selected |
|
|
2956
4080
|
|
|
2957
4081
|
No additional properties.
|
|
@@ -2989,6 +4113,17 @@ Additional properties: unknown.
|
|
|
2989
4113
|
|
|
2990
4114
|
No additional properties.
|
|
2991
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
|
+
|
|
2992
4127
|
## TabBadge
|
|
2993
4128
|
|
|
2994
4129
|
Badge to display on the tab
|
|
@@ -3009,11 +4144,24 @@ No additional properties.
|
|
|
3009
4144
|
| Name | Required | Type | Description |
|
|
3010
4145
|
|---|---:|---|---|
|
|
3011
4146
|
| `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the tab |
|
|
3012
|
-
| `
|
|
4147
|
+
| `href` | no | string | Semantic href for LINK tabs; navigation is prevented by Pebble Tabs |
|
|
3013
4148
|
| `icon` | no | string | Icon name for the tab (e.g., FOLDER_OUTLINE) |
|
|
3014
|
-
| `
|
|
4149
|
+
| `isDisabled` | no | boolean | Whether this tab is disabled |
|
|
3015
4150
|
| `tip` | no | string \| [TabTip](./types.md#tabtip) | Tooltip to show on hover |
|
|
3016
|
-
| `
|
|
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 |
|
|
3017
4165
|
|
|
3018
4166
|
No additional properties.
|
|
3019
4167
|
|
|
@@ -3068,28 +4216,38 @@ Additional properties: unknown.
|
|
|
3068
4216
|
|
|
3069
4217
|
No additional properties.
|
|
3070
4218
|
|
|
3071
|
-
##
|
|
4219
|
+
## TextAutoSuggestFuseOption
|
|
3072
4220
|
|
|
3073
|
-
|
|
4221
|
+
Fuse.js search options for customizing suggestion filtering
|
|
4222
|
+
|
|
4223
|
+
### Fields
|
|
4224
|
+
|
|
4225
|
+
_No fields._
|
|
4226
|
+
|
|
4227
|
+
Additional properties: unknown.
|
|
4228
|
+
|
|
4229
|
+
## TextAutoSuggestList
|
|
3074
4230
|
|
|
3075
4231
|
### Fields
|
|
3076
4232
|
|
|
3077
4233
|
| Name | Required | Type | Description |
|
|
3078
4234
|
|---|---:|---|---|
|
|
3079
|
-
| `
|
|
3080
|
-
| `
|
|
3081
|
-
| `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 |
|
|
3082
4237
|
|
|
3083
4238
|
No additional properties.
|
|
3084
4239
|
|
|
3085
|
-
##
|
|
4240
|
+
## TextAutoSuggestStringPadding
|
|
4241
|
+
|
|
4242
|
+
Pads input value with character until reaching maxLength
|
|
3086
4243
|
|
|
3087
4244
|
### Fields
|
|
3088
4245
|
|
|
3089
4246
|
| Name | Required | Type | Description |
|
|
3090
4247
|
|---|---:|---|---|
|
|
3091
|
-
| `
|
|
3092
|
-
| `
|
|
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 |
|
|
3093
4251
|
|
|
3094
4252
|
No additional properties.
|
|
3095
4253
|
|
|
@@ -3123,7 +4281,7 @@ Pads input value with character until reaching maxLength
|
|
|
3123
4281
|
|---|---:|---|---|
|
|
3124
4282
|
| `character` | yes | string | Character to use for padding |
|
|
3125
4283
|
| `maxLength` | yes | number | Target length after padding |
|
|
3126
|
-
| `position` | yes | [
|
|
4284
|
+
| `position` | yes | [EmailStringPaddingPosition](./definitions.md#emailstringpaddingposition) | Where to add padding: start or end |
|
|
3127
4285
|
|
|
3128
4286
|
No additional properties.
|
|
3129
4287
|
|
|
@@ -3179,6 +4337,38 @@ Additional properties: unknown.
|
|
|
3179
4337
|
|
|
3180
4338
|
No additional properties.
|
|
3181
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
|
+
|
|
3182
4372
|
## TimezoneArg
|
|
3183
4373
|
|
|
3184
4374
|
### Fields
|
|
@@ -3199,17 +4389,14 @@ Additional properties: unknown.
|
|
|
3199
4389
|
|
|
3200
4390
|
No additional properties.
|
|
3201
4391
|
|
|
3202
|
-
##
|
|
3203
|
-
|
|
3204
|
-
Toggle icon configuration
|
|
4392
|
+
## Title
|
|
3205
4393
|
|
|
3206
4394
|
### Fields
|
|
3207
4395
|
|
|
3208
4396
|
| Name | Required | Type | Description |
|
|
3209
4397
|
|---|---:|---|---|
|
|
3210
|
-
| `
|
|
3211
|
-
| `
|
|
3212
|
-
| `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 |
|
|
3213
4400
|
|
|
3214
4401
|
No additional properties.
|
|
3215
4402
|
|
|
@@ -3276,6 +4463,7 @@ Additional properties: unknown.
|
|
|
3276
4463
|
|---|---:|---|---|
|
|
3277
4464
|
| `disabledInfo` | no | string \| [TreeDisabledInfo](./types.md#treedisabledinfo) | Tooltip shown when item is disabled |
|
|
3278
4465
|
| `isDisabled` | no | boolean | Disable this item |
|
|
4466
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
3279
4467
|
| `label` | yes | string | Display label for the item |
|
|
3280
4468
|
| `parent` | no | string | Parent item value, null for root items |
|
|
3281
4469
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -3321,6 +4509,7 @@ Additional properties: unknown.
|
|
|
3321
4509
|
| Name | Required | Type | Description |
|
|
3322
4510
|
|---|---:|---|---|
|
|
3323
4511
|
| `isDisabled` | no | boolean | Disable this item |
|
|
4512
|
+
| `isLeaf` | no | boolean | Marks the item as a leaf node |
|
|
3324
4513
|
| `label` | yes | string | Display label for the item |
|
|
3325
4514
|
| `parent` | no | string | Parent item value, null for root items |
|
|
3326
4515
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
@@ -3410,3 +4599,27 @@ Additional properties: unknown.
|
|
|
3410
4599
|
| `type` | yes | string | |
|
|
3411
4600
|
|
|
3412
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.
|