@rippling/pebble-sdui-web 0.4.2 → 0.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/catalogs/custom-apps/action-params.d.ts +0 -5
- package/dist/catalogs/custom-apps/catalog.d.ts +1 -1
- package/dist/catalogs/custom-apps/component-props.d.ts +605 -176
- package/dist/catalogs/custom-apps/index.cjs +3 -3
- package/dist/catalogs/custom-apps/index.cjs.map +1 -1
- package/dist/catalogs/custom-apps/index.d.ts +1 -1
- package/dist/catalogs/custom-apps/index.js +212 -185
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/actions.md +15 -21
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +880 -878
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +655 -149
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +2 -2
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +1055 -104
- package/package.json +1 -1
|
@@ -3,6 +3,28 @@
|
|
|
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
|
+
## ActionCardPrimaryActionTo
|
|
7
|
+
|
|
8
|
+
### Fields
|
|
9
|
+
|
|
10
|
+
| Name | Required | Type | Description |
|
|
11
|
+
|---|---:|---|---|
|
|
12
|
+
| `openInNewTab` | no | boolean | |
|
|
13
|
+
| `path` | yes | string | |
|
|
14
|
+
|
|
15
|
+
No additional properties.
|
|
16
|
+
|
|
17
|
+
## ActionCardSecondaryActionTo
|
|
18
|
+
|
|
19
|
+
### Fields
|
|
20
|
+
|
|
21
|
+
| Name | Required | Type | Description |
|
|
22
|
+
|---|---:|---|---|
|
|
23
|
+
| `openInNewTab` | no | boolean | |
|
|
24
|
+
| `path` | yes | string | |
|
|
25
|
+
|
|
26
|
+
No additional properties.
|
|
27
|
+
|
|
6
28
|
## Addres
|
|
7
29
|
|
|
8
30
|
Address object with street, city, state, country, and zip
|
|
@@ -23,6 +45,28 @@ Address object with street, city, state, country, and zip
|
|
|
23
45
|
|
|
24
46
|
No additional properties.
|
|
25
47
|
|
|
48
|
+
## AlertPrimaryActionTo
|
|
49
|
+
|
|
50
|
+
### Fields
|
|
51
|
+
|
|
52
|
+
| Name | Required | Type | Description |
|
|
53
|
+
|---|---:|---|---|
|
|
54
|
+
| `openInNewTab` | no | boolean | |
|
|
55
|
+
| `path` | yes | string | |
|
|
56
|
+
|
|
57
|
+
No additional properties.
|
|
58
|
+
|
|
59
|
+
## AlertSecondaryActionTo
|
|
60
|
+
|
|
61
|
+
### Fields
|
|
62
|
+
|
|
63
|
+
| Name | Required | Type | Description |
|
|
64
|
+
|---|---:|---|---|
|
|
65
|
+
| `openInNewTab` | no | boolean | |
|
|
66
|
+
| `path` | yes | string | |
|
|
67
|
+
|
|
68
|
+
No additional properties.
|
|
69
|
+
|
|
26
70
|
## AnimationData
|
|
27
71
|
|
|
28
72
|
Lottie animation JSON object. Required if path not provided
|
|
@@ -41,6 +85,19 @@ _No fields._
|
|
|
41
85
|
|
|
42
86
|
Additional properties: unknown.
|
|
43
87
|
|
|
88
|
+
## AppGroupSelectAvatarProp
|
|
89
|
+
|
|
90
|
+
Avatar configuration for the option
|
|
91
|
+
|
|
92
|
+
### Fields
|
|
93
|
+
|
|
94
|
+
| Name | Required | Type | Description |
|
|
95
|
+
|---|---:|---|---|
|
|
96
|
+
| `image` | no | string | URL of avatar image |
|
|
97
|
+
| `title` | no | string | Title/alt text for avatar |
|
|
98
|
+
|
|
99
|
+
No additional properties.
|
|
100
|
+
|
|
44
101
|
## AppGroupSelectCheck
|
|
45
102
|
|
|
46
103
|
### Fields
|
|
@@ -53,6 +110,18 @@ Additional properties: unknown.
|
|
|
53
110
|
|
|
54
111
|
No additional properties.
|
|
55
112
|
|
|
113
|
+
## AppGroupSelectEmptyListPlaceholder
|
|
114
|
+
|
|
115
|
+
### Fields
|
|
116
|
+
|
|
117
|
+
| Name | Required | Type | Description |
|
|
118
|
+
|---|---:|---|---|
|
|
119
|
+
| `onLoading` | no | string | Placeholder shown while list is loading |
|
|
120
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query entered |
|
|
121
|
+
| `onNoSearchResults` | no | string | Placeholder when search returns no results |
|
|
122
|
+
|
|
123
|
+
No additional properties.
|
|
124
|
+
|
|
56
125
|
## AppGroupSelectFooter
|
|
57
126
|
|
|
58
127
|
Fixed footer at bottom of dropdown menu
|
|
@@ -76,6 +145,29 @@ _No fields._
|
|
|
76
145
|
|
|
77
146
|
Additional properties: unknown.
|
|
78
147
|
|
|
148
|
+
## AppGroupSelectOption
|
|
149
|
+
|
|
150
|
+
### Fields
|
|
151
|
+
|
|
152
|
+
| Name | Required | Type | Description |
|
|
153
|
+
|---|---:|---|---|
|
|
154
|
+
| `avatarProps` | no | [AppGroupSelectAvatarProp](./types.md#appgroupselectavatarprop) | Avatar configuration for the option |
|
|
155
|
+
| `description` | no | string | Description text shown below the label |
|
|
156
|
+
| `flag` | no | string | Two-letter country code for flag icon (e.g. "US", "IN") |
|
|
157
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
158
|
+
| `isRecommended` | no | boolean | Marks option as recommended with a badge |
|
|
159
|
+
| `isSeparator` | no | boolean | Renders as a visual separator instead of selectable option |
|
|
160
|
+
| `label` | yes | string | Display text for the option |
|
|
161
|
+
| `labelIcon` | no | string | Icon glyph name to show next to the label |
|
|
162
|
+
| `leftIconType` | no | string | Icon glyph name to show on the left. E.g. "CHECK_CIRCLE_OUTLINE" |
|
|
163
|
+
| `quaternaryLabel` | no | string | Quaternary label shown below tertiary label |
|
|
164
|
+
| `rightLabel` | no | string | Label aligned to the right side of the option |
|
|
165
|
+
| `secondaryLabel` | no | string | Secondary label shown below the main label |
|
|
166
|
+
| `tertiaryLabel` | no | string | Tertiary label shown below secondary label |
|
|
167
|
+
| `value` | yes | unknown | Value stored when option is selected |
|
|
168
|
+
|
|
169
|
+
No additional properties.
|
|
170
|
+
|
|
79
171
|
## AppNavBarAction
|
|
80
172
|
|
|
81
173
|
### Fields
|
|
@@ -104,6 +196,18 @@ Badge shown next to the nav item title
|
|
|
104
196
|
|
|
105
197
|
No additional properties.
|
|
106
198
|
|
|
199
|
+
## AvatarIcon
|
|
200
|
+
|
|
201
|
+
### Fields
|
|
202
|
+
|
|
203
|
+
| Name | Required | Type | Description |
|
|
204
|
+
|---|---:|---|---|
|
|
205
|
+
| `backgroundColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | |
|
|
206
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | |
|
|
207
|
+
| `type` | yes | string | |
|
|
208
|
+
|
|
209
|
+
No additional properties.
|
|
210
|
+
|
|
107
211
|
## AvatarTip
|
|
108
212
|
|
|
109
213
|
Tooltip shown on avatar hover. Object with content string and optional title
|
|
@@ -118,16 +222,14 @@ Tooltip shown on avatar hover. Object with content string and optional title
|
|
|
118
222
|
|
|
119
223
|
No additional properties.
|
|
120
224
|
|
|
121
|
-
##
|
|
122
|
-
|
|
123
|
-
Avatar configuration to display with the step. Supports image URLs
|
|
225
|
+
## AvatarTo
|
|
124
226
|
|
|
125
227
|
### Fields
|
|
126
228
|
|
|
127
229
|
| Name | Required | Type | Description |
|
|
128
230
|
|---|---:|---|---|
|
|
129
|
-
| `
|
|
130
|
-
| `
|
|
231
|
+
| `openInNewTab` | no | boolean | |
|
|
232
|
+
| `path` | yes | string | |
|
|
131
233
|
|
|
132
234
|
No additional properties.
|
|
133
235
|
|
|
@@ -142,11 +244,75 @@ Tooltip configuration to show on hover
|
|
|
142
244
|
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip theme. Default: LIGHT |
|
|
143
245
|
| `content` | yes | string | Tooltip text content |
|
|
144
246
|
| `isDelayed` | no | boolean | Add delay before showing/hiding the tooltip. Default: false |
|
|
145
|
-
| `maxWidth` | no |
|
|
247
|
+
| `maxWidth` | no | number \| string | Max width of tooltip. Number in px or CSS string |
|
|
146
248
|
| `placement` | no | [BadgeTipPlacement](./definitions.md#badgetipplacement) | Tooltip position relative to badge. Default: bottom |
|
|
147
249
|
|
|
148
250
|
No additional properties.
|
|
149
251
|
|
|
252
|
+
## BoxBorder
|
|
253
|
+
|
|
254
|
+
Structured border using strict token parts
|
|
255
|
+
|
|
256
|
+
### Fields
|
|
257
|
+
|
|
258
|
+
| Name | Required | Type | Description |
|
|
259
|
+
|---|---:|---|---|
|
|
260
|
+
| `color` | no | [BoxBorderColor](./definitions.md#boxbordercolor) | Border color token |
|
|
261
|
+
| `style` | no | [BoxBorderStyle](./definitions.md#boxborderstyle) | CSS border style |
|
|
262
|
+
| `width` | no | [BoxBorderWidth](./definitions.md#boxborderwidth) | Border width token |
|
|
263
|
+
|
|
264
|
+
No additional properties.
|
|
265
|
+
|
|
266
|
+
## BoxGap
|
|
267
|
+
|
|
268
|
+
### Fields
|
|
269
|
+
|
|
270
|
+
| Name | Required | Type | Description |
|
|
271
|
+
|---|---:|---|---|
|
|
272
|
+
| `column` | no | [BoxGap](./definitions.md#boxgap) | Column gap spacing token |
|
|
273
|
+
| `row` | no | [BoxGap](./definitions.md#boxgap) | Row gap spacing token |
|
|
274
|
+
|
|
275
|
+
No additional properties.
|
|
276
|
+
|
|
277
|
+
## BoxMargin
|
|
278
|
+
|
|
279
|
+
### Fields
|
|
280
|
+
|
|
281
|
+
| Name | Required | Type | Description |
|
|
282
|
+
|---|---:|---|---|
|
|
283
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
284
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
285
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
286
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
287
|
+
|
|
288
|
+
No additional properties.
|
|
289
|
+
|
|
290
|
+
## BoxPadding
|
|
291
|
+
|
|
292
|
+
### Fields
|
|
293
|
+
|
|
294
|
+
| Name | Required | Type | Description |
|
|
295
|
+
|---|---:|---|---|
|
|
296
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
297
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
298
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
299
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
300
|
+
|
|
301
|
+
No additional properties.
|
|
302
|
+
|
|
303
|
+
## BoxRadiu
|
|
304
|
+
|
|
305
|
+
### Fields
|
|
306
|
+
|
|
307
|
+
| Name | Required | Type | Description |
|
|
308
|
+
|---|---:|---|---|
|
|
309
|
+
| `bottomLeft` | no | [BoxRadius](./definitions.md#boxradius) | Bottom-left corner radius token |
|
|
310
|
+
| `bottomRight` | no | [BoxRadius](./definitions.md#boxradius) | Bottom-right corner radius token |
|
|
311
|
+
| `topLeft` | no | [BoxRadius](./definitions.md#boxradius) | Top-left corner radius token |
|
|
312
|
+
| `topRight` | no | [BoxRadius](./definitions.md#boxradius) | Top-right corner radius token |
|
|
313
|
+
|
|
314
|
+
No additional properties.
|
|
315
|
+
|
|
150
316
|
## BreadcrumbItem
|
|
151
317
|
|
|
152
318
|
### Fields
|
|
@@ -160,6 +326,44 @@ No additional properties.
|
|
|
160
326
|
|
|
161
327
|
No additional properties.
|
|
162
328
|
|
|
329
|
+
## ButtonIcon
|
|
330
|
+
|
|
331
|
+
### Fields
|
|
332
|
+
|
|
333
|
+
| Name | Required | Type | Description |
|
|
334
|
+
|---|---:|---|---|
|
|
335
|
+
| `alignment` | no | [ButtonIconAlignment](./definitions.md#buttoniconalignment) | Icon alignment relative to label. Default: LEFT |
|
|
336
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only supported for OUTLINE, SOLID, GHOST appearances |
|
|
337
|
+
| `type` | yes | string | Icon type name (e.g., "CHECK", "EDIT_OUTLINE") |
|
|
338
|
+
|
|
339
|
+
No additional properties.
|
|
340
|
+
|
|
341
|
+
## ButtonTip
|
|
342
|
+
|
|
343
|
+
### Fields
|
|
344
|
+
|
|
345
|
+
| Name | Required | Type | Description |
|
|
346
|
+
|---|---:|---|---|
|
|
347
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
|
|
348
|
+
| `content` | yes | string | Tooltip content text |
|
|
349
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent |
|
|
350
|
+
| `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
|
|
351
|
+
| `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
|
|
352
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to button. Default: TOP_START |
|
|
353
|
+
|
|
354
|
+
No additional properties.
|
|
355
|
+
|
|
356
|
+
## ButtonTo
|
|
357
|
+
|
|
358
|
+
### Fields
|
|
359
|
+
|
|
360
|
+
| Name | Required | Type | Description |
|
|
361
|
+
|---|---:|---|---|
|
|
362
|
+
| `openInNewTab` | no | boolean | Open link in new tab. Default: false |
|
|
363
|
+
| `path` | yes | string | URL path for navigation |
|
|
364
|
+
|
|
365
|
+
No additional properties.
|
|
366
|
+
|
|
163
367
|
## CardAction
|
|
164
368
|
|
|
165
369
|
### Fields
|
|
@@ -172,6 +376,17 @@ No additional properties.
|
|
|
172
376
|
|
|
173
377
|
No additional properties.
|
|
174
378
|
|
|
379
|
+
## CardTo
|
|
380
|
+
|
|
381
|
+
### Fields
|
|
382
|
+
|
|
383
|
+
| Name | Required | Type | Description |
|
|
384
|
+
|---|---:|---|---|
|
|
385
|
+
| `openInNewTab` | no | boolean | |
|
|
386
|
+
| `path` | yes | string | |
|
|
387
|
+
|
|
388
|
+
No additional properties.
|
|
389
|
+
|
|
175
390
|
## CheckboxArg
|
|
176
391
|
|
|
177
392
|
### Fields
|
|
@@ -221,12 +436,23 @@ No additional properties.
|
|
|
221
436
|
| `isDisabled` | no | boolean | Disables this specific checkbox |
|
|
222
437
|
| `label` | yes | string | Display text for the checkbox option |
|
|
223
438
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
224
|
-
| `tag` | no |
|
|
439
|
+
| `tag` | no | string \| [CheckboxGroupTag](./types.md#checkboxgrouptag) | Optional tag/label displayed with the option |
|
|
225
440
|
| `tip` | no | string | Tooltip text shown on hover |
|
|
226
441
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
227
442
|
|
|
228
443
|
No additional properties.
|
|
229
444
|
|
|
445
|
+
## CheckboxGroupTag
|
|
446
|
+
|
|
447
|
+
### Fields
|
|
448
|
+
|
|
449
|
+
| Name | Required | Type | Description |
|
|
450
|
+
|---|---:|---|---|
|
|
451
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
|
|
452
|
+
| `label` | yes | string | Tag label text |
|
|
453
|
+
|
|
454
|
+
No additional properties.
|
|
455
|
+
|
|
230
456
|
## CheckListList
|
|
231
457
|
|
|
232
458
|
### Fields
|
|
@@ -257,6 +483,30 @@ Per-item input type overrides
|
|
|
257
483
|
|
|
258
484
|
No additional properties.
|
|
259
485
|
|
|
486
|
+
## ChipAvatar
|
|
487
|
+
|
|
488
|
+
### Fields
|
|
489
|
+
|
|
490
|
+
| Name | Required | Type | Description |
|
|
491
|
+
|---|---:|---|---|
|
|
492
|
+
| `image` | no | string | Avatar image URL |
|
|
493
|
+
| `imageProps` | no | [ImageProp](./types.md#imageprop) | |
|
|
494
|
+
| `title` | no | string | Title for generating initials when no image |
|
|
495
|
+
|
|
496
|
+
No additional properties.
|
|
497
|
+
|
|
498
|
+
## ChipIcon
|
|
499
|
+
|
|
500
|
+
### Fields
|
|
501
|
+
|
|
502
|
+
| Name | Required | Type | Description |
|
|
503
|
+
|---|---:|---|---|
|
|
504
|
+
| `alignment` | no | [ChipIconAlignment](./definitions.md#chipiconalignment) | Icon position relative to text. Default: Left |
|
|
505
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
506
|
+
| `type` | yes | string | Icon type name (e.g., "CHECK", "USERS_OUTLINE") |
|
|
507
|
+
|
|
508
|
+
No additional properties.
|
|
509
|
+
|
|
260
510
|
## ChipTip
|
|
261
511
|
|
|
262
512
|
Tooltip configuration. Chip has default overflow tooltip behavior
|
|
@@ -268,9 +518,20 @@ Tooltip configuration. Chip has default overflow tooltip behavior
|
|
|
268
518
|
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance (LIGHT, DARK). Default: LIGHT |
|
|
269
519
|
| `content` | yes | string | Tooltip content text |
|
|
270
520
|
| `isVisible` | no | boolean | Control tooltip visibility from parent |
|
|
271
|
-
| `maxHeight` | no |
|
|
272
|
-
| `maxWidth` | no |
|
|
273
|
-
| `placement` | no | [
|
|
521
|
+
| `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
|
|
522
|
+
| `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
|
|
523
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to chip. Default: TOP_START |
|
|
524
|
+
|
|
525
|
+
No additional properties.
|
|
526
|
+
|
|
527
|
+
## ChipTo
|
|
528
|
+
|
|
529
|
+
### Fields
|
|
530
|
+
|
|
531
|
+
| Name | Required | Type | Description |
|
|
532
|
+
|---|---:|---|---|
|
|
533
|
+
| `openInNewTab` | no | boolean | Open link in new tab |
|
|
534
|
+
| `path` | yes | string | Navigation path or URL |
|
|
274
535
|
|
|
275
536
|
No additional properties.
|
|
276
537
|
|
|
@@ -282,7 +543,7 @@ Configure when each priority level auto-collapses based on container width. Keys
|
|
|
282
543
|
|
|
283
544
|
_No fields._
|
|
284
545
|
|
|
285
|
-
Additional properties:
|
|
546
|
+
Additional properties: [ResponsiveAbove](./definitions.md#responsiveabove) | false.
|
|
286
547
|
|
|
287
548
|
## ColorPickerArg
|
|
288
549
|
|
|
@@ -313,11 +574,24 @@ No additional properties.
|
|
|
313
574
|
| `align` | no | [HeadingAlign](./definitions.md#headingalign) | Text alignment for this column |
|
|
314
575
|
| `header` | yes | string | Column header text |
|
|
315
576
|
| `key` | yes | string | Key to look up cell value in each row object |
|
|
316
|
-
| `width` | no |
|
|
577
|
+
| `width` | no | number \| string | Column width in px (number) or CSS string |
|
|
317
578
|
| `wrapText` | no | boolean | Whether to wrap text in cells of this column. Default: false (nowrap) |
|
|
318
579
|
|
|
319
580
|
No additional properties.
|
|
320
581
|
|
|
582
|
+
## CountryIcon
|
|
583
|
+
|
|
584
|
+
### Fields
|
|
585
|
+
|
|
586
|
+
| Name | Required | Type | Description |
|
|
587
|
+
|---|---:|---|---|
|
|
588
|
+
| `alignment` | no | [CountryIconAlignment](./definitions.md#countryiconalignment) | Alignment of the icon within the container. Use "RIGHT" to push icon to the right. |
|
|
589
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
590
|
+
| `tip` | no | string | Tooltip content shown on icon hover |
|
|
591
|
+
| `type` | yes | string | Icon type name (e.g. "INFO_CIRCLE_OUTLINE") |
|
|
592
|
+
|
|
593
|
+
No additional properties.
|
|
594
|
+
|
|
321
595
|
## CurrencyArg
|
|
322
596
|
|
|
323
597
|
### Fields
|
|
@@ -434,11 +708,21 @@ No additional properties.
|
|
|
434
708
|
|
|
435
709
|
| Name | Required | Type | Description |
|
|
436
710
|
|---|---:|---|---|
|
|
437
|
-
| `id` | yes |
|
|
711
|
+
| `id` | yes | string \| number | Unique identifier for the item |
|
|
438
712
|
| `label` | no | string | Display label for the item |
|
|
439
713
|
|
|
440
714
|
No additional properties.
|
|
441
715
|
|
|
716
|
+
## DropdownDisabledInfo
|
|
717
|
+
|
|
718
|
+
### Fields
|
|
719
|
+
|
|
720
|
+
| Name | Required | Type | Description |
|
|
721
|
+
|---|---:|---|---|
|
|
722
|
+
| `content` | yes | string | |
|
|
723
|
+
|
|
724
|
+
No additional properties.
|
|
725
|
+
|
|
442
726
|
## DropdownList
|
|
443
727
|
|
|
444
728
|
### Fields
|
|
@@ -456,7 +740,7 @@ No additional properties.
|
|
|
456
740
|
|
|
457
741
|
| Name | Required | Type | Description |
|
|
458
742
|
|---|---:|---|---|
|
|
459
|
-
| `disabledInfo` | no |
|
|
743
|
+
| `disabledInfo` | no | string \| [DropdownDisabledInfo](./types.md#dropdowndisabledinfo) | Tooltip content shown when the option is disabled |
|
|
460
744
|
| `isDisabled` | no | boolean | Disables this option |
|
|
461
745
|
| `label` | yes | string | Display text for the option |
|
|
462
746
|
| `labelIcon` | no | string | Icon name to show next to the label |
|
|
@@ -559,6 +843,39 @@ No additional properties.
|
|
|
559
843
|
|
|
560
844
|
No additional properties.
|
|
561
845
|
|
|
846
|
+
## FloatingButtonIcon
|
|
847
|
+
|
|
848
|
+
### Fields
|
|
849
|
+
|
|
850
|
+
| Name | Required | Type | Description |
|
|
851
|
+
|---|---:|---|---|
|
|
852
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
853
|
+
| `type` | yes | string | Icon type from Icon.TYPES |
|
|
854
|
+
|
|
855
|
+
No additional properties.
|
|
856
|
+
|
|
857
|
+
## FloatingButtonTip
|
|
858
|
+
|
|
859
|
+
### Fields
|
|
860
|
+
|
|
861
|
+
| Name | Required | Type | Description |
|
|
862
|
+
|---|---:|---|---|
|
|
863
|
+
| `content` | yes | string | Tooltip content text |
|
|
864
|
+
| `placement` | no | string | Tooltip placement (TOP, BOTTOM, LEFT, RIGHT). Default: TOP |
|
|
865
|
+
|
|
866
|
+
No additional properties.
|
|
867
|
+
|
|
868
|
+
## FloatingButtonTo
|
|
869
|
+
|
|
870
|
+
### Fields
|
|
871
|
+
|
|
872
|
+
| Name | Required | Type | Description |
|
|
873
|
+
|---|---:|---|---|
|
|
874
|
+
| `openInNewTab` | no | boolean | Open link in new tab. Default: false |
|
|
875
|
+
| `path` | yes | string | URL path for navigation |
|
|
876
|
+
|
|
877
|
+
No additional properties.
|
|
878
|
+
|
|
562
879
|
## FormCheckboxGroupOption
|
|
563
880
|
|
|
564
881
|
### Fields
|
|
@@ -568,12 +885,23 @@ No additional properties.
|
|
|
568
885
|
| `isDisabled` | no | boolean | Disables this specific checkbox |
|
|
569
886
|
| `label` | yes | string | Display text for the checkbox option |
|
|
570
887
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
571
|
-
| `tag` | no |
|
|
888
|
+
| `tag` | no | string \| [FormCheckboxGroupTag](./types.md#formcheckboxgrouptag) | Optional tag/label displayed with the option |
|
|
572
889
|
| `tip` | no | string | Tooltip text shown on hover |
|
|
573
890
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
574
891
|
|
|
575
892
|
No additional properties.
|
|
576
893
|
|
|
894
|
+
## FormCheckboxGroupTag
|
|
895
|
+
|
|
896
|
+
### Fields
|
|
897
|
+
|
|
898
|
+
| Name | Required | Type | Description |
|
|
899
|
+
|---|---:|---|---|
|
|
900
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
|
|
901
|
+
| `label` | yes | string | Tag label text |
|
|
902
|
+
|
|
903
|
+
No additional properties.
|
|
904
|
+
|
|
577
905
|
## FormCheckboxGroupValidationError
|
|
578
906
|
|
|
579
907
|
Map of rule name to error message
|
|
@@ -785,13 +1113,35 @@ _No fields._
|
|
|
785
1113
|
|
|
786
1114
|
Additional properties: unknown.
|
|
787
1115
|
|
|
788
|
-
##
|
|
789
|
-
|
|
790
|
-
Map of rule name to error message
|
|
1116
|
+
## FormInputGroupPrefix
|
|
791
1117
|
|
|
792
1118
|
### Fields
|
|
793
1119
|
|
|
794
|
-
|
|
1120
|
+
| Name | Required | Type | Description |
|
|
1121
|
+
|---|---:|---|---|
|
|
1122
|
+
| `inputProps` | yes | [FormInputGroupInputProp](./types.md#forminputgroupinputprop) | Props to pass to the input component |
|
|
1123
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
1124
|
+
|
|
1125
|
+
No additional properties.
|
|
1126
|
+
|
|
1127
|
+
## FormInputGroupSuffix
|
|
1128
|
+
|
|
1129
|
+
### Fields
|
|
1130
|
+
|
|
1131
|
+
| Name | Required | Type | Description |
|
|
1132
|
+
|---|---:|---|---|
|
|
1133
|
+
| `inputProps` | yes | [FormInputGroupInputProp](./types.md#forminputgroupinputprop) | Props to pass to the input component |
|
|
1134
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
1135
|
+
|
|
1136
|
+
No additional properties.
|
|
1137
|
+
|
|
1138
|
+
## FormInputGroupValidationError
|
|
1139
|
+
|
|
1140
|
+
Map of rule name to error message
|
|
1141
|
+
|
|
1142
|
+
### Fields
|
|
1143
|
+
|
|
1144
|
+
_No fields._
|
|
795
1145
|
|
|
796
1146
|
Additional properties: string.
|
|
797
1147
|
|
|
@@ -855,12 +1205,23 @@ Additional properties: string.
|
|
|
855
1205
|
| `isDisabled` | no | boolean | Disables this specific option |
|
|
856
1206
|
| `label` | yes | string | Display text for the option |
|
|
857
1207
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
858
|
-
| `tag` | no |
|
|
1208
|
+
| `tag` | no | string \| [FormRadioTag](./types.md#formradiotag) | Optional tag/label displayed with the option |
|
|
859
1209
|
| `tip` | no | string | Tooltip text shown on hover |
|
|
860
1210
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
861
1211
|
|
|
862
1212
|
No additional properties.
|
|
863
1213
|
|
|
1214
|
+
## FormRadioTag
|
|
1215
|
+
|
|
1216
|
+
### Fields
|
|
1217
|
+
|
|
1218
|
+
| Name | Required | Type | Description |
|
|
1219
|
+
|---|---:|---|---|
|
|
1220
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
|
|
1221
|
+
| `label` | yes | string | Tag label text |
|
|
1222
|
+
|
|
1223
|
+
No additional properties.
|
|
1224
|
+
|
|
864
1225
|
## FormRadioValidationError
|
|
865
1226
|
|
|
866
1227
|
Map of rule name to error message
|
|
@@ -927,6 +1288,42 @@ _No fields._
|
|
|
927
1288
|
|
|
928
1289
|
Additional properties: string.
|
|
929
1290
|
|
|
1291
|
+
## FormSelectAvatarProp
|
|
1292
|
+
|
|
1293
|
+
Avatar configuration for the option
|
|
1294
|
+
|
|
1295
|
+
### Fields
|
|
1296
|
+
|
|
1297
|
+
| Name | Required | Type | Description |
|
|
1298
|
+
|---|---:|---|---|
|
|
1299
|
+
| `image` | no | string | URL of avatar image |
|
|
1300
|
+
| `title` | no | string | Title/alt text for avatar |
|
|
1301
|
+
|
|
1302
|
+
No additional properties.
|
|
1303
|
+
|
|
1304
|
+
## FormSelectOption
|
|
1305
|
+
|
|
1306
|
+
### Fields
|
|
1307
|
+
|
|
1308
|
+
| Name | Required | Type | Description |
|
|
1309
|
+
|---|---:|---|---|
|
|
1310
|
+
| `avatarProps` | no | [FormSelectAvatarProp](./types.md#formselectavatarprop) | Avatar configuration for the option |
|
|
1311
|
+
| `description` | no | string | Description text shown below the label |
|
|
1312
|
+
| `flag` | no | string | Two-letter country code for flag icon (e.g. "US", "IN") |
|
|
1313
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
1314
|
+
| `isRecommended` | no | boolean | Marks option as recommended with a badge |
|
|
1315
|
+
| `isSeparator` | no | boolean | Renders as a visual separator instead of selectable option |
|
|
1316
|
+
| `label` | yes | string | Display text for the option |
|
|
1317
|
+
| `labelIcon` | no | string | Icon glyph name to show next to the label |
|
|
1318
|
+
| `leftIconType` | no | string | Icon glyph name to show on the left. E.g. "CHECK_CIRCLE_OUTLINE" |
|
|
1319
|
+
| `quaternaryLabel` | no | string | Quaternary label shown below tertiary label |
|
|
1320
|
+
| `rightLabel` | no | string | Label aligned to the right side of the option |
|
|
1321
|
+
| `secondaryLabel` | no | string | Secondary label shown below the main label |
|
|
1322
|
+
| `tertiaryLabel` | no | string | Tertiary label shown below secondary label |
|
|
1323
|
+
| `value` | yes | unknown | Value stored when option is selected |
|
|
1324
|
+
|
|
1325
|
+
No additional properties.
|
|
1326
|
+
|
|
930
1327
|
## FormSelectValidationError
|
|
931
1328
|
|
|
932
1329
|
Map of rule name to error message
|
|
@@ -994,9 +1391,9 @@ Additional properties: string.
|
|
|
994
1391
|
| Name | Required | Type | Description |
|
|
995
1392
|
|---|---:|---|---|
|
|
996
1393
|
| `isDisabled` | no | boolean | Disable this specific option |
|
|
997
|
-
| `label` | no |
|
|
1394
|
+
| `label` | no | string \| number | Display label for the option |
|
|
998
1395
|
| `selectionColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Override selected surface color token for this option |
|
|
999
|
-
| `value` | yes |
|
|
1396
|
+
| `value` | yes | string \| number | Value when selected |
|
|
1000
1397
|
|
|
1001
1398
|
No additional properties.
|
|
1002
1399
|
|
|
@@ -1050,7 +1447,7 @@ Additional properties: string.
|
|
|
1050
1447
|
| Name | Required | Type | Description |
|
|
1051
1448
|
|---|---:|---|---|
|
|
1052
1449
|
| `label` | yes | string | Display text for the suggestion |
|
|
1053
|
-
| `value` | yes |
|
|
1450
|
+
| `value` | yes | string \| number | Value stored when suggestion is selected |
|
|
1054
1451
|
|
|
1055
1452
|
No additional properties.
|
|
1056
1453
|
|
|
@@ -1082,47 +1479,344 @@ Map of rule name to error message
|
|
|
1082
1479
|
|
|
1083
1480
|
_No fields._
|
|
1084
1481
|
|
|
1085
|
-
Additional properties: string.
|
|
1482
|
+
Additional properties: string.
|
|
1483
|
+
|
|
1484
|
+
## FormTimezoneValidationError
|
|
1485
|
+
|
|
1486
|
+
Map of rule name to error message
|
|
1487
|
+
|
|
1488
|
+
### Fields
|
|
1489
|
+
|
|
1490
|
+
_No fields._
|
|
1491
|
+
|
|
1492
|
+
Additional properties: string.
|
|
1493
|
+
|
|
1494
|
+
## FormTreeDisabledInfo
|
|
1495
|
+
|
|
1496
|
+
### Fields
|
|
1497
|
+
|
|
1498
|
+
| Name | Required | Type | Description |
|
|
1499
|
+
|---|---:|---|---|
|
|
1500
|
+
| `content` | yes | string | Tooltip content text |
|
|
1501
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices |
|
|
1502
|
+
| `maxHeight` | no | number \| string | Maximum tooltip height |
|
|
1503
|
+
| `maxWidth` | no | number \| string | Maximum tooltip width |
|
|
1504
|
+
|
|
1505
|
+
No additional properties.
|
|
1506
|
+
|
|
1507
|
+
## FormTreeFuseOption
|
|
1508
|
+
|
|
1509
|
+
Fuse.js search options for customizing search behavior
|
|
1510
|
+
|
|
1511
|
+
### Fields
|
|
1512
|
+
|
|
1513
|
+
_No fields._
|
|
1514
|
+
|
|
1515
|
+
Additional properties: unknown.
|
|
1516
|
+
|
|
1517
|
+
## FormTreeList
|
|
1518
|
+
|
|
1519
|
+
### Fields
|
|
1520
|
+
|
|
1521
|
+
| Name | Required | Type | Description |
|
|
1522
|
+
|---|---:|---|---|
|
|
1523
|
+
| `disabledInfo` | no | string \| [FormTreeDisabledInfo](./types.md#formtreedisabledinfo) | Tooltip shown when item is disabled |
|
|
1524
|
+
| `isDisabled` | no | boolean | Disable this item |
|
|
1525
|
+
| `label` | yes | string | Display label for the item |
|
|
1526
|
+
| `parent` | no | string | Parent item value, null for root items |
|
|
1527
|
+
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
1528
|
+
| `tag` | no | string \| [FormTreeTag](./types.md#formtreetag) | Chip/tag to display next to the label |
|
|
1529
|
+
| `value` | yes | string | Unique identifier for the item |
|
|
1530
|
+
|
|
1531
|
+
No additional properties.
|
|
1532
|
+
|
|
1533
|
+
## FormTreeSelectFuseOption
|
|
1534
|
+
|
|
1535
|
+
Fuse.js search configuration. Default: { keys: ["label", "name"] }
|
|
1536
|
+
|
|
1537
|
+
### Fields
|
|
1538
|
+
|
|
1539
|
+
_No fields._
|
|
1540
|
+
|
|
1541
|
+
Additional properties: unknown.
|
|
1542
|
+
|
|
1543
|
+
## FormTreeSelectList
|
|
1544
|
+
|
|
1545
|
+
### Fields
|
|
1546
|
+
|
|
1547
|
+
| Name | Required | Type | Description |
|
|
1548
|
+
|---|---:|---|---|
|
|
1549
|
+
| `isDisabled` | no | boolean | Disable this item |
|
|
1550
|
+
| `label` | yes | string | Display label for the item |
|
|
1551
|
+
| `parent` | no | string | Parent item value, null for root items |
|
|
1552
|
+
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
1553
|
+
| `value` | yes | string | Unique identifier for the item |
|
|
1554
|
+
|
|
1555
|
+
No additional properties.
|
|
1556
|
+
|
|
1557
|
+
## FormTreeSelectValidationError
|
|
1558
|
+
|
|
1559
|
+
Map of rule name to error message
|
|
1560
|
+
|
|
1561
|
+
### Fields
|
|
1562
|
+
|
|
1563
|
+
_No fields._
|
|
1564
|
+
|
|
1565
|
+
Additional properties: string.
|
|
1566
|
+
|
|
1567
|
+
## FormTreeTag
|
|
1568
|
+
|
|
1569
|
+
### Fields
|
|
1570
|
+
|
|
1571
|
+
| Name | Required | Type | Description |
|
|
1572
|
+
|---|---:|---|---|
|
|
1573
|
+
| `appearance` | no | string | Label appearance (e.g., "primary", "error", "success") |
|
|
1574
|
+
| `text` | yes | string | Tag text to display |
|
|
1575
|
+
|
|
1576
|
+
No additional properties.
|
|
1577
|
+
|
|
1578
|
+
## FormTreeValidationError
|
|
1579
|
+
|
|
1580
|
+
Map of rule name to error message
|
|
1581
|
+
|
|
1582
|
+
### Fields
|
|
1583
|
+
|
|
1584
|
+
_No fields._
|
|
1585
|
+
|
|
1586
|
+
Additional properties: string.
|
|
1587
|
+
|
|
1588
|
+
## FormValidationError
|
|
1589
|
+
|
|
1590
|
+
External validation errors keyed by input name
|
|
1591
|
+
|
|
1592
|
+
### Fields
|
|
1593
|
+
|
|
1594
|
+
_No fields._
|
|
1595
|
+
|
|
1596
|
+
Additional properties: string.
|
|
1597
|
+
|
|
1598
|
+
## FormValue
|
|
1599
|
+
|
|
1600
|
+
Form values model. Written to state on change/submit (read-only — push-only)
|
|
1601
|
+
|
|
1602
|
+
### Fields
|
|
1603
|
+
|
|
1604
|
+
_No fields._
|
|
1605
|
+
|
|
1606
|
+
Additional properties: unknown.
|
|
1607
|
+
|
|
1608
|
+
## FormWorkEmailValidationError
|
|
1609
|
+
|
|
1610
|
+
Map of rule name to error message
|
|
1611
|
+
|
|
1612
|
+
### Fields
|
|
1613
|
+
|
|
1614
|
+
_No fields._
|
|
1615
|
+
|
|
1616
|
+
Additional properties: string.
|
|
1617
|
+
|
|
1618
|
+
## GridAction
|
|
1619
|
+
|
|
1620
|
+
### Fields
|
|
1621
|
+
|
|
1622
|
+
| Name | Required | Type | Description |
|
|
1623
|
+
|---|---:|---|---|
|
|
1624
|
+
| `aria-label` | no | string | Accessibility label for the action button |
|
|
1625
|
+
| `aria-labelledby` | no | string | ID of element that labels the action button |
|
|
1626
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
1627
|
+
| `iconType` | yes | string | Icon type name (e.g., "EDIT_OUTLINE", "DELETE") |
|
|
1628
|
+
| `id` | yes | string | Unique identifier for this action. Written to state on click |
|
|
1629
|
+
| `isDisabled` | no | boolean | Disable the action button. Default: false |
|
|
1630
|
+
| `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip for the action button. Can be a simple string or tooltip configuration object |
|
|
1631
|
+
|
|
1632
|
+
No additional properties.
|
|
1633
|
+
|
|
1634
|
+
## GridLeftIcon
|
|
1635
|
+
|
|
1636
|
+
### Fields
|
|
1637
|
+
|
|
1638
|
+
| Name | Required | Type | Description |
|
|
1639
|
+
|---|---:|---|---|
|
|
1640
|
+
| `aria-describedby` | no | string | ID of element that describes this icon |
|
|
1641
|
+
| `aria-label` | no | string | Accessible label for screen readers |
|
|
1642
|
+
| `aria-labelledby` | no | string | ID of element that labels this icon |
|
|
1643
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
|
|
1644
|
+
| `type` | yes | string | Icon type name |
|
|
1645
|
+
|
|
1646
|
+
No additional properties.
|
|
1647
|
+
|
|
1648
|
+
## GridList
|
|
1649
|
+
|
|
1650
|
+
### Fields
|
|
1651
|
+
|
|
1652
|
+
| Name | Required | Type | Description |
|
|
1653
|
+
|---|---:|---|---|
|
|
1654
|
+
| `label` | yes | string \| number | Label displayed in the cell header. String or number value |
|
|
1655
|
+
| `props` | yes | [GridProp](./types.md#gridprop) | Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens. |
|
|
1656
|
+
| `renderer` | yes | "LABEL" | Renderer type for the cell value. LABEL renders a Label component. |
|
|
1657
|
+
| `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
|
|
1658
|
+
|
|
1659
|
+
No additional properties.
|
|
1660
|
+
|
|
1661
|
+
## GridProp
|
|
1662
|
+
|
|
1663
|
+
Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
|
|
1664
|
+
|
|
1665
|
+
### Fields
|
|
1666
|
+
|
|
1667
|
+
| Name | Required | Type | Description |
|
|
1668
|
+
|---|---:|---|---|
|
|
1669
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Color scheme of the label. Default: NEUTRAL |
|
|
1670
|
+
| `children` | no | string | Text content of the label |
|
|
1671
|
+
| `leftIcon` | no | string \| [GridLeftIcon](./types.md#gridlefticon) | Icon displayed on the left side of the label |
|
|
1672
|
+
| `maxWidth` | no | string | Maximum width CSS value for truncation |
|
|
1673
|
+
| `rightIcon` | no | string \| [GridRightIcon](./types.md#gridrighticon) | Icon displayed on the right side of the label |
|
|
1674
|
+
| `size` | no | [LabelSize](./definitions.md#labelsize) | Size of the label. Default: LARGE |
|
|
1675
|
+
| `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
|
|
1676
|
+
| `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
|
|
1677
|
+
|
|
1678
|
+
No additional properties.
|
|
1679
|
+
|
|
1680
|
+
## GridRightIcon
|
|
1681
|
+
|
|
1682
|
+
### Fields
|
|
1683
|
+
|
|
1684
|
+
| Name | Required | Type | Description |
|
|
1685
|
+
|---|---:|---|---|
|
|
1686
|
+
| `aria-describedby` | no | string | ID of element that describes this icon |
|
|
1687
|
+
| `aria-label` | no | string | Accessible label for screen readers |
|
|
1688
|
+
| `aria-labelledby` | no | string | ID of element that labels this icon |
|
|
1689
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
|
|
1690
|
+
| `type` | yes | string | Icon type name |
|
|
1691
|
+
|
|
1692
|
+
No additional properties.
|
|
1693
|
+
|
|
1694
|
+
## GridTip
|
|
1695
|
+
|
|
1696
|
+
### Fields
|
|
1697
|
+
|
|
1698
|
+
| Name | Required | Type | Description |
|
|
1699
|
+
|---|---:|---|---|
|
|
1700
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style |
|
|
1701
|
+
| `content` | yes | string | Tooltip content text |
|
|
1702
|
+
| `isVisible` | no | boolean | Force tooltip to always be visible |
|
|
1703
|
+
| `maxHeight` | no | number \| string | Maximum height for tooltip |
|
|
1704
|
+
| `maxWidth` | no | number \| string | Maximum width for tooltip |
|
|
1705
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement position |
|
|
1706
|
+
|
|
1707
|
+
No additional properties.
|
|
1708
|
+
|
|
1709
|
+
## HelperMessage
|
|
1710
|
+
|
|
1711
|
+
### Fields
|
|
1712
|
+
|
|
1713
|
+
| Name | Required | Type | Description |
|
|
1714
|
+
|---|---:|---|---|
|
|
1715
|
+
| `message` | yes | string | Helper or error message text |
|
|
1716
|
+
| `status` | no | string | Message status, e.g. "ERROR" for validation errors |
|
|
1717
|
+
|
|
1718
|
+
No additional properties.
|
|
1719
|
+
|
|
1720
|
+
## HStackMargin
|
|
1721
|
+
|
|
1722
|
+
### Fields
|
|
1723
|
+
|
|
1724
|
+
| Name | Required | Type | Description |
|
|
1725
|
+
|---|---:|---|---|
|
|
1726
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
1727
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
1728
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
1729
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
1730
|
+
|
|
1731
|
+
No additional properties.
|
|
1732
|
+
|
|
1733
|
+
## HStackPadding
|
|
1734
|
+
|
|
1735
|
+
### Fields
|
|
1736
|
+
|
|
1737
|
+
| Name | Required | Type | Description |
|
|
1738
|
+
|---|---:|---|---|
|
|
1739
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
1740
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
1741
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
1742
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
1743
|
+
|
|
1744
|
+
No additional properties.
|
|
1745
|
+
|
|
1746
|
+
## IconButtonIcon
|
|
1747
|
+
|
|
1748
|
+
### Fields
|
|
1749
|
+
|
|
1750
|
+
| Name | Required | Type | Description |
|
|
1751
|
+
|---|---:|---|---|
|
|
1752
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
1753
|
+
| `type` | yes | string | Icon type from Icon.TYPES |
|
|
1754
|
+
|
|
1755
|
+
No additional properties.
|
|
1756
|
+
|
|
1757
|
+
## IconButtonTip
|
|
1758
|
+
|
|
1759
|
+
### Fields
|
|
1760
|
+
|
|
1761
|
+
| Name | Required | Type | Description |
|
|
1762
|
+
|---|---:|---|---|
|
|
1763
|
+
| `content` | yes | string | Tooltip content text |
|
|
1764
|
+
| `placement` | no | string | Tooltip placement (TOP, BOTTOM, LEFT, RIGHT). Default: TOP |
|
|
1765
|
+
|
|
1766
|
+
No additional properties.
|
|
1767
|
+
|
|
1768
|
+
## IconButtonTo
|
|
1769
|
+
|
|
1770
|
+
### Fields
|
|
1771
|
+
|
|
1772
|
+
| Name | Required | Type | Description |
|
|
1773
|
+
|---|---:|---|---|
|
|
1774
|
+
| `openInNewTab` | no | boolean | Open link in new tab. Default: false |
|
|
1775
|
+
| `path` | yes | string | URL path for navigation |
|
|
1086
1776
|
|
|
1087
|
-
|
|
1777
|
+
No additional properties.
|
|
1088
1778
|
|
|
1089
|
-
|
|
1779
|
+
## IconTip
|
|
1090
1780
|
|
|
1091
1781
|
### Fields
|
|
1092
1782
|
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1783
|
+
| Name | Required | Type | Description |
|
|
1784
|
+
|---|---:|---|---|
|
|
1785
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
|
|
1786
|
+
| `content` | yes | string | Tooltip text content |
|
|
1787
|
+
| `maxHeight` | no | number \| string | Max height in px or CSS string |
|
|
1788
|
+
| `maxWidth` | no | number \| string | Max width in px or CSS string |
|
|
1789
|
+
| `placement` | no | [IconTipPlacement](./definitions.md#icontipplacement) | Tooltip placement. Default: BOTTOM |
|
|
1790
|
+
| `title` | no | string | Tooltip title text |
|
|
1096
1791
|
|
|
1097
|
-
|
|
1792
|
+
No additional properties.
|
|
1098
1793
|
|
|
1099
|
-
|
|
1794
|
+
## ImageProp
|
|
1100
1795
|
|
|
1101
1796
|
### Fields
|
|
1102
1797
|
|
|
1103
|
-
|
|
1798
|
+
| Name | Required | Type | Description |
|
|
1799
|
+
|---|---:|---|---|
|
|
1800
|
+
| `alt` | no | string | Alt text for avatar image |
|
|
1104
1801
|
|
|
1105
|
-
|
|
1802
|
+
No additional properties.
|
|
1106
1803
|
|
|
1107
|
-
##
|
|
1804
|
+
## InputGroupInput
|
|
1805
|
+
|
|
1806
|
+
Main input configuration with type and inputProps
|
|
1108
1807
|
|
|
1109
1808
|
### Fields
|
|
1110
1809
|
|
|
1111
1810
|
| Name | Required | Type | Description |
|
|
1112
1811
|
|---|---:|---|---|
|
|
1113
|
-
| `
|
|
1114
|
-
| `
|
|
1115
|
-
| `label` | yes | string | Display label for the item |
|
|
1116
|
-
| `parent` | no | string | Parent item value, null for root items |
|
|
1117
|
-
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
1118
|
-
| `tag` | no | unknown | Chip/tag to display next to the label |
|
|
1119
|
-
| `value` | yes | string | Unique identifier for the item |
|
|
1812
|
+
| `inputProps` | yes | [InputGroupInputProp](./types.md#inputgroupinputprop) | Props to pass to the input component |
|
|
1813
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
1120
1814
|
|
|
1121
1815
|
No additional properties.
|
|
1122
1816
|
|
|
1123
|
-
##
|
|
1817
|
+
## InputGroupInputProp
|
|
1124
1818
|
|
|
1125
|
-
|
|
1819
|
+
Props to pass to the input component
|
|
1126
1820
|
|
|
1127
1821
|
### Fields
|
|
1128
1822
|
|
|
@@ -1130,108 +1824,148 @@ _No fields._
|
|
|
1130
1824
|
|
|
1131
1825
|
Additional properties: unknown.
|
|
1132
1826
|
|
|
1133
|
-
##
|
|
1827
|
+
## InputGroupPrefix
|
|
1134
1828
|
|
|
1135
1829
|
### Fields
|
|
1136
1830
|
|
|
1137
1831
|
| Name | Required | Type | Description |
|
|
1138
1832
|
|---|---:|---|---|
|
|
1139
|
-
| `
|
|
1140
|
-
| `
|
|
1141
|
-
| `parent` | no | string | Parent item value, null for root items |
|
|
1142
|
-
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
1143
|
-
| `value` | yes | string | Unique identifier for the item |
|
|
1833
|
+
| `inputProps` | yes | [InputGroupInputProp](./types.md#inputgroupinputprop) | Props to pass to the input component |
|
|
1834
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
1144
1835
|
|
|
1145
1836
|
No additional properties.
|
|
1146
1837
|
|
|
1147
|
-
##
|
|
1148
|
-
|
|
1149
|
-
Map of rule name to error message
|
|
1838
|
+
## InputGroupSuffix
|
|
1150
1839
|
|
|
1151
1840
|
### Fields
|
|
1152
1841
|
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1842
|
+
| Name | Required | Type | Description |
|
|
1843
|
+
|---|---:|---|---|
|
|
1844
|
+
| `inputProps` | yes | [InputGroupInputProp](./types.md#inputgroupinputprop) | Props to pass to the input component |
|
|
1845
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
1156
1846
|
|
|
1157
|
-
|
|
1847
|
+
No additional properties.
|
|
1158
1848
|
|
|
1159
|
-
|
|
1849
|
+
## LabelLeftIcon
|
|
1160
1850
|
|
|
1161
1851
|
### Fields
|
|
1162
1852
|
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1853
|
+
| Name | Required | Type | Description |
|
|
1854
|
+
|---|---:|---|---|
|
|
1855
|
+
| `aria-describedby` | no | string | ID of element that describes this icon |
|
|
1856
|
+
| `aria-label` | no | string | Accessible label for screen readers |
|
|
1857
|
+
| `aria-labelledby` | no | string | ID of element that labels this icon |
|
|
1858
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
|
|
1859
|
+
| `type` | yes | string | Icon type name |
|
|
1166
1860
|
|
|
1167
|
-
|
|
1861
|
+
No additional properties.
|
|
1168
1862
|
|
|
1169
|
-
|
|
1863
|
+
## LabelRightIcon
|
|
1170
1864
|
|
|
1171
1865
|
### Fields
|
|
1172
1866
|
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1867
|
+
| Name | Required | Type | Description |
|
|
1868
|
+
|---|---:|---|---|
|
|
1869
|
+
| `aria-describedby` | no | string | ID of element that describes this icon |
|
|
1870
|
+
| `aria-label` | no | string | Accessible label for screen readers |
|
|
1871
|
+
| `aria-labelledby` | no | string | ID of element that labels this icon |
|
|
1872
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
|
|
1873
|
+
| `type` | yes | string | Icon type name |
|
|
1176
1874
|
|
|
1177
|
-
|
|
1875
|
+
No additional properties.
|
|
1178
1876
|
|
|
1179
|
-
|
|
1877
|
+
## LabelTip
|
|
1180
1878
|
|
|
1181
1879
|
### Fields
|
|
1182
1880
|
|
|
1183
|
-
|
|
1881
|
+
| Name | Required | Type | Description |
|
|
1882
|
+
|---|---:|---|---|
|
|
1883
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style. Default: LIGHT |
|
|
1884
|
+
| `className` | no | string | CSS class name for tooltip |
|
|
1885
|
+
| `content` | yes | string | Tooltip text content |
|
|
1886
|
+
| `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls. Default: false |
|
|
1887
|
+
| `isDelayed` | no | boolean | Add 300ms delay before showing tooltip. Default: false |
|
|
1888
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
|
|
1889
|
+
| `isPositionFixed` | no | boolean | Use fixed positioning (relative to viewport). Default: false |
|
|
1890
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent component |
|
|
1891
|
+
| `maxHeight` | no | number \| string | Maximum height for tooltip content |
|
|
1892
|
+
| `maxWidth` | no | number \| string | Maximum width for tooltip content |
|
|
1893
|
+
| `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows. Default: false |
|
|
1894
|
+
| `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows. Default: false |
|
|
1895
|
+
| `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware. Default: false |
|
|
1896
|
+
| `padding` | no | string | CSS padding value for tooltip content |
|
|
1897
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to label. Default: TOP_START |
|
|
1898
|
+
| `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis. Default: false |
|
|
1899
|
+
| `tipHideDelay` | no | number | Milliseconds to wait before hiding tooltip (when isDelayed is true) |
|
|
1900
|
+
| `tipShowDelay` | no | number | Milliseconds to wait before showing tooltip (when isDelayed is true) |
|
|
1901
|
+
| `title` | no | string | Tooltip title text |
|
|
1902
|
+
| `truncateClassName` | no | string | CSS class when onlyIfOverflow is enabled |
|
|
1184
1903
|
|
|
1185
|
-
|
|
1904
|
+
No additional properties.
|
|
1186
1905
|
|
|
1187
|
-
##
|
|
1906
|
+
## LayoutBorder
|
|
1188
1907
|
|
|
1189
|
-
|
|
1908
|
+
Structured border using strict token parts
|
|
1190
1909
|
|
|
1191
1910
|
### Fields
|
|
1192
1911
|
|
|
1193
|
-
|
|
1912
|
+
| Name | Required | Type | Description |
|
|
1913
|
+
|---|---:|---|---|
|
|
1914
|
+
| `color` | no | [BoxBorderColor](./definitions.md#boxbordercolor) | Border color token |
|
|
1915
|
+
| `style` | no | [BoxBorderStyle](./definitions.md#boxborderstyle) | CSS border style |
|
|
1916
|
+
| `width` | no | [BoxBorderWidth](./definitions.md#boxborderwidth) | Border width token |
|
|
1194
1917
|
|
|
1195
|
-
|
|
1918
|
+
No additional properties.
|
|
1196
1919
|
|
|
1197
|
-
##
|
|
1920
|
+
## LayoutGap
|
|
1198
1921
|
|
|
1199
1922
|
### Fields
|
|
1200
1923
|
|
|
1201
1924
|
| Name | Required | Type | Description |
|
|
1202
1925
|
|---|---:|---|---|
|
|
1203
|
-
| `
|
|
1204
|
-
| `
|
|
1205
|
-
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
1206
|
-
| `iconType` | yes | string | Icon type name (e.g., "EDIT_OUTLINE", "DELETE") |
|
|
1207
|
-
| `id` | yes | string | Unique identifier for this action. Written to state on click |
|
|
1208
|
-
| `isDisabled` | no | boolean | Disable the action button. Default: false |
|
|
1209
|
-
| `tip` | no | unknown | Tooltip for the action button. Can be a simple string or tooltip configuration object |
|
|
1926
|
+
| `column` | no | [BoxGap](./definitions.md#boxgap) | Column gap spacing token |
|
|
1927
|
+
| `row` | no | [BoxGap](./definitions.md#boxgap) | Row gap spacing token |
|
|
1210
1928
|
|
|
1211
1929
|
No additional properties.
|
|
1212
1930
|
|
|
1213
|
-
##
|
|
1214
|
-
|
|
1215
|
-
Main input configuration with type and inputProps
|
|
1931
|
+
## LayoutMargin
|
|
1216
1932
|
|
|
1217
1933
|
### Fields
|
|
1218
1934
|
|
|
1219
1935
|
| Name | Required | Type | Description |
|
|
1220
1936
|
|---|---:|---|---|
|
|
1221
|
-
| `
|
|
1222
|
-
| `
|
|
1937
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
1938
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
1939
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
1940
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
1223
1941
|
|
|
1224
1942
|
No additional properties.
|
|
1225
1943
|
|
|
1226
|
-
##
|
|
1944
|
+
## LayoutPadding
|
|
1227
1945
|
|
|
1228
|
-
|
|
1946
|
+
### Fields
|
|
1947
|
+
|
|
1948
|
+
| Name | Required | Type | Description |
|
|
1949
|
+
|---|---:|---|---|
|
|
1950
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
1951
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
1952
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
1953
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
1954
|
+
|
|
1955
|
+
No additional properties.
|
|
1956
|
+
|
|
1957
|
+
## LayoutRadiu
|
|
1229
1958
|
|
|
1230
1959
|
### Fields
|
|
1231
1960
|
|
|
1232
|
-
|
|
1961
|
+
| Name | Required | Type | Description |
|
|
1962
|
+
|---|---:|---|---|
|
|
1963
|
+
| `bottomLeft` | no | [BoxRadius](./definitions.md#boxradius) | Bottom-left corner radius token |
|
|
1964
|
+
| `bottomRight` | no | [BoxRadius](./definitions.md#boxradius) | Bottom-right corner radius token |
|
|
1965
|
+
| `topLeft` | no | [BoxRadius](./definitions.md#boxradius) | Top-left corner radius token |
|
|
1966
|
+
| `topRight` | no | [BoxRadius](./definitions.md#boxradius) | Top-right corner radius token |
|
|
1233
1967
|
|
|
1234
|
-
|
|
1968
|
+
No additional properties.
|
|
1235
1969
|
|
|
1236
1970
|
## LayoutValue
|
|
1237
1971
|
|
|
@@ -1247,8 +1981,10 @@ Additional properties: unknown.
|
|
|
1247
1981
|
| `minHeight` | no | number | Minimum height in grid units |
|
|
1248
1982
|
| `minWidth` | no | number | Minimum width in grid units |
|
|
1249
1983
|
| `shadow` | no | [LayoutValueShadow](./definitions.md#layoutvalueshadow) | Shadow token applied to the block wrapper, e.g. "shadowSm". |
|
|
1250
|
-
| `shapeCorner` | no | [
|
|
1984
|
+
| `shapeCorner` | no | [BoxRadius](./definitions.md#boxradius) | Shape-corner radius token for this block, e.g. "shapeCornerMd". Overrides the parent board `blockShapeCorner` for this entry only. |
|
|
1251
1985
|
| `width` | no | number | Width in grid units (1–12). Default: 3 |
|
|
1986
|
+
| `x` | no | number | Horizontal position in grid units. Auto-calculated when omitted. |
|
|
1987
|
+
| `y` | no | number | Vertical position in grid units. Auto-calculated when omitted. |
|
|
1252
1988
|
|
|
1253
1989
|
No additional properties.
|
|
1254
1990
|
|
|
@@ -1293,6 +2029,17 @@ No additional properties.
|
|
|
1293
2029
|
|
|
1294
2030
|
No additional properties.
|
|
1295
2031
|
|
|
2032
|
+
## LocationCardTo
|
|
2033
|
+
|
|
2034
|
+
### Fields
|
|
2035
|
+
|
|
2036
|
+
| Name | Required | Type | Description |
|
|
2037
|
+
|---|---:|---|---|
|
|
2038
|
+
| `openInNewTab` | no | boolean | |
|
|
2039
|
+
| `path` | yes | string | |
|
|
2040
|
+
|
|
2041
|
+
No additional properties.
|
|
2042
|
+
|
|
1296
2043
|
## MaskerArg
|
|
1297
2044
|
|
|
1298
2045
|
### Fields
|
|
@@ -1435,7 +2182,82 @@ No additional properties.
|
|
|
1435
2182
|
| `iconType` | yes | string | Icon type name (e.g., "EDIT_OUTLINE", "DELETE") |
|
|
1436
2183
|
| `id` | yes | string | Unique identifier for this action. Written to state on click |
|
|
1437
2184
|
| `isDisabled` | no | boolean | Disable the action button. Default: false |
|
|
1438
|
-
| `tip` | no |
|
|
2185
|
+
| `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip for the action button. Can be a simple string or tooltip configuration object |
|
|
2186
|
+
|
|
2187
|
+
No additional properties.
|
|
2188
|
+
|
|
2189
|
+
## ObjectUIStatsLeftIcon
|
|
2190
|
+
|
|
2191
|
+
### Fields
|
|
2192
|
+
|
|
2193
|
+
| Name | Required | Type | Description |
|
|
2194
|
+
|---|---:|---|---|
|
|
2195
|
+
| `aria-describedby` | no | string | ID of element that describes this icon |
|
|
2196
|
+
| `aria-label` | no | string | Accessible label for screen readers |
|
|
2197
|
+
| `aria-labelledby` | no | string | ID of element that labels this icon |
|
|
2198
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
|
|
2199
|
+
| `type` | yes | string | Icon type name |
|
|
2200
|
+
|
|
2201
|
+
No additional properties.
|
|
2202
|
+
|
|
2203
|
+
## ObjectUIStatsList
|
|
2204
|
+
|
|
2205
|
+
### Fields
|
|
2206
|
+
|
|
2207
|
+
| Name | Required | Type | Description |
|
|
2208
|
+
|---|---:|---|---|
|
|
2209
|
+
| `label` | yes | string \| number | Label displayed in the cell header. String or number value |
|
|
2210
|
+
| `props` | yes | [ObjectUIStatsProp](./types.md#objectuistatsprop) | Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens. |
|
|
2211
|
+
| `renderer` | yes | "LABEL" | Renderer type for the cell value. LABEL renders a Label component. |
|
|
2212
|
+
| `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
|
|
2213
|
+
|
|
2214
|
+
No additional properties.
|
|
2215
|
+
|
|
2216
|
+
## ObjectUIStatsProp
|
|
2217
|
+
|
|
2218
|
+
Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
|
|
2219
|
+
|
|
2220
|
+
### Fields
|
|
2221
|
+
|
|
2222
|
+
| Name | Required | Type | Description |
|
|
2223
|
+
|---|---:|---|---|
|
|
2224
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Color scheme of the label. Default: NEUTRAL |
|
|
2225
|
+
| `children` | no | string | Text content of the label |
|
|
2226
|
+
| `leftIcon` | no | string \| [ObjectUIStatsLeftIcon](./types.md#objectuistatslefticon) | Icon displayed on the left side of the label |
|
|
2227
|
+
| `maxWidth` | no | string | Maximum width CSS value for truncation |
|
|
2228
|
+
| `rightIcon` | no | string \| [ObjectUIStatsRightIcon](./types.md#objectuistatsrighticon) | Icon displayed on the right side of the label |
|
|
2229
|
+
| `size` | no | [LabelSize](./definitions.md#labelsize) | Size of the label. Default: LARGE |
|
|
2230
|
+
| `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
|
|
2231
|
+
| `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
|
|
2232
|
+
|
|
2233
|
+
No additional properties.
|
|
2234
|
+
|
|
2235
|
+
## ObjectUIStatsRightIcon
|
|
2236
|
+
|
|
2237
|
+
### Fields
|
|
2238
|
+
|
|
2239
|
+
| Name | Required | Type | Description |
|
|
2240
|
+
|---|---:|---|---|
|
|
2241
|
+
| `aria-describedby` | no | string | ID of element that describes this icon |
|
|
2242
|
+
| `aria-label` | no | string | Accessible label for screen readers |
|
|
2243
|
+
| `aria-labelledby` | no | string | ID of element that labels this icon |
|
|
2244
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
|
|
2245
|
+
| `type` | yes | string | Icon type name |
|
|
2246
|
+
|
|
2247
|
+
No additional properties.
|
|
2248
|
+
|
|
2249
|
+
## ObjectUIStatsTip
|
|
2250
|
+
|
|
2251
|
+
### Fields
|
|
2252
|
+
|
|
2253
|
+
| Name | Required | Type | Description |
|
|
2254
|
+
|---|---:|---|---|
|
|
2255
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style |
|
|
2256
|
+
| `content` | yes | string | Tooltip content text |
|
|
2257
|
+
| `isVisible` | no | boolean | Force tooltip to always be visible |
|
|
2258
|
+
| `maxHeight` | no | number \| string | Maximum height for tooltip |
|
|
2259
|
+
| `maxWidth` | no | number \| string | Maximum width for tooltip |
|
|
2260
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement position |
|
|
1439
2261
|
|
|
1440
2262
|
No additional properties.
|
|
1441
2263
|
|
|
@@ -1462,7 +2284,7 @@ No additional properties.
|
|
|
1462
2284
|
|
|
1463
2285
|
| Name | Required | Type | Description |
|
|
1464
2286
|
|---|---:|---|---|
|
|
1465
|
-
| `id` | yes |
|
|
2287
|
+
| `id` | yes | string \| number | Unique identifier for the item |
|
|
1466
2288
|
| `label` | yes | string | Display text for the item |
|
|
1467
2289
|
|
|
1468
2290
|
No additional properties.
|
|
@@ -1619,12 +2441,23 @@ No additional properties.
|
|
|
1619
2441
|
| `isDisabled` | no | boolean | Disables this specific option |
|
|
1620
2442
|
| `label` | yes | string | Display text for the option |
|
|
1621
2443
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
1622
|
-
| `tag` | no |
|
|
2444
|
+
| `tag` | no | string \| [RadioTag](./types.md#radiotag) | Optional tag/label displayed with the option |
|
|
1623
2445
|
| `tip` | no | string | Tooltip text shown on hover |
|
|
1624
2446
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
1625
2447
|
|
|
1626
2448
|
No additional properties.
|
|
1627
2449
|
|
|
2450
|
+
## RadioTag
|
|
2451
|
+
|
|
2452
|
+
### Fields
|
|
2453
|
+
|
|
2454
|
+
| Name | Required | Type | Description |
|
|
2455
|
+
|---|---:|---|---|
|
|
2456
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
|
|
2457
|
+
| `label` | yes | string | Tag label text |
|
|
2458
|
+
|
|
2459
|
+
No additional properties.
|
|
2460
|
+
|
|
1628
2461
|
## RangeSliderArg
|
|
1629
2462
|
|
|
1630
2463
|
### Fields
|
|
@@ -1706,7 +2539,7 @@ Additional properties: string | number | boolean | null.
|
|
|
1706
2539
|
|
|
1707
2540
|
| Name | Required | Type | Description |
|
|
1708
2541
|
|---|---:|---|---|
|
|
1709
|
-
| `segmentColor` | yes |
|
|
2542
|
+
| `segmentColor` | yes | [SegmentSegmentColor](./definitions.md#segmentsegmentcolor) \| [SegmentSegmentColor](./definitions.md#segmentsegmentcolor) | Pebble chart color token, or semantic color token for status-related visualizations. |
|
|
1710
2543
|
| `value` | yes | number | Numeric value of this segment |
|
|
1711
2544
|
|
|
1712
2545
|
No additional properties.
|
|
@@ -1845,6 +2678,18 @@ No additional properties.
|
|
|
1845
2678
|
|
|
1846
2679
|
No additional properties.
|
|
1847
2680
|
|
|
2681
|
+
## SelectEmptyListPlaceholder
|
|
2682
|
+
|
|
2683
|
+
### Fields
|
|
2684
|
+
|
|
2685
|
+
| Name | Required | Type | Description |
|
|
2686
|
+
|---|---:|---|---|
|
|
2687
|
+
| `onLoading` | no | string | Placeholder shown while list is loading |
|
|
2688
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query entered |
|
|
2689
|
+
| `onNoSearchResults` | no | string | Placeholder when search returns no results |
|
|
2690
|
+
|
|
2691
|
+
No additional properties.
|
|
2692
|
+
|
|
1848
2693
|
## SelectFooter
|
|
1849
2694
|
|
|
1850
2695
|
Fixed footer at bottom of dropdown menu
|
|
@@ -1891,6 +2736,16 @@ Additional properties: unknown.
|
|
|
1891
2736
|
|
|
1892
2737
|
No additional properties.
|
|
1893
2738
|
|
|
2739
|
+
## ShouldShowHeader
|
|
2740
|
+
|
|
2741
|
+
### Fields
|
|
2742
|
+
|
|
2743
|
+
| Name | Required | Type | Description |
|
|
2744
|
+
|---|---:|---|---|
|
|
2745
|
+
| `headerActions` | yes | boolean | Show month/year navigation |
|
|
2746
|
+
|
|
2747
|
+
No additional properties.
|
|
2748
|
+
|
|
1894
2749
|
## ShowMoreValue
|
|
1895
2750
|
|
|
1896
2751
|
Configuration for show more behavior
|
|
@@ -1999,6 +2854,17 @@ _No fields._
|
|
|
1999
2854
|
|
|
2000
2855
|
Additional properties: string.
|
|
2001
2856
|
|
|
2857
|
+
## Src
|
|
2858
|
+
|
|
2859
|
+
### Fields
|
|
2860
|
+
|
|
2861
|
+
| Name | Required | Type | Description |
|
|
2862
|
+
|---|---:|---|---|
|
|
2863
|
+
| `dark` | no | string | |
|
|
2864
|
+
| `light` | no | string | |
|
|
2865
|
+
|
|
2866
|
+
No additional properties.
|
|
2867
|
+
|
|
2002
2868
|
## SsnArg
|
|
2003
2869
|
|
|
2004
2870
|
### Fields
|
|
@@ -2025,7 +2891,7 @@ No additional properties.
|
|
|
2025
2891
|
|
|
2026
2892
|
| Name | Required | Type | Description |
|
|
2027
2893
|
|---|---:|---|---|
|
|
2028
|
-
| `avatar` | no | [
|
|
2894
|
+
| `avatar` | no | [StepperAvatar](./types.md#stepperavatar) | Avatar configuration to display with the step. Supports image URLs |
|
|
2029
2895
|
| `badge` | no | [StepperBadge](./types.md#stepperbadge) | Badge configuration to display alongside the step title |
|
|
2030
2896
|
| `description` | no | string | Optional step description |
|
|
2031
2897
|
| `href` | no | string | URL for the step. Renders the step as an anchor tag with this href (semantic HTML only) |
|
|
@@ -2034,6 +2900,19 @@ No additional properties.
|
|
|
2034
2900
|
|
|
2035
2901
|
No additional properties.
|
|
2036
2902
|
|
|
2903
|
+
## StepperAvatar
|
|
2904
|
+
|
|
2905
|
+
Avatar configuration to display with the step. Supports image URLs
|
|
2906
|
+
|
|
2907
|
+
### Fields
|
|
2908
|
+
|
|
2909
|
+
| Name | Required | Type | Description |
|
|
2910
|
+
|---|---:|---|---|
|
|
2911
|
+
| `imageUrl` | no | string | URL of the avatar image |
|
|
2912
|
+
| `type` | no | [StepperAvatarType](./definitions.md#stepperavatartype) | Avatar type |
|
|
2913
|
+
|
|
2914
|
+
No additional properties.
|
|
2915
|
+
|
|
2037
2916
|
## StepperBadge
|
|
2038
2917
|
|
|
2039
2918
|
Badge configuration to display alongside the step title
|
|
@@ -2054,7 +2933,7 @@ No additional properties.
|
|
|
2054
2933
|
|
|
2055
2934
|
| Name | Required | Type | Description |
|
|
2056
2935
|
|---|---:|---|---|
|
|
2057
|
-
| `avatar` | no | [
|
|
2936
|
+
| `avatar` | no | [StepperAvatar](./types.md#stepperavatar) | Avatar configuration to display with the step. Supports image URLs |
|
|
2058
2937
|
| `badge` | no | [StepperBadge](./types.md#stepperbadge) | Badge configuration to display alongside the step title |
|
|
2059
2938
|
| `description` | no | string | Optional step description |
|
|
2060
2939
|
| `href` | no | string | URL for the step. Renders the step as an anchor tag with this href (semantic HTML only) |
|
|
@@ -2079,6 +2958,17 @@ Configuration for the form submit button
|
|
|
2079
2958
|
|
|
2080
2959
|
No additional properties.
|
|
2081
2960
|
|
|
2961
|
+
## SupportButtonTo
|
|
2962
|
+
|
|
2963
|
+
### Fields
|
|
2964
|
+
|
|
2965
|
+
| Name | Required | Type | Description |
|
|
2966
|
+
|---|---:|---|---|
|
|
2967
|
+
| `openInNewTab` | no | boolean | Open link in new tab. Default: false |
|
|
2968
|
+
| `path` | yes | string | URL path for navigation |
|
|
2969
|
+
|
|
2970
|
+
No additional properties.
|
|
2971
|
+
|
|
2082
2972
|
## SurveyArg
|
|
2083
2973
|
|
|
2084
2974
|
### Fields
|
|
@@ -2106,9 +2996,9 @@ No additional properties.
|
|
|
2106
2996
|
| Name | Required | Type | Description |
|
|
2107
2997
|
|---|---:|---|---|
|
|
2108
2998
|
| `isDisabled` | no | boolean | Disable this specific option |
|
|
2109
|
-
| `label` | no |
|
|
2999
|
+
| `label` | no | string \| number | Display label for the option |
|
|
2110
3000
|
| `selectionColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Override selected surface color token for this option |
|
|
2111
|
-
| `value` | yes |
|
|
3001
|
+
| `value` | yes | string \| number | Value when selected |
|
|
2112
3002
|
|
|
2113
3003
|
No additional properties.
|
|
2114
3004
|
|
|
@@ -2168,11 +3058,22 @@ No additional properties.
|
|
|
2168
3058
|
| `disabled` | no | boolean | Whether this tab is disabled |
|
|
2169
3059
|
| `icon` | no | string | Icon name for the tab (e.g., FOLDER_OUTLINE) |
|
|
2170
3060
|
| `label` | yes | string | Display text for the tab |
|
|
2171
|
-
| `tip` | no |
|
|
3061
|
+
| `tip` | no | string \| [TabTip](./types.md#tabtip) | Tooltip to show on hover |
|
|
2172
3062
|
| `value` | yes | unknown | Value for this tab option |
|
|
2173
3063
|
|
|
2174
3064
|
No additional properties.
|
|
2175
3065
|
|
|
3066
|
+
## TabTip
|
|
3067
|
+
|
|
3068
|
+
### Fields
|
|
3069
|
+
|
|
3070
|
+
| Name | Required | Type | Description |
|
|
3071
|
+
|---|---:|---|---|
|
|
3072
|
+
| `content` | yes | string | Tip content text |
|
|
3073
|
+
| `testId` | no | string | Test ID for the tip |
|
|
3074
|
+
|
|
3075
|
+
No additional properties.
|
|
3076
|
+
|
|
2176
3077
|
## TextareaArg
|
|
2177
3078
|
|
|
2178
3079
|
### Fields
|
|
@@ -2234,7 +3135,7 @@ No additional properties.
|
|
|
2234
3135
|
| Name | Required | Type | Description |
|
|
2235
3136
|
|---|---:|---|---|
|
|
2236
3137
|
| `label` | yes | string | Display text for the suggestion |
|
|
2237
|
-
| `value` | yes |
|
|
3138
|
+
| `value` | yes | string \| number | Value stored when suggestion is selected |
|
|
2238
3139
|
|
|
2239
3140
|
No additional properties.
|
|
2240
3141
|
|
|
@@ -2353,7 +3254,7 @@ Toggle icon configuration
|
|
|
2353
3254
|
| Name | Required | Type | Description |
|
|
2354
3255
|
|---|---:|---|---|
|
|
2355
3256
|
| `align` | no | string | CSS alignSelf value. Default: center |
|
|
2356
|
-
| `margin` | no | [
|
|
3257
|
+
| `margin` | no | [BoxGap](./definitions.md#boxgap) | Margin spacing token for icon alignment |
|
|
2357
3258
|
| `size` | no | [IconSize](./definitions.md#iconsize) | Icon size token. Default: 24 |
|
|
2358
3259
|
|
|
2359
3260
|
No additional properties.
|
|
@@ -2378,6 +3279,19 @@ Additional properties: unknown.
|
|
|
2378
3279
|
|
|
2379
3280
|
No additional properties.
|
|
2380
3281
|
|
|
3282
|
+
## TreeDisabledInfo
|
|
3283
|
+
|
|
3284
|
+
### Fields
|
|
3285
|
+
|
|
3286
|
+
| Name | Required | Type | Description |
|
|
3287
|
+
|---|---:|---|---|
|
|
3288
|
+
| `content` | yes | string | Tooltip content text |
|
|
3289
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices |
|
|
3290
|
+
| `maxHeight` | no | number \| string | Maximum tooltip height |
|
|
3291
|
+
| `maxWidth` | no | number \| string | Maximum tooltip width |
|
|
3292
|
+
|
|
3293
|
+
No additional properties.
|
|
3294
|
+
|
|
2381
3295
|
## TreeFooter
|
|
2382
3296
|
|
|
2383
3297
|
Fixed footer with clickable action at bottom of tree
|
|
@@ -2406,12 +3320,12 @@ Additional properties: unknown.
|
|
|
2406
3320
|
|
|
2407
3321
|
| Name | Required | Type | Description |
|
|
2408
3322
|
|---|---:|---|---|
|
|
2409
|
-
| `disabledInfo` | no |
|
|
3323
|
+
| `disabledInfo` | no | string \| [TreeDisabledInfo](./types.md#treedisabledinfo) | Tooltip shown when item is disabled |
|
|
2410
3324
|
| `isDisabled` | no | boolean | Disable this item |
|
|
2411
3325
|
| `label` | yes | string | Display label for the item |
|
|
2412
3326
|
| `parent` | no | string | Parent item value, null for root items |
|
|
2413
3327
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
2414
|
-
| `tag` | no |
|
|
3328
|
+
| `tag` | no | string \| [TreeTag](./types.md#treetag) | Chip/tag to display next to the label |
|
|
2415
3329
|
| `value` | yes | string | Unique identifier for the item |
|
|
2416
3330
|
|
|
2417
3331
|
No additional properties.
|
|
@@ -2460,6 +3374,17 @@ Additional properties: unknown.
|
|
|
2460
3374
|
|
|
2461
3375
|
No additional properties.
|
|
2462
3376
|
|
|
3377
|
+
## TreeTag
|
|
3378
|
+
|
|
3379
|
+
### Fields
|
|
3380
|
+
|
|
3381
|
+
| Name | Required | Type | Description |
|
|
3382
|
+
|---|---:|---|---|
|
|
3383
|
+
| `appearance` | no | string | Label appearance (e.g., "primary", "error", "success") |
|
|
3384
|
+
| `text` | yes | string | Tag text to display |
|
|
3385
|
+
|
|
3386
|
+
No additional properties.
|
|
3387
|
+
|
|
2463
3388
|
## User_cache
|
|
2464
3389
|
|
|
2465
3390
|
User cache data with smallPhoto fallback
|
|
@@ -2486,6 +3411,32 @@ Vertical size constraints for mobile stacked layout. Object with optional defaul
|
|
|
2486
3411
|
|
|
2487
3412
|
No additional properties.
|
|
2488
3413
|
|
|
3414
|
+
## VStackMargin
|
|
3415
|
+
|
|
3416
|
+
### Fields
|
|
3417
|
+
|
|
3418
|
+
| Name | Required | Type | Description |
|
|
3419
|
+
|---|---:|---|---|
|
|
3420
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
3421
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
3422
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
3423
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
3424
|
+
|
|
3425
|
+
No additional properties.
|
|
3426
|
+
|
|
3427
|
+
## VStackPadding
|
|
3428
|
+
|
|
3429
|
+
### Fields
|
|
3430
|
+
|
|
3431
|
+
| Name | Required | Type | Description |
|
|
3432
|
+
|---|---:|---|---|
|
|
3433
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
3434
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
3435
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
3436
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
3437
|
+
|
|
3438
|
+
No additional properties.
|
|
3439
|
+
|
|
2489
3440
|
## WorkEmailArg
|
|
2490
3441
|
|
|
2491
3442
|
### Fields
|