@rippling/pebble-sdui-web 0.6.2 → 0.7.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/2020-C_v5qH0D.cjs +9 -0
- package/dist/2020-C_v5qH0D.cjs.map +1 -0
- package/dist/2020-PBERvPzO.js +4846 -0
- package/dist/2020-PBERvPzO.js.map +1 -0
- 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 +628 -203
- package/dist/catalogs/custom-apps/index.cjs +3 -10
- 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 +458 -5291
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/catalogs/hub_platform/action-params.d.ts +5 -0
- package/dist/catalogs/hub_platform/actions.d.ts +5 -0
- package/dist/catalogs/hub_platform/catalog.d.ts +33 -0
- package/dist/catalogs/hub_platform/component-events.d.ts +10 -0
- package/dist/catalogs/hub_platform/component-props.d.ts +287 -0
- package/dist/catalogs/hub_platform/components.d.ts +11 -0
- package/dist/catalogs/hub_platform/function-params.d.ts +5 -0
- package/dist/catalogs/hub_platform/functions.d.ts +5 -0
- package/dist/catalogs/hub_platform/index.cjs +2 -0
- package/dist/catalogs/hub_platform/index.cjs.map +1 -0
- package/dist/catalogs/hub_platform/index.d.ts +11 -0
- package/dist/catalogs/hub_platform/index.js +1087 -0
- package/dist/catalogs/hub_platform/index.js.map +1 -0
- package/dist/catalogs/hub_platform/render.d.ts +20 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/actions.md +15 -21
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +879 -879
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +656 -150
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +2 -2
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +1045 -142
- package/dist/docs/typescript/web/catalogs/hub_platform/actions.md +6 -0
- package/dist/docs/typescript/web/catalogs/hub_platform/components.md +212 -0
- package/dist/docs/typescript/web/catalogs/hub_platform/computed-functions.md +6 -0
- package/dist/docs/typescript/web/catalogs/hub_platform/definitions.md +91 -0
- package/dist/docs/typescript/web/catalogs/hub_platform/readme.md +16 -0
- package/dist/docs/typescript/web/catalogs/hub_platform/types.md +368 -0
- package/package.json +6 -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
|
|
@@ -91,7 +183,7 @@ Additional properties: unknown.
|
|
|
91
183
|
|
|
92
184
|
No additional properties.
|
|
93
185
|
|
|
94
|
-
##
|
|
186
|
+
## AppNavBarNavItemBadge
|
|
95
187
|
|
|
96
188
|
Badge shown next to the nav item title
|
|
97
189
|
|
|
@@ -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,26 +436,20 @@ 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
|
|
|
230
|
-
##
|
|
445
|
+
## CheckboxGroupTag
|
|
231
446
|
|
|
232
447
|
### Fields
|
|
233
448
|
|
|
234
449
|
| Name | Required | Type | Description |
|
|
235
450
|
|---|---:|---|---|
|
|
236
|
-
| `
|
|
237
|
-
| `
|
|
238
|
-
| `isChecked` | yes | boolean | Whether this item is checked |
|
|
239
|
-
| `isDefaultOpen` | no | boolean | If true, nested items are expanded by default |
|
|
240
|
-
| `isDisabled` | no | boolean | Disables interaction for this item |
|
|
241
|
-
| `label` | yes | string | Display text for this item |
|
|
242
|
-
| `showMoreSize` | no | number | Number of child items shown before "show more" toggle |
|
|
243
|
-
| `value` | yes | string | Unique identifier for this item |
|
|
451
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
|
|
452
|
+
| `label` | yes | string | Tag label text |
|
|
244
453
|
|
|
245
454
|
No additional properties.
|
|
246
455
|
|
|
@@ -257,6 +466,30 @@ Per-item input type overrides
|
|
|
257
466
|
|
|
258
467
|
No additional properties.
|
|
259
468
|
|
|
469
|
+
## ChipAvatar
|
|
470
|
+
|
|
471
|
+
### Fields
|
|
472
|
+
|
|
473
|
+
| Name | Required | Type | Description |
|
|
474
|
+
|---|---:|---|---|
|
|
475
|
+
| `image` | no | string | Avatar image URL |
|
|
476
|
+
| `imageProps` | no | [ImageProp](./types.md#imageprop) | |
|
|
477
|
+
| `title` | no | string | Title for generating initials when no image |
|
|
478
|
+
|
|
479
|
+
No additional properties.
|
|
480
|
+
|
|
481
|
+
## ChipIcon
|
|
482
|
+
|
|
483
|
+
### Fields
|
|
484
|
+
|
|
485
|
+
| Name | Required | Type | Description |
|
|
486
|
+
|---|---:|---|---|
|
|
487
|
+
| `alignment` | no | [ChipIconAlignment](./definitions.md#chipiconalignment) | Icon position relative to text. Default: Left |
|
|
488
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
489
|
+
| `type` | yes | string | Icon type name (e.g., "CHECK", "USERS_OUTLINE") |
|
|
490
|
+
|
|
491
|
+
No additional properties.
|
|
492
|
+
|
|
260
493
|
## ChipTip
|
|
261
494
|
|
|
262
495
|
Tooltip configuration. Chip has default overflow tooltip behavior
|
|
@@ -268,9 +501,20 @@ Tooltip configuration. Chip has default overflow tooltip behavior
|
|
|
268
501
|
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance (LIGHT, DARK). Default: LIGHT |
|
|
269
502
|
| `content` | yes | string | Tooltip content text |
|
|
270
503
|
| `isVisible` | no | boolean | Control tooltip visibility from parent |
|
|
271
|
-
| `maxHeight` | no |
|
|
272
|
-
| `maxWidth` | no |
|
|
273
|
-
| `placement` | no | [
|
|
504
|
+
| `maxHeight` | no | number \| string | Tooltip max height (number in px or CSS string) |
|
|
505
|
+
| `maxWidth` | no | number \| string | Tooltip max width (number in px or CSS string) |
|
|
506
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to chip. Default: TOP_START |
|
|
507
|
+
|
|
508
|
+
No additional properties.
|
|
509
|
+
|
|
510
|
+
## ChipTo
|
|
511
|
+
|
|
512
|
+
### Fields
|
|
513
|
+
|
|
514
|
+
| Name | Required | Type | Description |
|
|
515
|
+
|---|---:|---|---|
|
|
516
|
+
| `openInNewTab` | no | boolean | Open link in new tab |
|
|
517
|
+
| `path` | yes | string | Navigation path or URL |
|
|
274
518
|
|
|
275
519
|
No additional properties.
|
|
276
520
|
|
|
@@ -282,7 +526,7 @@ Configure when each priority level auto-collapses based on container width. Keys
|
|
|
282
526
|
|
|
283
527
|
_No fields._
|
|
284
528
|
|
|
285
|
-
Additional properties:
|
|
529
|
+
Additional properties: [ResponsiveAbove](./definitions.md#responsiveabove) | false.
|
|
286
530
|
|
|
287
531
|
## ColorPickerArg
|
|
288
532
|
|
|
@@ -313,11 +557,24 @@ No additional properties.
|
|
|
313
557
|
| `align` | no | [HeadingAlign](./definitions.md#headingalign) | Text alignment for this column |
|
|
314
558
|
| `header` | yes | string | Column header text |
|
|
315
559
|
| `key` | yes | string | Key to look up cell value in each row object |
|
|
316
|
-
| `width` | no |
|
|
560
|
+
| `width` | no | number \| string | Column width in px (number) or CSS string |
|
|
317
561
|
| `wrapText` | no | boolean | Whether to wrap text in cells of this column. Default: false (nowrap) |
|
|
318
562
|
|
|
319
563
|
No additional properties.
|
|
320
564
|
|
|
565
|
+
## CountryIcon
|
|
566
|
+
|
|
567
|
+
### Fields
|
|
568
|
+
|
|
569
|
+
| Name | Required | Type | Description |
|
|
570
|
+
|---|---:|---|---|
|
|
571
|
+
| `alignment` | no | [CountryIconAlignment](./definitions.md#countryiconalignment) | Alignment of the icon within the container. Use "RIGHT" to push icon to the right. |
|
|
572
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
573
|
+
| `tip` | no | string | Tooltip content shown on icon hover |
|
|
574
|
+
| `type` | yes | string | Icon type name (e.g. "INFO_CIRCLE_OUTLINE") |
|
|
575
|
+
|
|
576
|
+
No additional properties.
|
|
577
|
+
|
|
321
578
|
## CurrencyArg
|
|
322
579
|
|
|
323
580
|
### Fields
|
|
@@ -434,11 +691,21 @@ No additional properties.
|
|
|
434
691
|
|
|
435
692
|
| Name | Required | Type | Description |
|
|
436
693
|
|---|---:|---|---|
|
|
437
|
-
| `id` | yes |
|
|
694
|
+
| `id` | yes | string \| number | Unique identifier for the item |
|
|
438
695
|
| `label` | no | string | Display label for the item |
|
|
439
696
|
|
|
440
697
|
No additional properties.
|
|
441
698
|
|
|
699
|
+
## DropdownDisabledInfo
|
|
700
|
+
|
|
701
|
+
### Fields
|
|
702
|
+
|
|
703
|
+
| Name | Required | Type | Description |
|
|
704
|
+
|---|---:|---|---|
|
|
705
|
+
| `content` | yes | string | |
|
|
706
|
+
|
|
707
|
+
No additional properties.
|
|
708
|
+
|
|
442
709
|
## DropdownList
|
|
443
710
|
|
|
444
711
|
### Fields
|
|
@@ -456,7 +723,7 @@ No additional properties.
|
|
|
456
723
|
|
|
457
724
|
| Name | Required | Type | Description |
|
|
458
725
|
|---|---:|---|---|
|
|
459
|
-
| `disabledInfo` | no |
|
|
726
|
+
| `disabledInfo` | no | string \| [DropdownDisabledInfo](./types.md#dropdowndisabledinfo) | Tooltip content shown when the option is disabled |
|
|
460
727
|
| `isDisabled` | no | boolean | Disables this option |
|
|
461
728
|
| `label` | yes | string | Display text for the option |
|
|
462
729
|
| `labelIcon` | no | string | Icon name to show next to the label |
|
|
@@ -559,6 +826,39 @@ No additional properties.
|
|
|
559
826
|
|
|
560
827
|
No additional properties.
|
|
561
828
|
|
|
829
|
+
## FloatingButtonIcon
|
|
830
|
+
|
|
831
|
+
### Fields
|
|
832
|
+
|
|
833
|
+
| Name | Required | Type | Description |
|
|
834
|
+
|---|---:|---|---|
|
|
835
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
836
|
+
| `type` | yes | string | Icon type from Icon.TYPES |
|
|
837
|
+
|
|
838
|
+
No additional properties.
|
|
839
|
+
|
|
840
|
+
## FloatingButtonTip
|
|
841
|
+
|
|
842
|
+
### Fields
|
|
843
|
+
|
|
844
|
+
| Name | Required | Type | Description |
|
|
845
|
+
|---|---:|---|---|
|
|
846
|
+
| `content` | yes | string | Tooltip content text |
|
|
847
|
+
| `placement` | no | string | Tooltip placement (TOP, BOTTOM, LEFT, RIGHT). Default: TOP |
|
|
848
|
+
|
|
849
|
+
No additional properties.
|
|
850
|
+
|
|
851
|
+
## FloatingButtonTo
|
|
852
|
+
|
|
853
|
+
### Fields
|
|
854
|
+
|
|
855
|
+
| Name | Required | Type | Description |
|
|
856
|
+
|---|---:|---|---|
|
|
857
|
+
| `openInNewTab` | no | boolean | Open link in new tab. Default: false |
|
|
858
|
+
| `path` | yes | string | URL path for navigation |
|
|
859
|
+
|
|
860
|
+
No additional properties.
|
|
861
|
+
|
|
562
862
|
## FormCheckboxGroupOption
|
|
563
863
|
|
|
564
864
|
### Fields
|
|
@@ -568,12 +868,23 @@ No additional properties.
|
|
|
568
868
|
| `isDisabled` | no | boolean | Disables this specific checkbox |
|
|
569
869
|
| `label` | yes | string | Display text for the checkbox option |
|
|
570
870
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
571
|
-
| `tag` | no |
|
|
871
|
+
| `tag` | no | string \| [FormCheckboxGroupTag](./types.md#formcheckboxgrouptag) | Optional tag/label displayed with the option |
|
|
572
872
|
| `tip` | no | string | Tooltip text shown on hover |
|
|
573
873
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
574
874
|
|
|
575
875
|
No additional properties.
|
|
576
876
|
|
|
877
|
+
## FormCheckboxGroupTag
|
|
878
|
+
|
|
879
|
+
### Fields
|
|
880
|
+
|
|
881
|
+
| Name | Required | Type | Description |
|
|
882
|
+
|---|---:|---|---|
|
|
883
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
|
|
884
|
+
| `label` | yes | string | Tag label text |
|
|
885
|
+
|
|
886
|
+
No additional properties.
|
|
887
|
+
|
|
577
888
|
## FormCheckboxGroupValidationError
|
|
578
889
|
|
|
579
890
|
Map of rule name to error message
|
|
@@ -785,25 +1096,47 @@ _No fields._
|
|
|
785
1096
|
|
|
786
1097
|
Additional properties: unknown.
|
|
787
1098
|
|
|
788
|
-
##
|
|
789
|
-
|
|
790
|
-
Map of rule name to error message
|
|
1099
|
+
## FormInputGroupPrefix
|
|
791
1100
|
|
|
792
1101
|
### Fields
|
|
793
1102
|
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
1103
|
+
| Name | Required | Type | Description |
|
|
1104
|
+
|---|---:|---|---|
|
|
1105
|
+
| `inputProps` | yes | [FormInputGroupInputProp](./types.md#forminputgroupinputprop) | Props to pass to the input component |
|
|
1106
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
797
1107
|
|
|
798
|
-
|
|
1108
|
+
No additional properties.
|
|
799
1109
|
|
|
800
|
-
|
|
1110
|
+
## FormInputGroupSuffix
|
|
801
1111
|
|
|
802
1112
|
### Fields
|
|
803
1113
|
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
1114
|
+
| Name | Required | Type | Description |
|
|
1115
|
+
|---|---:|---|---|
|
|
1116
|
+
| `inputProps` | yes | [FormInputGroupInputProp](./types.md#forminputgroupinputprop) | Props to pass to the input component |
|
|
1117
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
1118
|
+
|
|
1119
|
+
No additional properties.
|
|
1120
|
+
|
|
1121
|
+
## FormInputGroupValidationError
|
|
1122
|
+
|
|
1123
|
+
Map of rule name to error message
|
|
1124
|
+
|
|
1125
|
+
### Fields
|
|
1126
|
+
|
|
1127
|
+
_No fields._
|
|
1128
|
+
|
|
1129
|
+
Additional properties: string.
|
|
1130
|
+
|
|
1131
|
+
## FormMaskerValidationError
|
|
1132
|
+
|
|
1133
|
+
Map of rule name to error message
|
|
1134
|
+
|
|
1135
|
+
### Fields
|
|
1136
|
+
|
|
1137
|
+
_No fields._
|
|
1138
|
+
|
|
1139
|
+
Additional properties: string.
|
|
807
1140
|
|
|
808
1141
|
## FormNumberValidationError
|
|
809
1142
|
|
|
@@ -855,12 +1188,23 @@ Additional properties: string.
|
|
|
855
1188
|
| `isDisabled` | no | boolean | Disables this specific option |
|
|
856
1189
|
| `label` | yes | string | Display text for the option |
|
|
857
1190
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
858
|
-
| `tag` | no |
|
|
1191
|
+
| `tag` | no | string \| [FormRadioTag](./types.md#formradiotag) | Optional tag/label displayed with the option |
|
|
859
1192
|
| `tip` | no | string | Tooltip text shown on hover |
|
|
860
1193
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
861
1194
|
|
|
862
1195
|
No additional properties.
|
|
863
1196
|
|
|
1197
|
+
## FormRadioTag
|
|
1198
|
+
|
|
1199
|
+
### Fields
|
|
1200
|
+
|
|
1201
|
+
| Name | Required | Type | Description |
|
|
1202
|
+
|---|---:|---|---|
|
|
1203
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
|
|
1204
|
+
| `label` | yes | string | Tag label text |
|
|
1205
|
+
|
|
1206
|
+
No additional properties.
|
|
1207
|
+
|
|
864
1208
|
## FormRadioValidationError
|
|
865
1209
|
|
|
866
1210
|
Map of rule name to error message
|
|
@@ -927,6 +1271,42 @@ _No fields._
|
|
|
927
1271
|
|
|
928
1272
|
Additional properties: string.
|
|
929
1273
|
|
|
1274
|
+
## FormSelectAvatarProp
|
|
1275
|
+
|
|
1276
|
+
Avatar configuration for the option
|
|
1277
|
+
|
|
1278
|
+
### Fields
|
|
1279
|
+
|
|
1280
|
+
| Name | Required | Type | Description |
|
|
1281
|
+
|---|---:|---|---|
|
|
1282
|
+
| `image` | no | string | URL of avatar image |
|
|
1283
|
+
| `title` | no | string | Title/alt text for avatar |
|
|
1284
|
+
|
|
1285
|
+
No additional properties.
|
|
1286
|
+
|
|
1287
|
+
## FormSelectOption
|
|
1288
|
+
|
|
1289
|
+
### Fields
|
|
1290
|
+
|
|
1291
|
+
| Name | Required | Type | Description |
|
|
1292
|
+
|---|---:|---|---|
|
|
1293
|
+
| `avatarProps` | no | [FormSelectAvatarProp](./types.md#formselectavatarprop) | Avatar configuration for the option |
|
|
1294
|
+
| `description` | no | string | Description text shown below the label |
|
|
1295
|
+
| `flag` | no | string | Two-letter country code for flag icon (e.g. "US", "IN") |
|
|
1296
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
1297
|
+
| `isRecommended` | no | boolean | Marks option as recommended with a badge |
|
|
1298
|
+
| `isSeparator` | no | boolean | Renders as a visual separator instead of selectable option |
|
|
1299
|
+
| `label` | yes | string | Display text for the option |
|
|
1300
|
+
| `labelIcon` | no | string | Icon glyph name to show next to the label |
|
|
1301
|
+
| `leftIconType` | no | string | Icon glyph name to show on the left. E.g. "CHECK_CIRCLE_OUTLINE" |
|
|
1302
|
+
| `quaternaryLabel` | no | string | Quaternary label shown below tertiary label |
|
|
1303
|
+
| `rightLabel` | no | string | Label aligned to the right side of the option |
|
|
1304
|
+
| `secondaryLabel` | no | string | Secondary label shown below the main label |
|
|
1305
|
+
| `tertiaryLabel` | no | string | Tertiary label shown below secondary label |
|
|
1306
|
+
| `value` | yes | unknown | Value stored when option is selected |
|
|
1307
|
+
|
|
1308
|
+
No additional properties.
|
|
1309
|
+
|
|
930
1310
|
## FormSelectValidationError
|
|
931
1311
|
|
|
932
1312
|
Map of rule name to error message
|
|
@@ -994,9 +1374,9 @@ Additional properties: string.
|
|
|
994
1374
|
| Name | Required | Type | Description |
|
|
995
1375
|
|---|---:|---|---|
|
|
996
1376
|
| `isDisabled` | no | boolean | Disable this specific option |
|
|
997
|
-
| `label` | no |
|
|
1377
|
+
| `label` | no | string \| number | Display label for the option |
|
|
998
1378
|
| `selectionColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Override selected surface color token for this option |
|
|
999
|
-
| `value` | yes |
|
|
1379
|
+
| `value` | yes | string \| number | Value when selected |
|
|
1000
1380
|
|
|
1001
1381
|
No additional properties.
|
|
1002
1382
|
|
|
@@ -1050,7 +1430,7 @@ Additional properties: string.
|
|
|
1050
1430
|
| Name | Required | Type | Description |
|
|
1051
1431
|
|---|---:|---|---|
|
|
1052
1432
|
| `label` | yes | string | Display text for the suggestion |
|
|
1053
|
-
| `value` | yes |
|
|
1433
|
+
| `value` | yes | string \| number | Value stored when suggestion is selected |
|
|
1054
1434
|
|
|
1055
1435
|
No additional properties.
|
|
1056
1436
|
|
|
@@ -1094,35 +1474,332 @@ _No fields._
|
|
|
1094
1474
|
|
|
1095
1475
|
Additional properties: string.
|
|
1096
1476
|
|
|
1477
|
+
## FormTreeDisabledInfo
|
|
1478
|
+
|
|
1479
|
+
### Fields
|
|
1480
|
+
|
|
1481
|
+
| Name | Required | Type | Description |
|
|
1482
|
+
|---|---:|---|---|
|
|
1483
|
+
| `content` | yes | string | Tooltip content text |
|
|
1484
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices |
|
|
1485
|
+
| `maxHeight` | no | number \| string | Maximum tooltip height |
|
|
1486
|
+
| `maxWidth` | no | number \| string | Maximum tooltip width |
|
|
1487
|
+
|
|
1488
|
+
No additional properties.
|
|
1489
|
+
|
|
1097
1490
|
## FormTreeFuseOption
|
|
1098
1491
|
|
|
1099
1492
|
Fuse.js search options for customizing search behavior
|
|
1100
1493
|
|
|
1101
1494
|
### Fields
|
|
1102
1495
|
|
|
1103
|
-
_No fields._
|
|
1496
|
+
_No fields._
|
|
1497
|
+
|
|
1498
|
+
Additional properties: unknown.
|
|
1499
|
+
|
|
1500
|
+
## FormTreeList
|
|
1501
|
+
|
|
1502
|
+
### Fields
|
|
1503
|
+
|
|
1504
|
+
| Name | Required | Type | Description |
|
|
1505
|
+
|---|---:|---|---|
|
|
1506
|
+
| `disabledInfo` | no | string \| [FormTreeDisabledInfo](./types.md#formtreedisabledinfo) | Tooltip shown when item is disabled |
|
|
1507
|
+
| `isDisabled` | no | boolean | Disable this item |
|
|
1508
|
+
| `label` | yes | string | Display label for the item |
|
|
1509
|
+
| `parent` | no | string | Parent item value, null for root items |
|
|
1510
|
+
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
1511
|
+
| `tag` | no | string \| [FormTreeTag](./types.md#formtreetag) | Chip/tag to display next to the label |
|
|
1512
|
+
| `value` | yes | string | Unique identifier for the item |
|
|
1513
|
+
|
|
1514
|
+
No additional properties.
|
|
1515
|
+
|
|
1516
|
+
## FormTreeSelectFuseOption
|
|
1517
|
+
|
|
1518
|
+
Fuse.js search configuration. Default: { keys: ["label", "name"] }
|
|
1519
|
+
|
|
1520
|
+
### Fields
|
|
1521
|
+
|
|
1522
|
+
_No fields._
|
|
1523
|
+
|
|
1524
|
+
Additional properties: unknown.
|
|
1525
|
+
|
|
1526
|
+
## FormTreeSelectList
|
|
1527
|
+
|
|
1528
|
+
### Fields
|
|
1529
|
+
|
|
1530
|
+
| Name | Required | Type | Description |
|
|
1531
|
+
|---|---:|---|---|
|
|
1532
|
+
| `isDisabled` | no | boolean | Disable this item |
|
|
1533
|
+
| `label` | yes | string | Display label for the item |
|
|
1534
|
+
| `parent` | no | string | Parent item value, null for root items |
|
|
1535
|
+
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
1536
|
+
| `value` | yes | string | Unique identifier for the item |
|
|
1537
|
+
|
|
1538
|
+
No additional properties.
|
|
1539
|
+
|
|
1540
|
+
## FormTreeSelectValidationError
|
|
1541
|
+
|
|
1542
|
+
Map of rule name to error message
|
|
1543
|
+
|
|
1544
|
+
### Fields
|
|
1545
|
+
|
|
1546
|
+
_No fields._
|
|
1547
|
+
|
|
1548
|
+
Additional properties: string.
|
|
1549
|
+
|
|
1550
|
+
## FormTreeTag
|
|
1551
|
+
|
|
1552
|
+
### Fields
|
|
1553
|
+
|
|
1554
|
+
| Name | Required | Type | Description |
|
|
1555
|
+
|---|---:|---|---|
|
|
1556
|
+
| `appearance` | no | string | Label appearance (e.g., "primary", "error", "success") |
|
|
1557
|
+
| `text` | yes | string | Tag text to display |
|
|
1558
|
+
|
|
1559
|
+
No additional properties.
|
|
1560
|
+
|
|
1561
|
+
## FormTreeValidationError
|
|
1562
|
+
|
|
1563
|
+
Map of rule name to error message
|
|
1564
|
+
|
|
1565
|
+
### Fields
|
|
1566
|
+
|
|
1567
|
+
_No fields._
|
|
1568
|
+
|
|
1569
|
+
Additional properties: string.
|
|
1570
|
+
|
|
1571
|
+
## FormValidationError
|
|
1572
|
+
|
|
1573
|
+
External validation errors keyed by input name
|
|
1574
|
+
|
|
1575
|
+
### Fields
|
|
1576
|
+
|
|
1577
|
+
_No fields._
|
|
1578
|
+
|
|
1579
|
+
Additional properties: string.
|
|
1580
|
+
|
|
1581
|
+
## FormValue
|
|
1582
|
+
|
|
1583
|
+
Form values model. Written to state on change/submit (read-only — push-only)
|
|
1584
|
+
|
|
1585
|
+
### Fields
|
|
1586
|
+
|
|
1587
|
+
_No fields._
|
|
1588
|
+
|
|
1589
|
+
Additional properties: unknown.
|
|
1590
|
+
|
|
1591
|
+
## FormWorkEmailValidationError
|
|
1592
|
+
|
|
1593
|
+
Map of rule name to error message
|
|
1594
|
+
|
|
1595
|
+
### Fields
|
|
1596
|
+
|
|
1597
|
+
_No fields._
|
|
1598
|
+
|
|
1599
|
+
Additional properties: string.
|
|
1600
|
+
|
|
1601
|
+
## GridAction
|
|
1602
|
+
|
|
1603
|
+
### Fields
|
|
1604
|
+
|
|
1605
|
+
| Name | Required | Type | Description |
|
|
1606
|
+
|---|---:|---|---|
|
|
1607
|
+
| `aria-label` | no | string | Accessibility label for the action button |
|
|
1608
|
+
| `aria-labelledby` | no | string | ID of element that labels the action button |
|
|
1609
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
1610
|
+
| `iconType` | yes | string | Icon type name (e.g., "EDIT_OUTLINE", "DELETE") |
|
|
1611
|
+
| `id` | yes | string | Unique identifier for this action. Written to state on click |
|
|
1612
|
+
| `isDisabled` | no | boolean | Disable the action button. Default: false |
|
|
1613
|
+
| `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip for the action button. Can be a simple string or tooltip configuration object |
|
|
1614
|
+
|
|
1615
|
+
No additional properties.
|
|
1616
|
+
|
|
1617
|
+
## GridLeftIcon
|
|
1618
|
+
|
|
1619
|
+
### Fields
|
|
1620
|
+
|
|
1621
|
+
| Name | Required | Type | Description |
|
|
1622
|
+
|---|---:|---|---|
|
|
1623
|
+
| `aria-describedby` | no | string | ID of element that describes this icon |
|
|
1624
|
+
| `aria-label` | no | string | Accessible label for screen readers |
|
|
1625
|
+
| `aria-labelledby` | no | string | ID of element that labels this icon |
|
|
1626
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
|
|
1627
|
+
| `type` | yes | string | Icon type name |
|
|
1628
|
+
|
|
1629
|
+
No additional properties.
|
|
1630
|
+
|
|
1631
|
+
## GridList
|
|
1632
|
+
|
|
1633
|
+
### Fields
|
|
1634
|
+
|
|
1635
|
+
| Name | Required | Type | Description |
|
|
1636
|
+
|---|---:|---|---|
|
|
1637
|
+
| `label` | yes | string \| number | Label displayed in the cell header. String or number value |
|
|
1638
|
+
| `props` | yes | [GridProp](./types.md#gridprop) | Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens. |
|
|
1639
|
+
| `renderer` | yes | "LABEL" | Renderer type for the cell value. LABEL renders a Label component. |
|
|
1640
|
+
| `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
|
|
1641
|
+
|
|
1642
|
+
No additional properties.
|
|
1643
|
+
|
|
1644
|
+
## GridProp
|
|
1645
|
+
|
|
1646
|
+
Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
|
|
1647
|
+
|
|
1648
|
+
### Fields
|
|
1649
|
+
|
|
1650
|
+
| Name | Required | Type | Description |
|
|
1651
|
+
|---|---:|---|---|
|
|
1652
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Color scheme of the label. Default: NEUTRAL |
|
|
1653
|
+
| `children` | no | string | Text content of the label |
|
|
1654
|
+
| `leftIcon` | no | string \| [GridLeftIcon](./types.md#gridlefticon) | Icon displayed on the left side of the label |
|
|
1655
|
+
| `maxWidth` | no | string | Maximum width CSS value for truncation |
|
|
1656
|
+
| `rightIcon` | no | string \| [GridRightIcon](./types.md#gridrighticon) | Icon displayed on the right side of the label |
|
|
1657
|
+
| `size` | no | [LabelSize](./definitions.md#labelsize) | Size of the label. Default: LARGE |
|
|
1658
|
+
| `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
|
|
1659
|
+
| `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
|
|
1660
|
+
|
|
1661
|
+
No additional properties.
|
|
1662
|
+
|
|
1663
|
+
## GridRightIcon
|
|
1664
|
+
|
|
1665
|
+
### Fields
|
|
1666
|
+
|
|
1667
|
+
| Name | Required | Type | Description |
|
|
1668
|
+
|---|---:|---|---|
|
|
1669
|
+
| `aria-describedby` | no | string | ID of element that describes this icon |
|
|
1670
|
+
| `aria-label` | no | string | Accessible label for screen readers |
|
|
1671
|
+
| `aria-labelledby` | no | string | ID of element that labels this icon |
|
|
1672
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
|
|
1673
|
+
| `type` | yes | string | Icon type name |
|
|
1674
|
+
|
|
1675
|
+
No additional properties.
|
|
1676
|
+
|
|
1677
|
+
## GridTip
|
|
1678
|
+
|
|
1679
|
+
### Fields
|
|
1680
|
+
|
|
1681
|
+
| Name | Required | Type | Description |
|
|
1682
|
+
|---|---:|---|---|
|
|
1683
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style |
|
|
1684
|
+
| `content` | yes | string | Tooltip content text |
|
|
1685
|
+
| `isVisible` | no | boolean | Force tooltip to always be visible |
|
|
1686
|
+
| `maxHeight` | no | number \| string | Maximum height for tooltip |
|
|
1687
|
+
| `maxWidth` | no | number \| string | Maximum width for tooltip |
|
|
1688
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement position |
|
|
1689
|
+
|
|
1690
|
+
No additional properties.
|
|
1691
|
+
|
|
1692
|
+
## HelperMessage
|
|
1693
|
+
|
|
1694
|
+
### Fields
|
|
1695
|
+
|
|
1696
|
+
| Name | Required | Type | Description |
|
|
1697
|
+
|---|---:|---|---|
|
|
1698
|
+
| `message` | yes | string | Helper or error message text |
|
|
1699
|
+
| `status` | no | string | Message status, e.g. "ERROR" for validation errors |
|
|
1700
|
+
|
|
1701
|
+
No additional properties.
|
|
1702
|
+
|
|
1703
|
+
## HStackMargin
|
|
1704
|
+
|
|
1705
|
+
### Fields
|
|
1706
|
+
|
|
1707
|
+
| Name | Required | Type | Description |
|
|
1708
|
+
|---|---:|---|---|
|
|
1709
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
1710
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
1711
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
1712
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
1713
|
+
|
|
1714
|
+
No additional properties.
|
|
1715
|
+
|
|
1716
|
+
## HStackPadding
|
|
1717
|
+
|
|
1718
|
+
### Fields
|
|
1719
|
+
|
|
1720
|
+
| Name | Required | Type | Description |
|
|
1721
|
+
|---|---:|---|---|
|
|
1722
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
1723
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
1724
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
1725
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
1726
|
+
|
|
1727
|
+
No additional properties.
|
|
1728
|
+
|
|
1729
|
+
## IconButtonIcon
|
|
1730
|
+
|
|
1731
|
+
### Fields
|
|
1732
|
+
|
|
1733
|
+
| Name | Required | Type | Description |
|
|
1734
|
+
|---|---:|---|---|
|
|
1735
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
1736
|
+
| `type` | yes | string | Icon type from Icon.TYPES |
|
|
1737
|
+
|
|
1738
|
+
No additional properties.
|
|
1739
|
+
|
|
1740
|
+
## IconButtonTip
|
|
1741
|
+
|
|
1742
|
+
### Fields
|
|
1743
|
+
|
|
1744
|
+
| Name | Required | Type | Description |
|
|
1745
|
+
|---|---:|---|---|
|
|
1746
|
+
| `content` | yes | string | Tooltip content text |
|
|
1747
|
+
| `placement` | no | string | Tooltip placement (TOP, BOTTOM, LEFT, RIGHT). Default: TOP |
|
|
1748
|
+
|
|
1749
|
+
No additional properties.
|
|
1750
|
+
|
|
1751
|
+
## IconButtonTo
|
|
1752
|
+
|
|
1753
|
+
### Fields
|
|
1754
|
+
|
|
1755
|
+
| Name | Required | Type | Description |
|
|
1756
|
+
|---|---:|---|---|
|
|
1757
|
+
| `openInNewTab` | no | boolean | Open link in new tab. Default: false |
|
|
1758
|
+
| `path` | yes | string | URL path for navigation |
|
|
1759
|
+
|
|
1760
|
+
No additional properties.
|
|
1761
|
+
|
|
1762
|
+
## IconTip
|
|
1763
|
+
|
|
1764
|
+
### Fields
|
|
1765
|
+
|
|
1766
|
+
| Name | Required | Type | Description |
|
|
1767
|
+
|---|---:|---|---|
|
|
1768
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
|
|
1769
|
+
| `content` | yes | string | Tooltip text content |
|
|
1770
|
+
| `maxHeight` | no | number \| string | Max height in px or CSS string |
|
|
1771
|
+
| `maxWidth` | no | number \| string | Max width in px or CSS string |
|
|
1772
|
+
| `placement` | no | [IconTipPlacement](./definitions.md#icontipplacement) | Tooltip placement. Default: BOTTOM |
|
|
1773
|
+
| `title` | no | string | Tooltip title text |
|
|
1774
|
+
|
|
1775
|
+
No additional properties.
|
|
1776
|
+
|
|
1777
|
+
## ImageProp
|
|
1778
|
+
|
|
1779
|
+
### Fields
|
|
1780
|
+
|
|
1781
|
+
| Name | Required | Type | Description |
|
|
1782
|
+
|---|---:|---|---|
|
|
1783
|
+
| `alt` | no | string | Alt text for avatar image |
|
|
1104
1784
|
|
|
1105
|
-
|
|
1785
|
+
No additional properties.
|
|
1106
1786
|
|
|
1107
|
-
##
|
|
1787
|
+
## InputGroupInput
|
|
1788
|
+
|
|
1789
|
+
Main input configuration with type and inputProps
|
|
1108
1790
|
|
|
1109
1791
|
### Fields
|
|
1110
1792
|
|
|
1111
1793
|
| Name | Required | Type | Description |
|
|
1112
1794
|
|---|---:|---|---|
|
|
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 |
|
|
1795
|
+
| `inputProps` | yes | [InputGroupInputProp](./types.md#inputgroupinputprop) | Props to pass to the input component |
|
|
1796
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
1120
1797
|
|
|
1121
1798
|
No additional properties.
|
|
1122
1799
|
|
|
1123
|
-
##
|
|
1800
|
+
## InputGroupInputProp
|
|
1124
1801
|
|
|
1125
|
-
|
|
1802
|
+
Props to pass to the input component
|
|
1126
1803
|
|
|
1127
1804
|
### Fields
|
|
1128
1805
|
|
|
@@ -1130,108 +1807,148 @@ _No fields._
|
|
|
1130
1807
|
|
|
1131
1808
|
Additional properties: unknown.
|
|
1132
1809
|
|
|
1133
|
-
##
|
|
1810
|
+
## InputGroupPrefix
|
|
1134
1811
|
|
|
1135
1812
|
### Fields
|
|
1136
1813
|
|
|
1137
1814
|
| Name | Required | Type | Description |
|
|
1138
1815
|
|---|---:|---|---|
|
|
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 |
|
|
1816
|
+
| `inputProps` | yes | [InputGroupInputProp](./types.md#inputgroupinputprop) | Props to pass to the input component |
|
|
1817
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
1144
1818
|
|
|
1145
1819
|
No additional properties.
|
|
1146
1820
|
|
|
1147
|
-
##
|
|
1148
|
-
|
|
1149
|
-
Map of rule name to error message
|
|
1821
|
+
## InputGroupSuffix
|
|
1150
1822
|
|
|
1151
1823
|
### Fields
|
|
1152
1824
|
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1825
|
+
| Name | Required | Type | Description |
|
|
1826
|
+
|---|---:|---|---|
|
|
1827
|
+
| `inputProps` | yes | [InputGroupInputProp](./types.md#inputgroupinputprop) | Props to pass to the input component |
|
|
1828
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
1156
1829
|
|
|
1157
|
-
|
|
1830
|
+
No additional properties.
|
|
1158
1831
|
|
|
1159
|
-
|
|
1832
|
+
## LabelLeftIcon
|
|
1160
1833
|
|
|
1161
1834
|
### Fields
|
|
1162
1835
|
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1836
|
+
| Name | Required | Type | Description |
|
|
1837
|
+
|---|---:|---|---|
|
|
1838
|
+
| `aria-describedby` | no | string | ID of element that describes this icon |
|
|
1839
|
+
| `aria-label` | no | string | Accessible label for screen readers |
|
|
1840
|
+
| `aria-labelledby` | no | string | ID of element that labels this icon |
|
|
1841
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
|
|
1842
|
+
| `type` | yes | string | Icon type name |
|
|
1166
1843
|
|
|
1167
|
-
|
|
1844
|
+
No additional properties.
|
|
1168
1845
|
|
|
1169
|
-
|
|
1846
|
+
## LabelRightIcon
|
|
1170
1847
|
|
|
1171
1848
|
### Fields
|
|
1172
1849
|
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1850
|
+
| Name | Required | Type | Description |
|
|
1851
|
+
|---|---:|---|---|
|
|
1852
|
+
| `aria-describedby` | no | string | ID of element that describes this icon |
|
|
1853
|
+
| `aria-label` | no | string | Accessible label for screen readers |
|
|
1854
|
+
| `aria-labelledby` | no | string | ID of element that labels this icon |
|
|
1855
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
|
|
1856
|
+
| `type` | yes | string | Icon type name |
|
|
1176
1857
|
|
|
1177
|
-
|
|
1858
|
+
No additional properties.
|
|
1178
1859
|
|
|
1179
|
-
|
|
1860
|
+
## LabelTip
|
|
1180
1861
|
|
|
1181
1862
|
### Fields
|
|
1182
1863
|
|
|
1183
|
-
|
|
1864
|
+
| Name | Required | Type | Description |
|
|
1865
|
+
|---|---:|---|---|
|
|
1866
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style. Default: LIGHT |
|
|
1867
|
+
| `className` | no | string | CSS class name for tooltip |
|
|
1868
|
+
| `content` | yes | string | Tooltip text content |
|
|
1869
|
+
| `hideOnDocumentScroll` | no | boolean | Hide tooltip when document scrolls. Default: false |
|
|
1870
|
+
| `isDelayed` | no | boolean | Add 300ms delay before showing tooltip. Default: false |
|
|
1871
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
|
|
1872
|
+
| `isPositionFixed` | no | boolean | Use fixed positioning (relative to viewport). Default: false |
|
|
1873
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent component |
|
|
1874
|
+
| `maxHeight` | no | number \| string | Maximum height for tooltip content |
|
|
1875
|
+
| `maxWidth` | no | number \| string | Maximum width for tooltip content |
|
|
1876
|
+
| `onlyIfChildOverflow` | no | boolean | Only show tooltip if any child content overflows. Default: false |
|
|
1877
|
+
| `onlyIfOverflow` | no | boolean | Only show tooltip if content overflows. Default: false |
|
|
1878
|
+
| `overwriteMiddleware` | no | boolean | Overwrite default floating-UI middleware. Default: false |
|
|
1879
|
+
| `padding` | no | string | CSS padding value for tooltip content |
|
|
1880
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement relative to label. Default: TOP_START |
|
|
1881
|
+
| `shallSkipOverflowY` | no | boolean | Skip overflow check on Y axis. Default: false |
|
|
1882
|
+
| `tipHideDelay` | no | number | Milliseconds to wait before hiding tooltip (when isDelayed is true) |
|
|
1883
|
+
| `tipShowDelay` | no | number | Milliseconds to wait before showing tooltip (when isDelayed is true) |
|
|
1884
|
+
| `title` | no | string | Tooltip title text |
|
|
1885
|
+
| `truncateClassName` | no | string | CSS class when onlyIfOverflow is enabled |
|
|
1184
1886
|
|
|
1185
|
-
|
|
1887
|
+
No additional properties.
|
|
1186
1888
|
|
|
1187
|
-
##
|
|
1889
|
+
## LayoutBorder
|
|
1188
1890
|
|
|
1189
|
-
|
|
1891
|
+
Structured border using strict token parts
|
|
1190
1892
|
|
|
1191
1893
|
### Fields
|
|
1192
1894
|
|
|
1193
|
-
|
|
1895
|
+
| Name | Required | Type | Description |
|
|
1896
|
+
|---|---:|---|---|
|
|
1897
|
+
| `color` | no | [BoxBorderColor](./definitions.md#boxbordercolor) | Border color token |
|
|
1898
|
+
| `style` | no | [BoxBorderStyle](./definitions.md#boxborderstyle) | CSS border style |
|
|
1899
|
+
| `width` | no | [BoxBorderWidth](./definitions.md#boxborderwidth) | Border width token |
|
|
1194
1900
|
|
|
1195
|
-
|
|
1901
|
+
No additional properties.
|
|
1196
1902
|
|
|
1197
|
-
##
|
|
1903
|
+
## LayoutGap
|
|
1198
1904
|
|
|
1199
1905
|
### Fields
|
|
1200
1906
|
|
|
1201
1907
|
| Name | Required | Type | Description |
|
|
1202
1908
|
|---|---:|---|---|
|
|
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 |
|
|
1909
|
+
| `column` | no | [BoxGap](./definitions.md#boxgap) | Column gap spacing token |
|
|
1910
|
+
| `row` | no | [BoxGap](./definitions.md#boxgap) | Row gap spacing token |
|
|
1210
1911
|
|
|
1211
1912
|
No additional properties.
|
|
1212
1913
|
|
|
1213
|
-
##
|
|
1214
|
-
|
|
1215
|
-
Main input configuration with type and inputProps
|
|
1914
|
+
## LayoutMargin
|
|
1216
1915
|
|
|
1217
1916
|
### Fields
|
|
1218
1917
|
|
|
1219
1918
|
| Name | Required | Type | Description |
|
|
1220
1919
|
|---|---:|---|---|
|
|
1221
|
-
| `
|
|
1222
|
-
| `
|
|
1920
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
1921
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
1922
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
1923
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
1223
1924
|
|
|
1224
1925
|
No additional properties.
|
|
1225
1926
|
|
|
1226
|
-
##
|
|
1927
|
+
## LayoutPadding
|
|
1227
1928
|
|
|
1228
|
-
|
|
1929
|
+
### Fields
|
|
1930
|
+
|
|
1931
|
+
| Name | Required | Type | Description |
|
|
1932
|
+
|---|---:|---|---|
|
|
1933
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
1934
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
1935
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
1936
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
1937
|
+
|
|
1938
|
+
No additional properties.
|
|
1939
|
+
|
|
1940
|
+
## LayoutRadiu
|
|
1229
1941
|
|
|
1230
1942
|
### Fields
|
|
1231
1943
|
|
|
1232
|
-
|
|
1944
|
+
| Name | Required | Type | Description |
|
|
1945
|
+
|---|---:|---|---|
|
|
1946
|
+
| `bottomLeft` | no | [BoxRadius](./definitions.md#boxradius) | Bottom-left corner radius token |
|
|
1947
|
+
| `bottomRight` | no | [BoxRadius](./definitions.md#boxradius) | Bottom-right corner radius token |
|
|
1948
|
+
| `topLeft` | no | [BoxRadius](./definitions.md#boxradius) | Top-left corner radius token |
|
|
1949
|
+
| `topRight` | no | [BoxRadius](./definitions.md#boxradius) | Top-right corner radius token |
|
|
1233
1950
|
|
|
1234
|
-
|
|
1951
|
+
No additional properties.
|
|
1235
1952
|
|
|
1236
1953
|
## LayoutValue
|
|
1237
1954
|
|
|
@@ -1247,29 +1964,13 @@ Additional properties: unknown.
|
|
|
1247
1964
|
| `minHeight` | no | number | Minimum height in grid units |
|
|
1248
1965
|
| `minWidth` | no | number | Minimum width in grid units |
|
|
1249
1966
|
| `shadow` | no | [LayoutValueShadow](./definitions.md#layoutvalueshadow) | Shadow token applied to the block wrapper, e.g. "shadowSm". |
|
|
1250
|
-
| `shapeCorner` | no | [
|
|
1967
|
+
| `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
1968
|
| `width` | no | number | Width in grid units (1–12). Default: 3 |
|
|
1252
1969
|
| `x` | no | number | Horizontal position in grid units. Auto-calculated when omitted. |
|
|
1253
1970
|
| `y` | no | number | Vertical position in grid units. Auto-calculated when omitted. |
|
|
1254
1971
|
|
|
1255
1972
|
No additional properties.
|
|
1256
1973
|
|
|
1257
|
-
## LinkValue
|
|
1258
|
-
|
|
1259
|
-
### Fields
|
|
1260
|
-
|
|
1261
|
-
| Name | Required | Type | Description |
|
|
1262
|
-
|---|---:|---|---|
|
|
1263
|
-
| `badge` | no | [AppNavBarBadge](./types.md#appnavbarbadge) | Badge shown next to the nav item title |
|
|
1264
|
-
| `icon` | no | string | Icon name from Icon.TYPES (e.g. FOLDER_OUTLINE) |
|
|
1265
|
-
| `isSection` | no | boolean | If true, renders as a non-interactive section header (vertical mode only) |
|
|
1266
|
-
| `links` | no | [LinkValue](./types.md#linkvalue)[] | Nested sub-navigation items |
|
|
1267
|
-
| `path` | no | string | URL path segment for this nav item |
|
|
1268
|
-
| `queryParams` | no | [QueryParam](./types.md#queryparam) | Query parameters to append when navigating to this item |
|
|
1269
|
-
| `title` | yes | string | Display label for this nav item |
|
|
1270
|
-
|
|
1271
|
-
No additional properties.
|
|
1272
|
-
|
|
1273
1974
|
## Location
|
|
1274
1975
|
|
|
1275
1976
|
Location object with nickname and address. Required for displaying location information
|
|
@@ -1295,6 +1996,17 @@ No additional properties.
|
|
|
1295
1996
|
|
|
1296
1997
|
No additional properties.
|
|
1297
1998
|
|
|
1999
|
+
## LocationCardTo
|
|
2000
|
+
|
|
2001
|
+
### Fields
|
|
2002
|
+
|
|
2003
|
+
| Name | Required | Type | Description |
|
|
2004
|
+
|---|---:|---|---|
|
|
2005
|
+
| `openInNewTab` | no | boolean | |
|
|
2006
|
+
| `path` | yes | string | |
|
|
2007
|
+
|
|
2008
|
+
No additional properties.
|
|
2009
|
+
|
|
1298
2010
|
## MaskerArg
|
|
1299
2011
|
|
|
1300
2012
|
### Fields
|
|
@@ -1346,19 +2058,6 @@ _No fields._
|
|
|
1346
2058
|
|
|
1347
2059
|
Additional properties: unknown.
|
|
1348
2060
|
|
|
1349
|
-
## NestedListList
|
|
1350
|
-
|
|
1351
|
-
### Fields
|
|
1352
|
-
|
|
1353
|
-
| Name | Required | Type | Description |
|
|
1354
|
-
|---|---:|---|---|
|
|
1355
|
-
| `branches` | no | [NestedListList](./types.md#nestedlistlist)[] | Child items |
|
|
1356
|
-
| `isDefaultOpen` | no | boolean | Start expanded |
|
|
1357
|
-
| `label` | yes | string | Display text for the item |
|
|
1358
|
-
| `value` | no | string | Unique value for the item |
|
|
1359
|
-
|
|
1360
|
-
No additional properties.
|
|
1361
|
-
|
|
1362
2061
|
## NumberArg
|
|
1363
2062
|
|
|
1364
2063
|
### Fields
|
|
@@ -1437,7 +2136,82 @@ No additional properties.
|
|
|
1437
2136
|
| `iconType` | yes | string | Icon type name (e.g., "EDIT_OUTLINE", "DELETE") |
|
|
1438
2137
|
| `id` | yes | string | Unique identifier for this action. Written to state on click |
|
|
1439
2138
|
| `isDisabled` | no | boolean | Disable the action button. Default: false |
|
|
1440
|
-
| `tip` | no |
|
|
2139
|
+
| `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip for the action button. Can be a simple string or tooltip configuration object |
|
|
2140
|
+
|
|
2141
|
+
No additional properties.
|
|
2142
|
+
|
|
2143
|
+
## ObjectUIStatsLeftIcon
|
|
2144
|
+
|
|
2145
|
+
### Fields
|
|
2146
|
+
|
|
2147
|
+
| Name | Required | Type | Description |
|
|
2148
|
+
|---|---:|---|---|
|
|
2149
|
+
| `aria-describedby` | no | string | ID of element that describes this icon |
|
|
2150
|
+
| `aria-label` | no | string | Accessible label for screen readers |
|
|
2151
|
+
| `aria-labelledby` | no | string | ID of element that labels this icon |
|
|
2152
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token. Only applicable for TRANSPARENT appearance |
|
|
2153
|
+
| `type` | yes | string | Icon type name |
|
|
2154
|
+
|
|
2155
|
+
No additional properties.
|
|
2156
|
+
|
|
2157
|
+
## ObjectUIStatsList
|
|
2158
|
+
|
|
2159
|
+
### Fields
|
|
2160
|
+
|
|
2161
|
+
| Name | Required | Type | Description |
|
|
2162
|
+
|---|---:|---|---|
|
|
2163
|
+
| `label` | yes | string \| number | Label displayed in the cell header. String or number value |
|
|
2164
|
+
| `props` | yes | [ObjectUIStatsProp](./types.md#objectuistatsprop) | Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens. |
|
|
2165
|
+
| `renderer` | yes | "LABEL" | Renderer type for the cell value. LABEL renders a Label component. |
|
|
2166
|
+
| `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
|
|
2167
|
+
|
|
2168
|
+
No additional properties.
|
|
2169
|
+
|
|
2170
|
+
## ObjectUIStatsProp
|
|
2171
|
+
|
|
2172
|
+
Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
|
|
2173
|
+
|
|
2174
|
+
### Fields
|
|
2175
|
+
|
|
2176
|
+
| Name | Required | Type | Description |
|
|
2177
|
+
|---|---:|---|---|
|
|
2178
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Color scheme of the label. Default: NEUTRAL |
|
|
2179
|
+
| `children` | no | string | Text content of the label |
|
|
2180
|
+
| `leftIcon` | no | string \| [ObjectUIStatsLeftIcon](./types.md#objectuistatslefticon) | Icon displayed on the left side of the label |
|
|
2181
|
+
| `maxWidth` | no | string | Maximum width CSS value for truncation |
|
|
2182
|
+
| `rightIcon` | no | string \| [ObjectUIStatsRightIcon](./types.md#objectuistatsrighticon) | Icon displayed on the right side of the label |
|
|
2183
|
+
| `size` | no | [LabelSize](./definitions.md#labelsize) | Size of the label. Default: LARGE |
|
|
2184
|
+
| `text` | no | string | Text content of the label. Converted to children for LabelRenderer. |
|
|
2185
|
+
| `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
|
|
2186
|
+
|
|
2187
|
+
No additional properties.
|
|
2188
|
+
|
|
2189
|
+
## ObjectUIStatsRightIcon
|
|
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
|
+
## ObjectUIStatsTip
|
|
2204
|
+
|
|
2205
|
+
### Fields
|
|
2206
|
+
|
|
2207
|
+
| Name | Required | Type | Description |
|
|
2208
|
+
|---|---:|---|---|
|
|
2209
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance style |
|
|
2210
|
+
| `content` | yes | string | Tooltip content text |
|
|
2211
|
+
| `isVisible` | no | boolean | Force tooltip to always be visible |
|
|
2212
|
+
| `maxHeight` | no | number \| string | Maximum height for tooltip |
|
|
2213
|
+
| `maxWidth` | no | number \| string | Maximum width for tooltip |
|
|
2214
|
+
| `placement` | no | [ButtonTipPlacement](./definitions.md#buttontipplacement) | Tooltip placement position |
|
|
1441
2215
|
|
|
1442
2216
|
No additional properties.
|
|
1443
2217
|
|
|
@@ -1464,7 +2238,7 @@ No additional properties.
|
|
|
1464
2238
|
|
|
1465
2239
|
| Name | Required | Type | Description |
|
|
1466
2240
|
|---|---:|---|---|
|
|
1467
|
-
| `id` | yes |
|
|
2241
|
+
| `id` | yes | string \| number | Unique identifier for the item |
|
|
1468
2242
|
| `label` | yes | string | Display text for the item |
|
|
1469
2243
|
|
|
1470
2244
|
No additional properties.
|
|
@@ -1621,12 +2395,23 @@ No additional properties.
|
|
|
1621
2395
|
| `isDisabled` | no | boolean | Disables this specific option |
|
|
1622
2396
|
| `label` | yes | string | Display text for the option |
|
|
1623
2397
|
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
1624
|
-
| `tag` | no |
|
|
2398
|
+
| `tag` | no | string \| [RadioTag](./types.md#radiotag) | Optional tag/label displayed with the option |
|
|
1625
2399
|
| `tip` | no | string | Tooltip text shown on hover |
|
|
1626
2400
|
| `value` | yes | unknown | Value stored when option is selected |
|
|
1627
2401
|
|
|
1628
2402
|
No additional properties.
|
|
1629
2403
|
|
|
2404
|
+
## RadioTag
|
|
2405
|
+
|
|
2406
|
+
### Fields
|
|
2407
|
+
|
|
2408
|
+
| Name | Required | Type | Description |
|
|
2409
|
+
|---|---:|---|---|
|
|
2410
|
+
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Tag appearance style |
|
|
2411
|
+
| `label` | yes | string | Tag label text |
|
|
2412
|
+
|
|
2413
|
+
No additional properties.
|
|
2414
|
+
|
|
1630
2415
|
## RangeSliderArg
|
|
1631
2416
|
|
|
1632
2417
|
### Fields
|
|
@@ -1708,7 +2493,7 @@ Additional properties: string | number | boolean | null.
|
|
|
1708
2493
|
|
|
1709
2494
|
| Name | Required | Type | Description |
|
|
1710
2495
|
|---|---:|---|---|
|
|
1711
|
-
| `segmentColor` | yes |
|
|
2496
|
+
| `segmentColor` | yes | [SegmentSegmentColor](./definitions.md#segmentsegmentcolor) \| [SegmentSegmentColor](./definitions.md#segmentsegmentcolor) | Pebble chart color token, or semantic color token for status-related visualizations. |
|
|
1712
2497
|
| `value` | yes | number | Numeric value of this segment |
|
|
1713
2498
|
|
|
1714
2499
|
No additional properties.
|
|
@@ -1847,6 +2632,18 @@ No additional properties.
|
|
|
1847
2632
|
|
|
1848
2633
|
No additional properties.
|
|
1849
2634
|
|
|
2635
|
+
## SelectEmptyListPlaceholder
|
|
2636
|
+
|
|
2637
|
+
### Fields
|
|
2638
|
+
|
|
2639
|
+
| Name | Required | Type | Description |
|
|
2640
|
+
|---|---:|---|---|
|
|
2641
|
+
| `onLoading` | no | string | Placeholder shown while list is loading |
|
|
2642
|
+
| `onNoSearchQuery` | no | string | Placeholder when no search query entered |
|
|
2643
|
+
| `onNoSearchResults` | no | string | Placeholder when search returns no results |
|
|
2644
|
+
|
|
2645
|
+
No additional properties.
|
|
2646
|
+
|
|
1850
2647
|
## SelectFooter
|
|
1851
2648
|
|
|
1852
2649
|
Fixed footer at bottom of dropdown menu
|
|
@@ -1893,6 +2690,16 @@ Additional properties: unknown.
|
|
|
1893
2690
|
|
|
1894
2691
|
No additional properties.
|
|
1895
2692
|
|
|
2693
|
+
## ShouldShowHeader
|
|
2694
|
+
|
|
2695
|
+
### Fields
|
|
2696
|
+
|
|
2697
|
+
| Name | Required | Type | Description |
|
|
2698
|
+
|---|---:|---|---|
|
|
2699
|
+
| `headerActions` | yes | boolean | Show month/year navigation |
|
|
2700
|
+
|
|
2701
|
+
No additional properties.
|
|
2702
|
+
|
|
1896
2703
|
## ShowMoreValue
|
|
1897
2704
|
|
|
1898
2705
|
Configuration for show more behavior
|
|
@@ -2001,6 +2808,17 @@ _No fields._
|
|
|
2001
2808
|
|
|
2002
2809
|
Additional properties: string.
|
|
2003
2810
|
|
|
2811
|
+
## Src
|
|
2812
|
+
|
|
2813
|
+
### Fields
|
|
2814
|
+
|
|
2815
|
+
| Name | Required | Type | Description |
|
|
2816
|
+
|---|---:|---|---|
|
|
2817
|
+
| `dark` | no | string | |
|
|
2818
|
+
| `light` | no | string | |
|
|
2819
|
+
|
|
2820
|
+
No additional properties.
|
|
2821
|
+
|
|
2004
2822
|
## SsnArg
|
|
2005
2823
|
|
|
2006
2824
|
### Fields
|
|
@@ -2027,7 +2845,7 @@ No additional properties.
|
|
|
2027
2845
|
|
|
2028
2846
|
| Name | Required | Type | Description |
|
|
2029
2847
|
|---|---:|---|---|
|
|
2030
|
-
| `avatar` | no | [
|
|
2848
|
+
| `avatar` | no | [StepperAvatar](./types.md#stepperavatar) | Avatar configuration to display with the step. Supports image URLs |
|
|
2031
2849
|
| `badge` | no | [StepperBadge](./types.md#stepperbadge) | Badge configuration to display alongside the step title |
|
|
2032
2850
|
| `description` | no | string | Optional step description |
|
|
2033
2851
|
| `href` | no | string | URL for the step. Renders the step as an anchor tag with this href (semantic HTML only) |
|
|
@@ -2036,6 +2854,19 @@ No additional properties.
|
|
|
2036
2854
|
|
|
2037
2855
|
No additional properties.
|
|
2038
2856
|
|
|
2857
|
+
## StepperAvatar
|
|
2858
|
+
|
|
2859
|
+
Avatar configuration to display with the step. Supports image URLs
|
|
2860
|
+
|
|
2861
|
+
### Fields
|
|
2862
|
+
|
|
2863
|
+
| Name | Required | Type | Description |
|
|
2864
|
+
|---|---:|---|---|
|
|
2865
|
+
| `imageUrl` | no | string | URL of the avatar image |
|
|
2866
|
+
| `type` | no | [StepperAvatarType](./definitions.md#stepperavatartype) | Avatar type |
|
|
2867
|
+
|
|
2868
|
+
No additional properties.
|
|
2869
|
+
|
|
2039
2870
|
## StepperBadge
|
|
2040
2871
|
|
|
2041
2872
|
Badge configuration to display alongside the step title
|
|
@@ -2056,7 +2887,7 @@ No additional properties.
|
|
|
2056
2887
|
|
|
2057
2888
|
| Name | Required | Type | Description |
|
|
2058
2889
|
|---|---:|---|---|
|
|
2059
|
-
| `avatar` | no | [
|
|
2890
|
+
| `avatar` | no | [StepperAvatar](./types.md#stepperavatar) | Avatar configuration to display with the step. Supports image URLs |
|
|
2060
2891
|
| `badge` | no | [StepperBadge](./types.md#stepperbadge) | Badge configuration to display alongside the step title |
|
|
2061
2892
|
| `description` | no | string | Optional step description |
|
|
2062
2893
|
| `href` | no | string | URL for the step. Renders the step as an anchor tag with this href (semantic HTML only) |
|
|
@@ -2081,6 +2912,17 @@ Configuration for the form submit button
|
|
|
2081
2912
|
|
|
2082
2913
|
No additional properties.
|
|
2083
2914
|
|
|
2915
|
+
## SupportButtonTo
|
|
2916
|
+
|
|
2917
|
+
### Fields
|
|
2918
|
+
|
|
2919
|
+
| Name | Required | Type | Description |
|
|
2920
|
+
|---|---:|---|---|
|
|
2921
|
+
| `openInNewTab` | no | boolean | Open link in new tab. Default: false |
|
|
2922
|
+
| `path` | yes | string | URL path for navigation |
|
|
2923
|
+
|
|
2924
|
+
No additional properties.
|
|
2925
|
+
|
|
2084
2926
|
## SurveyArg
|
|
2085
2927
|
|
|
2086
2928
|
### Fields
|
|
@@ -2108,9 +2950,9 @@ No additional properties.
|
|
|
2108
2950
|
| Name | Required | Type | Description |
|
|
2109
2951
|
|---|---:|---|---|
|
|
2110
2952
|
| `isDisabled` | no | boolean | Disable this specific option |
|
|
2111
|
-
| `label` | no |
|
|
2953
|
+
| `label` | no | string \| number | Display label for the option |
|
|
2112
2954
|
| `selectionColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Override selected surface color token for this option |
|
|
2113
|
-
| `value` | yes |
|
|
2955
|
+
| `value` | yes | string \| number | Value when selected |
|
|
2114
2956
|
|
|
2115
2957
|
No additional properties.
|
|
2116
2958
|
|
|
@@ -2170,11 +3012,22 @@ No additional properties.
|
|
|
2170
3012
|
| `disabled` | no | boolean | Whether this tab is disabled |
|
|
2171
3013
|
| `icon` | no | string | Icon name for the tab (e.g., FOLDER_OUTLINE) |
|
|
2172
3014
|
| `label` | yes | string | Display text for the tab |
|
|
2173
|
-
| `tip` | no |
|
|
3015
|
+
| `tip` | no | string \| [TabTip](./types.md#tabtip) | Tooltip to show on hover |
|
|
2174
3016
|
| `value` | yes | unknown | Value for this tab option |
|
|
2175
3017
|
|
|
2176
3018
|
No additional properties.
|
|
2177
3019
|
|
|
3020
|
+
## TabTip
|
|
3021
|
+
|
|
3022
|
+
### Fields
|
|
3023
|
+
|
|
3024
|
+
| Name | Required | Type | Description |
|
|
3025
|
+
|---|---:|---|---|
|
|
3026
|
+
| `content` | yes | string | Tip content text |
|
|
3027
|
+
| `testId` | no | string | Test ID for the tip |
|
|
3028
|
+
|
|
3029
|
+
No additional properties.
|
|
3030
|
+
|
|
2178
3031
|
## TextareaArg
|
|
2179
3032
|
|
|
2180
3033
|
### Fields
|
|
@@ -2236,7 +3089,7 @@ No additional properties.
|
|
|
2236
3089
|
| Name | Required | Type | Description |
|
|
2237
3090
|
|---|---:|---|---|
|
|
2238
3091
|
| `label` | yes | string | Display text for the suggestion |
|
|
2239
|
-
| `value` | yes |
|
|
3092
|
+
| `value` | yes | string \| number | Value stored when suggestion is selected |
|
|
2240
3093
|
|
|
2241
3094
|
No additional properties.
|
|
2242
3095
|
|
|
@@ -2355,7 +3208,7 @@ Toggle icon configuration
|
|
|
2355
3208
|
| Name | Required | Type | Description |
|
|
2356
3209
|
|---|---:|---|---|
|
|
2357
3210
|
| `align` | no | string | CSS alignSelf value. Default: center |
|
|
2358
|
-
| `margin` | no | [
|
|
3211
|
+
| `margin` | no | [BoxGap](./definitions.md#boxgap) | Margin spacing token for icon alignment |
|
|
2359
3212
|
| `size` | no | [IconSize](./definitions.md#iconsize) | Icon size token. Default: 24 |
|
|
2360
3213
|
|
|
2361
3214
|
No additional properties.
|
|
@@ -2380,6 +3233,19 @@ Additional properties: unknown.
|
|
|
2380
3233
|
|
|
2381
3234
|
No additional properties.
|
|
2382
3235
|
|
|
3236
|
+
## TreeDisabledInfo
|
|
3237
|
+
|
|
3238
|
+
### Fields
|
|
3239
|
+
|
|
3240
|
+
| Name | Required | Type | Description |
|
|
3241
|
+
|---|---:|---|---|
|
|
3242
|
+
| `content` | yes | string | Tooltip content text |
|
|
3243
|
+
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices |
|
|
3244
|
+
| `maxHeight` | no | number \| string | Maximum tooltip height |
|
|
3245
|
+
| `maxWidth` | no | number \| string | Maximum tooltip width |
|
|
3246
|
+
|
|
3247
|
+
No additional properties.
|
|
3248
|
+
|
|
2383
3249
|
## TreeFooter
|
|
2384
3250
|
|
|
2385
3251
|
Fixed footer with clickable action at bottom of tree
|
|
@@ -2408,12 +3274,12 @@ Additional properties: unknown.
|
|
|
2408
3274
|
|
|
2409
3275
|
| Name | Required | Type | Description |
|
|
2410
3276
|
|---|---:|---|---|
|
|
2411
|
-
| `disabledInfo` | no |
|
|
3277
|
+
| `disabledInfo` | no | string \| [TreeDisabledInfo](./types.md#treedisabledinfo) | Tooltip shown when item is disabled |
|
|
2412
3278
|
| `isDisabled` | no | boolean | Disable this item |
|
|
2413
3279
|
| `label` | yes | string | Display label for the item |
|
|
2414
3280
|
| `parent` | no | string | Parent item value, null for root items |
|
|
2415
3281
|
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
2416
|
-
| `tag` | no |
|
|
3282
|
+
| `tag` | no | string \| [TreeTag](./types.md#treetag) | Chip/tag to display next to the label |
|
|
2417
3283
|
| `value` | yes | string | Unique identifier for the item |
|
|
2418
3284
|
|
|
2419
3285
|
No additional properties.
|
|
@@ -2462,6 +3328,17 @@ Additional properties: unknown.
|
|
|
2462
3328
|
|
|
2463
3329
|
No additional properties.
|
|
2464
3330
|
|
|
3331
|
+
## TreeTag
|
|
3332
|
+
|
|
3333
|
+
### Fields
|
|
3334
|
+
|
|
3335
|
+
| Name | Required | Type | Description |
|
|
3336
|
+
|---|---:|---|---|
|
|
3337
|
+
| `appearance` | no | string | Label appearance (e.g., "primary", "error", "success") |
|
|
3338
|
+
| `text` | yes | string | Tag text to display |
|
|
3339
|
+
|
|
3340
|
+
No additional properties.
|
|
3341
|
+
|
|
2465
3342
|
## User_cache
|
|
2466
3343
|
|
|
2467
3344
|
User cache data with smallPhoto fallback
|
|
@@ -2488,6 +3365,32 @@ Vertical size constraints for mobile stacked layout. Object with optional defaul
|
|
|
2488
3365
|
|
|
2489
3366
|
No additional properties.
|
|
2490
3367
|
|
|
3368
|
+
## VStackMargin
|
|
3369
|
+
|
|
3370
|
+
### Fields
|
|
3371
|
+
|
|
3372
|
+
| Name | Required | Type | Description |
|
|
3373
|
+
|---|---:|---|---|
|
|
3374
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
3375
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
3376
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
3377
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
3378
|
+
|
|
3379
|
+
No additional properties.
|
|
3380
|
+
|
|
3381
|
+
## VStackPadding
|
|
3382
|
+
|
|
3383
|
+
### Fields
|
|
3384
|
+
|
|
3385
|
+
| Name | Required | Type | Description |
|
|
3386
|
+
|---|---:|---|---|
|
|
3387
|
+
| `bottom` | no | [BoxGap](./definitions.md#boxgap) | Bottom spacing token |
|
|
3388
|
+
| `left` | no | [BoxGap](./definitions.md#boxgap) | Left spacing token |
|
|
3389
|
+
| `right` | no | [BoxGap](./definitions.md#boxgap) | Right spacing token |
|
|
3390
|
+
| `top` | no | [BoxGap](./definitions.md#boxgap) | Top spacing token |
|
|
3391
|
+
|
|
3392
|
+
No additional properties.
|
|
3393
|
+
|
|
2491
3394
|
## WorkEmailArg
|
|
2492
3395
|
|
|
2493
3396
|
### Fields
|