@rippling/pebble-sdui-web 0.4.0 → 0.4.2
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/catalog.d.ts +5 -1
- package/dist/catalogs/custom-apps/component-props.d.ts +56 -68
- package/dist/catalogs/custom-apps/index.cjs +8 -8
- package/dist/catalogs/custom-apps/index.cjs.map +1 -1
- package/dist/catalogs/custom-apps/index.d.ts +2 -2
- package/dist/catalogs/custom-apps/index.js +8841 -4827
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/README.md +16 -0
- package/dist/docs/catalogs.md +10 -0
- package/dist/docs/concepts.md +370 -0
- package/dist/docs/recipes.md +8 -0
- package/dist/docs/typescript/README.md +17 -0
- package/dist/docs/typescript/api-reference.md +400 -0
- package/dist/docs/typescript/catalogs.md +8 -0
- package/dist/docs/typescript/recipes.md +383 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/actions.md +165 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +6184 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/computed-functions.md +6 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +3573 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +16 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +2507 -0
- package/dist/docs/typescript/web/catalogs.md +7 -0
- package/dist/sdk-docs.cjs +40 -9
- package/dist/sdk-docs.cjs.map +1 -1
- package/dist/sdk-docs.js +41 -10
- package/dist/sdk-docs.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,2507 @@
|
|
|
1
|
+
<!-- Auto-generated from catalogs/custom-apps.catalog.json; do not edit directly. -->
|
|
2
|
+
# custom-apps Types
|
|
3
|
+
|
|
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
|
+
|
|
6
|
+
## Addres
|
|
7
|
+
|
|
8
|
+
Address object with street, city, state, country, and zip
|
|
9
|
+
|
|
10
|
+
### Fields
|
|
11
|
+
|
|
12
|
+
| Name | Required | Type | Description |
|
|
13
|
+
|---|---:|---|---|
|
|
14
|
+
| `city` | no | string | City name |
|
|
15
|
+
| `country` | yes | string | Country code |
|
|
16
|
+
| `countyName` | no | string | County name |
|
|
17
|
+
| `state` | no | string | State or province code |
|
|
18
|
+
| `streetLine1` | yes | string | Primary street address line |
|
|
19
|
+
| `streetLine2` | no | string | Secondary street address line |
|
|
20
|
+
| `streetLine3` | no | string | Tertiary street address line |
|
|
21
|
+
| `streetLine4` | no | string | Quaternary street address line |
|
|
22
|
+
| `zip` | yes | string | Postal/ZIP code |
|
|
23
|
+
|
|
24
|
+
No additional properties.
|
|
25
|
+
|
|
26
|
+
## AnimationData
|
|
27
|
+
|
|
28
|
+
Lottie animation JSON object. Required if path not provided
|
|
29
|
+
|
|
30
|
+
### Fields
|
|
31
|
+
|
|
32
|
+
_No fields._
|
|
33
|
+
|
|
34
|
+
Additional properties: unknown.
|
|
35
|
+
|
|
36
|
+
## AppGroupSelectArg
|
|
37
|
+
|
|
38
|
+
### Fields
|
|
39
|
+
|
|
40
|
+
_No fields._
|
|
41
|
+
|
|
42
|
+
Additional properties: unknown.
|
|
43
|
+
|
|
44
|
+
## AppGroupSelectCheck
|
|
45
|
+
|
|
46
|
+
### Fields
|
|
47
|
+
|
|
48
|
+
| Name | Required | Type | Description |
|
|
49
|
+
|---|---:|---|---|
|
|
50
|
+
| `args` | no | [AppGroupSelectArg](./types.md#appgroupselectarg) | |
|
|
51
|
+
| `message` | yes | string | |
|
|
52
|
+
| `type` | yes | string | |
|
|
53
|
+
|
|
54
|
+
No additional properties.
|
|
55
|
+
|
|
56
|
+
## AppGroupSelectFooter
|
|
57
|
+
|
|
58
|
+
Fixed footer at bottom of dropdown menu
|
|
59
|
+
|
|
60
|
+
### Fields
|
|
61
|
+
|
|
62
|
+
| Name | Required | Type | Description |
|
|
63
|
+
|---|---:|---|---|
|
|
64
|
+
| `label` | yes | string | Footer link text |
|
|
65
|
+
| `onClick` | yes | string | Event name to emit when footer is clicked |
|
|
66
|
+
|
|
67
|
+
No additional properties.
|
|
68
|
+
|
|
69
|
+
## AppGroupSelectFuseOption
|
|
70
|
+
|
|
71
|
+
Fuse.js search options for customizing fuzzy search behavior
|
|
72
|
+
|
|
73
|
+
### Fields
|
|
74
|
+
|
|
75
|
+
_No fields._
|
|
76
|
+
|
|
77
|
+
Additional properties: unknown.
|
|
78
|
+
|
|
79
|
+
## AppNavBarAction
|
|
80
|
+
|
|
81
|
+
### Fields
|
|
82
|
+
|
|
83
|
+
| Name | Required | Type | Description |
|
|
84
|
+
|---|---:|---|---|
|
|
85
|
+
| `appearance` | no | [AppNavBarActionAppearance](./definitions.md#appnavbaractionappearance) | Button visual style. Default: PRIMARY |
|
|
86
|
+
| `icon` | no | string | Icon name from Icon.TYPES (e.g. ADD, EDIT_OUTLINE) |
|
|
87
|
+
| `id` | yes | string | Unique identifier for the action. Written to actionClickedId state on click |
|
|
88
|
+
| `isDisabled` | no | boolean | Disables the button. Default: false |
|
|
89
|
+
| `label` | yes | string | Button text |
|
|
90
|
+
| `size` | no | [ButtonSize](./definitions.md#buttonsize) | Button size. Default: M |
|
|
91
|
+
|
|
92
|
+
No additional properties.
|
|
93
|
+
|
|
94
|
+
## AppNavBarBadge
|
|
95
|
+
|
|
96
|
+
Badge shown next to the nav item title
|
|
97
|
+
|
|
98
|
+
### Fields
|
|
99
|
+
|
|
100
|
+
| Name | Required | Type | Description |
|
|
101
|
+
|---|---:|---|---|
|
|
102
|
+
| `appearance` | no | [BadgeAppearance](./definitions.md#badgeappearance) | Badge visual style |
|
|
103
|
+
| `text` | yes | string | Text to display in the badge |
|
|
104
|
+
|
|
105
|
+
No additional properties.
|
|
106
|
+
|
|
107
|
+
## AvatarTip
|
|
108
|
+
|
|
109
|
+
Tooltip shown on avatar hover. Object with content string and optional title
|
|
110
|
+
|
|
111
|
+
### Fields
|
|
112
|
+
|
|
113
|
+
| Name | Required | Type | Description |
|
|
114
|
+
|---|---:|---|---|
|
|
115
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance. Default: LIGHT |
|
|
116
|
+
| `content` | yes | string | Tooltip text content |
|
|
117
|
+
| `title` | no | string | Tooltip title text |
|
|
118
|
+
|
|
119
|
+
No additional properties.
|
|
120
|
+
|
|
121
|
+
## AvatarValue
|
|
122
|
+
|
|
123
|
+
Avatar configuration to display with the step. Supports image URLs
|
|
124
|
+
|
|
125
|
+
### Fields
|
|
126
|
+
|
|
127
|
+
| Name | Required | Type | Description |
|
|
128
|
+
|---|---:|---|---|
|
|
129
|
+
| `imageUrl` | no | string | URL of the avatar image |
|
|
130
|
+
| `type` | no | [AvatarValueType](./definitions.md#avatarvaluetype) | Avatar type |
|
|
131
|
+
|
|
132
|
+
No additional properties.
|
|
133
|
+
|
|
134
|
+
## BadgeTip
|
|
135
|
+
|
|
136
|
+
Tooltip configuration to show on hover
|
|
137
|
+
|
|
138
|
+
### Fields
|
|
139
|
+
|
|
140
|
+
| Name | Required | Type | Description |
|
|
141
|
+
|---|---:|---|---|
|
|
142
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip theme. Default: LIGHT |
|
|
143
|
+
| `content` | yes | string | Tooltip text content |
|
|
144
|
+
| `isDelayed` | no | boolean | Add delay before showing/hiding the tooltip. Default: false |
|
|
145
|
+
| `maxWidth` | no | unknown | Max width of tooltip. Number in px or CSS string |
|
|
146
|
+
| `placement` | no | [BadgeTipPlacement](./definitions.md#badgetipplacement) | Tooltip position relative to badge. Default: bottom |
|
|
147
|
+
|
|
148
|
+
No additional properties.
|
|
149
|
+
|
|
150
|
+
## BreadcrumbItem
|
|
151
|
+
|
|
152
|
+
### Fields
|
|
153
|
+
|
|
154
|
+
| Name | Required | Type | Description |
|
|
155
|
+
|---|---:|---|---|
|
|
156
|
+
| `href` | no | string | URL to navigate to when clicked |
|
|
157
|
+
| `isDisabled` | no | boolean | Disables the breadcrumb item |
|
|
158
|
+
| `title` | yes | string | Display label for the breadcrumb item |
|
|
159
|
+
| `value` | yes | string | Unique value identifier for the item |
|
|
160
|
+
|
|
161
|
+
No additional properties.
|
|
162
|
+
|
|
163
|
+
## CardAction
|
|
164
|
+
|
|
165
|
+
### Fields
|
|
166
|
+
|
|
167
|
+
| Name | Required | Type | Description |
|
|
168
|
+
|---|---:|---|---|
|
|
169
|
+
| `icon` | no | string | Icon name from Icon.TYPES (e.g. "EDIT", "DELETE") |
|
|
170
|
+
| `id` | yes | string | Unique identifier for the action |
|
|
171
|
+
| `label` | yes | string | Label text for the action |
|
|
172
|
+
|
|
173
|
+
No additional properties.
|
|
174
|
+
|
|
175
|
+
## CheckboxArg
|
|
176
|
+
|
|
177
|
+
### Fields
|
|
178
|
+
|
|
179
|
+
_No fields._
|
|
180
|
+
|
|
181
|
+
Additional properties: unknown.
|
|
182
|
+
|
|
183
|
+
## CheckboxCheck
|
|
184
|
+
|
|
185
|
+
### Fields
|
|
186
|
+
|
|
187
|
+
| Name | Required | Type | Description |
|
|
188
|
+
|---|---:|---|---|
|
|
189
|
+
| `args` | no | [CheckboxArg](./types.md#checkboxarg) | |
|
|
190
|
+
| `message` | yes | string | |
|
|
191
|
+
| `type` | yes | string | |
|
|
192
|
+
|
|
193
|
+
No additional properties.
|
|
194
|
+
|
|
195
|
+
## CheckboxGroupArg
|
|
196
|
+
|
|
197
|
+
### Fields
|
|
198
|
+
|
|
199
|
+
_No fields._
|
|
200
|
+
|
|
201
|
+
Additional properties: unknown.
|
|
202
|
+
|
|
203
|
+
## CheckboxGroupCheck
|
|
204
|
+
|
|
205
|
+
### Fields
|
|
206
|
+
|
|
207
|
+
| Name | Required | Type | Description |
|
|
208
|
+
|---|---:|---|---|
|
|
209
|
+
| `args` | no | [CheckboxGroupArg](./types.md#checkboxgrouparg) | |
|
|
210
|
+
| `message` | yes | string | |
|
|
211
|
+
| `type` | yes | string | |
|
|
212
|
+
|
|
213
|
+
No additional properties.
|
|
214
|
+
|
|
215
|
+
## CheckboxGroupOption
|
|
216
|
+
|
|
217
|
+
### Fields
|
|
218
|
+
|
|
219
|
+
| Name | Required | Type | Description |
|
|
220
|
+
|---|---:|---|---|
|
|
221
|
+
| `isDisabled` | no | boolean | Disables this specific checkbox |
|
|
222
|
+
| `label` | yes | string | Display text for the checkbox option |
|
|
223
|
+
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
224
|
+
| `tag` | no | unknown | Optional tag/label displayed with the option |
|
|
225
|
+
| `tip` | no | string | Tooltip text shown on hover |
|
|
226
|
+
| `value` | yes | unknown | Value stored when option is selected |
|
|
227
|
+
|
|
228
|
+
No additional properties.
|
|
229
|
+
|
|
230
|
+
## CheckListList
|
|
231
|
+
|
|
232
|
+
### Fields
|
|
233
|
+
|
|
234
|
+
| Name | Required | Type | Description |
|
|
235
|
+
|---|---:|---|---|
|
|
236
|
+
| `branches` | no | [CheckListList](./types.md#checklistlist)[] | Nested child items |
|
|
237
|
+
| `checkListOptions` | no | [CheckListOption](./types.md#checklistoption) | Per-item input type overrides |
|
|
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 |
|
|
244
|
+
|
|
245
|
+
No additional properties.
|
|
246
|
+
|
|
247
|
+
## CheckListOption
|
|
248
|
+
|
|
249
|
+
Per-item input type overrides
|
|
250
|
+
|
|
251
|
+
### Fields
|
|
252
|
+
|
|
253
|
+
| Name | Required | Type | Description |
|
|
254
|
+
|---|---:|---|---|
|
|
255
|
+
| `shouldHaveNegativeCheckbox` | no | boolean | Override negative checkbox for this item |
|
|
256
|
+
| `type` | no | [CheckListType](./definitions.md#checklisttype) | Override input type for this item |
|
|
257
|
+
|
|
258
|
+
No additional properties.
|
|
259
|
+
|
|
260
|
+
## ChipTip
|
|
261
|
+
|
|
262
|
+
Tooltip configuration. Chip has default overflow tooltip behavior
|
|
263
|
+
|
|
264
|
+
### Fields
|
|
265
|
+
|
|
266
|
+
| Name | Required | Type | Description |
|
|
267
|
+
|---|---:|---|---|
|
|
268
|
+
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip appearance (LIGHT, DARK). Default: LIGHT |
|
|
269
|
+
| `content` | yes | string | Tooltip content text |
|
|
270
|
+
| `isVisible` | no | boolean | Control tooltip visibility from parent |
|
|
271
|
+
| `maxHeight` | no | unknown | Tooltip max height (number in px or CSS string) |
|
|
272
|
+
| `maxWidth` | no | unknown | Tooltip max width (number in px or CSS string) |
|
|
273
|
+
| `placement` | no | [ChipTipPlacement](./definitions.md#chiptipplacement) | Tooltip placement relative to chip. Default: TOP_START |
|
|
274
|
+
|
|
275
|
+
No additional properties.
|
|
276
|
+
|
|
277
|
+
## CollapseBelow
|
|
278
|
+
|
|
279
|
+
Configure when each priority level auto-collapses based on container width. Keys are priority numbers, values are breakpoint tokens. Use false to disable auto-collapse for a priority level
|
|
280
|
+
|
|
281
|
+
### Fields
|
|
282
|
+
|
|
283
|
+
_No fields._
|
|
284
|
+
|
|
285
|
+
Additional properties: unknown.
|
|
286
|
+
|
|
287
|
+
## ColorPickerArg
|
|
288
|
+
|
|
289
|
+
### Fields
|
|
290
|
+
|
|
291
|
+
_No fields._
|
|
292
|
+
|
|
293
|
+
Additional properties: unknown.
|
|
294
|
+
|
|
295
|
+
## ColorPickerCheck
|
|
296
|
+
|
|
297
|
+
### Fields
|
|
298
|
+
|
|
299
|
+
| Name | Required | Type | Description |
|
|
300
|
+
|---|---:|---|---|
|
|
301
|
+
| `args` | no | [ColorPickerArg](./types.md#colorpickerarg) | |
|
|
302
|
+
| `message` | yes | string | |
|
|
303
|
+
| `type` | yes | string | |
|
|
304
|
+
|
|
305
|
+
No additional properties.
|
|
306
|
+
|
|
307
|
+
## Column
|
|
308
|
+
|
|
309
|
+
### Fields
|
|
310
|
+
|
|
311
|
+
| Name | Required | Type | Description |
|
|
312
|
+
|---|---:|---|---|
|
|
313
|
+
| `align` | no | [HeadingAlign](./definitions.md#headingalign) | Text alignment for this column |
|
|
314
|
+
| `header` | yes | string | Column header text |
|
|
315
|
+
| `key` | yes | string | Key to look up cell value in each row object |
|
|
316
|
+
| `width` | no | unknown | Column width in px (number) or CSS string |
|
|
317
|
+
| `wrapText` | no | boolean | Whether to wrap text in cells of this column. Default: false (nowrap) |
|
|
318
|
+
|
|
319
|
+
No additional properties.
|
|
320
|
+
|
|
321
|
+
## CurrencyArg
|
|
322
|
+
|
|
323
|
+
### Fields
|
|
324
|
+
|
|
325
|
+
_No fields._
|
|
326
|
+
|
|
327
|
+
Additional properties: unknown.
|
|
328
|
+
|
|
329
|
+
## CurrencyCheck
|
|
330
|
+
|
|
331
|
+
### Fields
|
|
332
|
+
|
|
333
|
+
| Name | Required | Type | Description |
|
|
334
|
+
|---|---:|---|---|
|
|
335
|
+
| `args` | no | [CurrencyArg](./types.md#currencyarg) | |
|
|
336
|
+
| `message` | yes | string | |
|
|
337
|
+
| `type` | yes | string | |
|
|
338
|
+
|
|
339
|
+
No additional properties.
|
|
340
|
+
|
|
341
|
+
## DateArg
|
|
342
|
+
|
|
343
|
+
### Fields
|
|
344
|
+
|
|
345
|
+
_No fields._
|
|
346
|
+
|
|
347
|
+
Additional properties: unknown.
|
|
348
|
+
|
|
349
|
+
## DateCheck
|
|
350
|
+
|
|
351
|
+
### Fields
|
|
352
|
+
|
|
353
|
+
| Name | Required | Type | Description |
|
|
354
|
+
|---|---:|---|---|
|
|
355
|
+
| `args` | no | [DateArg](./types.md#datearg) | |
|
|
356
|
+
| `message` | yes | string | |
|
|
357
|
+
| `type` | yes | string | |
|
|
358
|
+
|
|
359
|
+
No additional properties.
|
|
360
|
+
|
|
361
|
+
## DateInlineMultiArg
|
|
362
|
+
|
|
363
|
+
### Fields
|
|
364
|
+
|
|
365
|
+
_No fields._
|
|
366
|
+
|
|
367
|
+
Additional properties: unknown.
|
|
368
|
+
|
|
369
|
+
## DateInlineMultiCheck
|
|
370
|
+
|
|
371
|
+
### Fields
|
|
372
|
+
|
|
373
|
+
| Name | Required | Type | Description |
|
|
374
|
+
|---|---:|---|---|
|
|
375
|
+
| `args` | no | [DateInlineMultiArg](./types.md#dateinlinemultiarg) | |
|
|
376
|
+
| `message` | yes | string | |
|
|
377
|
+
| `type` | yes | string | |
|
|
378
|
+
|
|
379
|
+
No additional properties.
|
|
380
|
+
|
|
381
|
+
## DateRangeArg
|
|
382
|
+
|
|
383
|
+
### Fields
|
|
384
|
+
|
|
385
|
+
_No fields._
|
|
386
|
+
|
|
387
|
+
Additional properties: unknown.
|
|
388
|
+
|
|
389
|
+
## DateRangeCheck
|
|
390
|
+
|
|
391
|
+
### Fields
|
|
392
|
+
|
|
393
|
+
| Name | Required | Type | Description |
|
|
394
|
+
|---|---:|---|---|
|
|
395
|
+
| `args` | no | [DateRangeArg](./types.md#daterangearg) | |
|
|
396
|
+
| `message` | yes | string | |
|
|
397
|
+
| `type` | yes | string | |
|
|
398
|
+
|
|
399
|
+
No additional properties.
|
|
400
|
+
|
|
401
|
+
## DaySelectorArg
|
|
402
|
+
|
|
403
|
+
### Fields
|
|
404
|
+
|
|
405
|
+
_No fields._
|
|
406
|
+
|
|
407
|
+
Additional properties: unknown.
|
|
408
|
+
|
|
409
|
+
## DaySelectorCheck
|
|
410
|
+
|
|
411
|
+
### Fields
|
|
412
|
+
|
|
413
|
+
| Name | Required | Type | Description |
|
|
414
|
+
|---|---:|---|---|
|
|
415
|
+
| `args` | no | [DaySelectorArg](./types.md#dayselectorarg) | |
|
|
416
|
+
| `message` | yes | string | |
|
|
417
|
+
| `type` | yes | string | |
|
|
418
|
+
|
|
419
|
+
No additional properties.
|
|
420
|
+
|
|
421
|
+
## DaySelectorTip
|
|
422
|
+
|
|
423
|
+
### Fields
|
|
424
|
+
|
|
425
|
+
| Name | Required | Type | Description |
|
|
426
|
+
|---|---:|---|---|
|
|
427
|
+
| `content` | yes | string | |
|
|
428
|
+
|
|
429
|
+
No additional properties.
|
|
430
|
+
|
|
431
|
+
## DraggableListList
|
|
432
|
+
|
|
433
|
+
### Fields
|
|
434
|
+
|
|
435
|
+
| Name | Required | Type | Description |
|
|
436
|
+
|---|---:|---|---|
|
|
437
|
+
| `id` | yes | unknown | Unique identifier for the item |
|
|
438
|
+
| `label` | no | string | Display label for the item |
|
|
439
|
+
|
|
440
|
+
No additional properties.
|
|
441
|
+
|
|
442
|
+
## DropdownList
|
|
443
|
+
|
|
444
|
+
### Fields
|
|
445
|
+
|
|
446
|
+
| Name | Required | Type | Description |
|
|
447
|
+
|---|---:|---|---|
|
|
448
|
+
| `label` | yes | string | Display text for the dropdown item |
|
|
449
|
+
| `value` | yes | string | Value identifier for the dropdown item |
|
|
450
|
+
|
|
451
|
+
No additional properties.
|
|
452
|
+
|
|
453
|
+
## DropdownList2
|
|
454
|
+
|
|
455
|
+
### Fields
|
|
456
|
+
|
|
457
|
+
| Name | Required | Type | Description |
|
|
458
|
+
|---|---:|---|---|
|
|
459
|
+
| `disabledInfo` | no | unknown | Tooltip content shown when the option is disabled |
|
|
460
|
+
| `isDisabled` | no | boolean | Disables this option |
|
|
461
|
+
| `label` | yes | string | Display text for the option |
|
|
462
|
+
| `labelIcon` | no | string | Icon name to show next to the label |
|
|
463
|
+
| `leftIconType` | no | string | Icon name to show on the left side of the item |
|
|
464
|
+
| `quaternaryLabel` | no | string | Quaternary text below the tertiary label |
|
|
465
|
+
| `secondaryLabel` | no | string | Secondary text below the main label |
|
|
466
|
+
| `tag` | no | string | Tag label shown beside the option text |
|
|
467
|
+
| `tertiaryLabel` | no | string | Tertiary text below the secondary label |
|
|
468
|
+
| `type` | no | [DropdownList2Type](./definitions.md#dropdownlist2type) | Visual style type for the option (WARNING or ALERT) |
|
|
469
|
+
| `value` | yes | string | Unique value for the option |
|
|
470
|
+
|
|
471
|
+
No additional properties.
|
|
472
|
+
|
|
473
|
+
## EmailArg
|
|
474
|
+
|
|
475
|
+
### Fields
|
|
476
|
+
|
|
477
|
+
_No fields._
|
|
478
|
+
|
|
479
|
+
Additional properties: unknown.
|
|
480
|
+
|
|
481
|
+
## EmailCheck
|
|
482
|
+
|
|
483
|
+
### Fields
|
|
484
|
+
|
|
485
|
+
| Name | Required | Type | Description |
|
|
486
|
+
|---|---:|---|---|
|
|
487
|
+
| `args` | no | [EmailArg](./types.md#emailarg) | |
|
|
488
|
+
| `message` | yes | string | |
|
|
489
|
+
| `type` | yes | string | |
|
|
490
|
+
|
|
491
|
+
No additional properties.
|
|
492
|
+
|
|
493
|
+
## FileDropArg
|
|
494
|
+
|
|
495
|
+
### Fields
|
|
496
|
+
|
|
497
|
+
_No fields._
|
|
498
|
+
|
|
499
|
+
Additional properties: unknown.
|
|
500
|
+
|
|
501
|
+
## FileDropCheck
|
|
502
|
+
|
|
503
|
+
### Fields
|
|
504
|
+
|
|
505
|
+
| Name | Required | Type | Description |
|
|
506
|
+
|---|---:|---|---|
|
|
507
|
+
| `args` | no | [FileDropArg](./types.md#filedroparg) | |
|
|
508
|
+
| `message` | yes | string | |
|
|
509
|
+
| `type` | yes | string | |
|
|
510
|
+
|
|
511
|
+
No additional properties.
|
|
512
|
+
|
|
513
|
+
## FileDropCropperConfig
|
|
514
|
+
|
|
515
|
+
Cropper configuration
|
|
516
|
+
|
|
517
|
+
### Fields
|
|
518
|
+
|
|
519
|
+
| Name | Required | Type | Description |
|
|
520
|
+
|---|---:|---|---|
|
|
521
|
+
| `aspectRatio` | no | [FileDropCropperConfigAspectRatio](./definitions.md#filedropcropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
522
|
+
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
523
|
+
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
524
|
+
| `title` | no | string | Title for the cropper modal |
|
|
525
|
+
|
|
526
|
+
No additional properties.
|
|
527
|
+
|
|
528
|
+
## FileDropDefaultValue
|
|
529
|
+
|
|
530
|
+
### Fields
|
|
531
|
+
|
|
532
|
+
| Name | Required | Type | Description |
|
|
533
|
+
|---|---:|---|---|
|
|
534
|
+
| `name` | no | string | File name |
|
|
535
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
536
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
537
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
538
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
539
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
540
|
+
| `type` | no | string | MIME type of the file |
|
|
541
|
+
| `url` | no | string | URL of the uploaded file |
|
|
542
|
+
|
|
543
|
+
No additional properties.
|
|
544
|
+
|
|
545
|
+
## FileDropValue
|
|
546
|
+
|
|
547
|
+
### Fields
|
|
548
|
+
|
|
549
|
+
| Name | Required | Type | Description |
|
|
550
|
+
|---|---:|---|---|
|
|
551
|
+
| `name` | no | string | File name |
|
|
552
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
553
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
554
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
555
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
556
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
557
|
+
| `type` | no | string | MIME type of the file |
|
|
558
|
+
| `url` | no | string | URL of the uploaded file |
|
|
559
|
+
|
|
560
|
+
No additional properties.
|
|
561
|
+
|
|
562
|
+
## FormCheckboxGroupOption
|
|
563
|
+
|
|
564
|
+
### Fields
|
|
565
|
+
|
|
566
|
+
| Name | Required | Type | Description |
|
|
567
|
+
|---|---:|---|---|
|
|
568
|
+
| `isDisabled` | no | boolean | Disables this specific checkbox |
|
|
569
|
+
| `label` | yes | string | Display text for the checkbox option |
|
|
570
|
+
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
571
|
+
| `tag` | no | unknown | Optional tag/label displayed with the option |
|
|
572
|
+
| `tip` | no | string | Tooltip text shown on hover |
|
|
573
|
+
| `value` | yes | unknown | Value stored when option is selected |
|
|
574
|
+
|
|
575
|
+
No additional properties.
|
|
576
|
+
|
|
577
|
+
## FormCheckboxGroupValidationError
|
|
578
|
+
|
|
579
|
+
Map of rule name to error message
|
|
580
|
+
|
|
581
|
+
### Fields
|
|
582
|
+
|
|
583
|
+
_No fields._
|
|
584
|
+
|
|
585
|
+
Additional properties: string.
|
|
586
|
+
|
|
587
|
+
## FormCheckboxValidationError
|
|
588
|
+
|
|
589
|
+
Map of rule name to error message
|
|
590
|
+
|
|
591
|
+
### Fields
|
|
592
|
+
|
|
593
|
+
_No fields._
|
|
594
|
+
|
|
595
|
+
Additional properties: string.
|
|
596
|
+
|
|
597
|
+
## FormCurrencyValidationError
|
|
598
|
+
|
|
599
|
+
Map of rule name to error message
|
|
600
|
+
|
|
601
|
+
### Fields
|
|
602
|
+
|
|
603
|
+
_No fields._
|
|
604
|
+
|
|
605
|
+
Additional properties: string.
|
|
606
|
+
|
|
607
|
+
## FormDateRangeValidationError
|
|
608
|
+
|
|
609
|
+
Map of rule name to error message
|
|
610
|
+
|
|
611
|
+
### Fields
|
|
612
|
+
|
|
613
|
+
_No fields._
|
|
614
|
+
|
|
615
|
+
Additional properties: string.
|
|
616
|
+
|
|
617
|
+
## FormDateValidationError
|
|
618
|
+
|
|
619
|
+
Map of rule name to error message
|
|
620
|
+
|
|
621
|
+
### Fields
|
|
622
|
+
|
|
623
|
+
_No fields._
|
|
624
|
+
|
|
625
|
+
Additional properties: string.
|
|
626
|
+
|
|
627
|
+
## FormDaySelectorValidationError
|
|
628
|
+
|
|
629
|
+
Map of rule name to error message
|
|
630
|
+
|
|
631
|
+
### Fields
|
|
632
|
+
|
|
633
|
+
_No fields._
|
|
634
|
+
|
|
635
|
+
Additional properties: string.
|
|
636
|
+
|
|
637
|
+
## FormEmailValidationError
|
|
638
|
+
|
|
639
|
+
Map of rule name to error message
|
|
640
|
+
|
|
641
|
+
### Fields
|
|
642
|
+
|
|
643
|
+
_No fields._
|
|
644
|
+
|
|
645
|
+
Additional properties: string.
|
|
646
|
+
|
|
647
|
+
## FormFileCropperConfig
|
|
648
|
+
|
|
649
|
+
Cropper configuration
|
|
650
|
+
|
|
651
|
+
### Fields
|
|
652
|
+
|
|
653
|
+
| Name | Required | Type | Description |
|
|
654
|
+
|---|---:|---|---|
|
|
655
|
+
| `aspectRatio` | no | [FileDropCropperConfigAspectRatio](./definitions.md#filedropcropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
656
|
+
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
657
|
+
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
658
|
+
| `title` | no | string | Title for the cropper modal |
|
|
659
|
+
|
|
660
|
+
No additional properties.
|
|
661
|
+
|
|
662
|
+
## FormFileDefaultValue
|
|
663
|
+
|
|
664
|
+
### Fields
|
|
665
|
+
|
|
666
|
+
| Name | Required | Type | Description |
|
|
667
|
+
|---|---:|---|---|
|
|
668
|
+
| `name` | no | string | File name |
|
|
669
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
670
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
671
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
672
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
673
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
674
|
+
| `type` | no | string | MIME type of the file |
|
|
675
|
+
| `url` | no | string | URL of the uploaded file |
|
|
676
|
+
|
|
677
|
+
No additional properties.
|
|
678
|
+
|
|
679
|
+
## FormFileDropCropperConfig
|
|
680
|
+
|
|
681
|
+
Cropper configuration
|
|
682
|
+
|
|
683
|
+
### Fields
|
|
684
|
+
|
|
685
|
+
| Name | Required | Type | Description |
|
|
686
|
+
|---|---:|---|---|
|
|
687
|
+
| `aspectRatio` | no | [FileDropCropperConfigAspectRatio](./definitions.md#filedropcropperconfigaspectratio) | Aspect ratio for cropper. Default: 1:1 |
|
|
688
|
+
| `enforceAspectRatio` | no | boolean | Enforce the aspect ratio on cropper. Default: true |
|
|
689
|
+
| `showUploadButton` | no | boolean | Show upload button on cropper. Default: true |
|
|
690
|
+
| `title` | no | string | Title for the cropper modal |
|
|
691
|
+
|
|
692
|
+
No additional properties.
|
|
693
|
+
|
|
694
|
+
## FormFileDropDefaultValue
|
|
695
|
+
|
|
696
|
+
### Fields
|
|
697
|
+
|
|
698
|
+
| Name | Required | Type | Description |
|
|
699
|
+
|---|---:|---|---|
|
|
700
|
+
| `name` | no | string | File name |
|
|
701
|
+
| `content` | no | string | File content as a base64 data URL |
|
|
702
|
+
| `hasError` | no | boolean | Whether the file has an error |
|
|
703
|
+
| `previewUrl` | no | string | Preview URL for the file |
|
|
704
|
+
| `progress` | no | number | Upload progress 0-100 |
|
|
705
|
+
| `tooltipText` | no | string | Tooltip text shown on error |
|
|
706
|
+
| `type` | no | string | MIME type of the file |
|
|
707
|
+
| `url` | no | string | URL of the uploaded file |
|
|
708
|
+
|
|
709
|
+
No additional properties.
|
|
710
|
+
|
|
711
|
+
## FormFileDropValidationError
|
|
712
|
+
|
|
713
|
+
Map of rule name to error message
|
|
714
|
+
|
|
715
|
+
### Fields
|
|
716
|
+
|
|
717
|
+
_No fields._
|
|
718
|
+
|
|
719
|
+
Additional properties: string.
|
|
720
|
+
|
|
721
|
+
## FormFileDropValue
|
|
722
|
+
|
|
723
|
+
### Fields
|
|
724
|
+
|
|
725
|
+
| Name | Required | Type | Description |
|
|
726
|
+
|---|---:|---|---|
|
|
727
|
+
| `name` | no | string | |
|
|
728
|
+
| `content` | no | string | |
|
|
729
|
+
| `hasError` | no | boolean | |
|
|
730
|
+
| `previewUrl` | no | string | |
|
|
731
|
+
| `progress` | no | number | |
|
|
732
|
+
| `tooltipText` | no | string | |
|
|
733
|
+
| `type` | no | string | |
|
|
734
|
+
| `url` | no | string | |
|
|
735
|
+
|
|
736
|
+
No additional properties.
|
|
737
|
+
|
|
738
|
+
## FormFileValidationError
|
|
739
|
+
|
|
740
|
+
Map of rule name to error message
|
|
741
|
+
|
|
742
|
+
### Fields
|
|
743
|
+
|
|
744
|
+
_No fields._
|
|
745
|
+
|
|
746
|
+
Additional properties: string.
|
|
747
|
+
|
|
748
|
+
## FormFileValue
|
|
749
|
+
|
|
750
|
+
### Fields
|
|
751
|
+
|
|
752
|
+
| Name | Required | Type | Description |
|
|
753
|
+
|---|---:|---|---|
|
|
754
|
+
| `name` | no | string | |
|
|
755
|
+
| `content` | no | string | |
|
|
756
|
+
| `hasError` | no | boolean | |
|
|
757
|
+
| `previewUrl` | no | string | |
|
|
758
|
+
| `progress` | no | number | |
|
|
759
|
+
| `tooltipText` | no | string | |
|
|
760
|
+
| `type` | no | string | |
|
|
761
|
+
| `url` | no | string | |
|
|
762
|
+
|
|
763
|
+
No additional properties.
|
|
764
|
+
|
|
765
|
+
## FormInputGroupInput
|
|
766
|
+
|
|
767
|
+
Main input configuration with type and inputProps
|
|
768
|
+
|
|
769
|
+
### Fields
|
|
770
|
+
|
|
771
|
+
| Name | Required | Type | Description |
|
|
772
|
+
|---|---:|---|---|
|
|
773
|
+
| `inputProps` | yes | [FormInputGroupInputProp](./types.md#forminputgroupinputprop) | Props to pass to the input component |
|
|
774
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
775
|
+
|
|
776
|
+
No additional properties.
|
|
777
|
+
|
|
778
|
+
## FormInputGroupInputProp
|
|
779
|
+
|
|
780
|
+
Props to pass to the input component
|
|
781
|
+
|
|
782
|
+
### Fields
|
|
783
|
+
|
|
784
|
+
_No fields._
|
|
785
|
+
|
|
786
|
+
Additional properties: unknown.
|
|
787
|
+
|
|
788
|
+
## FormInputGroupValidationError
|
|
789
|
+
|
|
790
|
+
Map of rule name to error message
|
|
791
|
+
|
|
792
|
+
### Fields
|
|
793
|
+
|
|
794
|
+
_No fields._
|
|
795
|
+
|
|
796
|
+
Additional properties: string.
|
|
797
|
+
|
|
798
|
+
## FormMaskerValidationError
|
|
799
|
+
|
|
800
|
+
Map of rule name to error message
|
|
801
|
+
|
|
802
|
+
### Fields
|
|
803
|
+
|
|
804
|
+
_No fields._
|
|
805
|
+
|
|
806
|
+
Additional properties: string.
|
|
807
|
+
|
|
808
|
+
## FormNumberValidationError
|
|
809
|
+
|
|
810
|
+
Map of rule name to error message
|
|
811
|
+
|
|
812
|
+
### Fields
|
|
813
|
+
|
|
814
|
+
_No fields._
|
|
815
|
+
|
|
816
|
+
Additional properties: string.
|
|
817
|
+
|
|
818
|
+
## FormPasswordValidationError
|
|
819
|
+
|
|
820
|
+
Map of rule name to error message
|
|
821
|
+
|
|
822
|
+
### Fields
|
|
823
|
+
|
|
824
|
+
_No fields._
|
|
825
|
+
|
|
826
|
+
Additional properties: string.
|
|
827
|
+
|
|
828
|
+
## FormPercentageValidationError
|
|
829
|
+
|
|
830
|
+
Map of rule name to error message
|
|
831
|
+
|
|
832
|
+
### Fields
|
|
833
|
+
|
|
834
|
+
_No fields._
|
|
835
|
+
|
|
836
|
+
Additional properties: string.
|
|
837
|
+
|
|
838
|
+
## FormPhoneValidationError
|
|
839
|
+
|
|
840
|
+
Map of rule name to error message
|
|
841
|
+
|
|
842
|
+
### Fields
|
|
843
|
+
|
|
844
|
+
_No fields._
|
|
845
|
+
|
|
846
|
+
Additional properties: string.
|
|
847
|
+
|
|
848
|
+
## FormRadioOption
|
|
849
|
+
|
|
850
|
+
### Fields
|
|
851
|
+
|
|
852
|
+
| Name | Required | Type | Description |
|
|
853
|
+
|---|---:|---|---|
|
|
854
|
+
| `isActive` | no | boolean | Controls focus state of the option |
|
|
855
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
856
|
+
| `label` | yes | string | Display text for the option |
|
|
857
|
+
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
858
|
+
| `tag` | no | unknown | Optional tag/label displayed with the option |
|
|
859
|
+
| `tip` | no | string | Tooltip text shown on hover |
|
|
860
|
+
| `value` | yes | unknown | Value stored when option is selected |
|
|
861
|
+
|
|
862
|
+
No additional properties.
|
|
863
|
+
|
|
864
|
+
## FormRadioValidationError
|
|
865
|
+
|
|
866
|
+
Map of rule name to error message
|
|
867
|
+
|
|
868
|
+
### Fields
|
|
869
|
+
|
|
870
|
+
_No fields._
|
|
871
|
+
|
|
872
|
+
Additional properties: string.
|
|
873
|
+
|
|
874
|
+
## FormSegmentedControlOption
|
|
875
|
+
|
|
876
|
+
### Fields
|
|
877
|
+
|
|
878
|
+
| Name | Required | Type | Description |
|
|
879
|
+
|---|---:|---|---|
|
|
880
|
+
| `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style for this specific option |
|
|
881
|
+
| `aria-label` | no | string | Accessible label, required if label is not provided (e.g. for icon-only items) |
|
|
882
|
+
| `icon` | no | string | Icon to display for icon-only items. Requires aria-label or label for accessibility |
|
|
883
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
884
|
+
| `label` | no | string | Display text for the option |
|
|
885
|
+
| `tip` | no | [FormSegmentedControlTip](./types.md#formsegmentedcontroltip) | Tooltip to show on hover for this option |
|
|
886
|
+
| `value` | yes | string | Value stored when option is selected |
|
|
887
|
+
|
|
888
|
+
No additional properties.
|
|
889
|
+
|
|
890
|
+
## FormSegmentedControlTip
|
|
891
|
+
|
|
892
|
+
Tooltip to show on hover for this option
|
|
893
|
+
|
|
894
|
+
### Fields
|
|
895
|
+
|
|
896
|
+
| Name | Required | Type | Description |
|
|
897
|
+
|---|---:|---|---|
|
|
898
|
+
| `content` | yes | string | Tooltip text content |
|
|
899
|
+
|
|
900
|
+
No additional properties.
|
|
901
|
+
|
|
902
|
+
## FormSegmentedControlValidationError
|
|
903
|
+
|
|
904
|
+
Map of rule name to error message
|
|
905
|
+
|
|
906
|
+
### Fields
|
|
907
|
+
|
|
908
|
+
_No fields._
|
|
909
|
+
|
|
910
|
+
Additional properties: string.
|
|
911
|
+
|
|
912
|
+
## FormSelectableGroupList
|
|
913
|
+
|
|
914
|
+
### Fields
|
|
915
|
+
|
|
916
|
+
_No fields._
|
|
917
|
+
|
|
918
|
+
Additional properties: unknown.
|
|
919
|
+
|
|
920
|
+
## FormSelectableGroupValidationError
|
|
921
|
+
|
|
922
|
+
Map of rule name to error message
|
|
923
|
+
|
|
924
|
+
### Fields
|
|
925
|
+
|
|
926
|
+
_No fields._
|
|
927
|
+
|
|
928
|
+
Additional properties: string.
|
|
929
|
+
|
|
930
|
+
## FormSelectValidationError
|
|
931
|
+
|
|
932
|
+
Map of rule name to error message
|
|
933
|
+
|
|
934
|
+
### Fields
|
|
935
|
+
|
|
936
|
+
_No fields._
|
|
937
|
+
|
|
938
|
+
Additional properties: string.
|
|
939
|
+
|
|
940
|
+
## FormSignatureValidationError
|
|
941
|
+
|
|
942
|
+
Map of rule name to error message
|
|
943
|
+
|
|
944
|
+
### Fields
|
|
945
|
+
|
|
946
|
+
_No fields._
|
|
947
|
+
|
|
948
|
+
Additional properties: string.
|
|
949
|
+
|
|
950
|
+
## FormSinValidationError
|
|
951
|
+
|
|
952
|
+
Map of rule name to error message
|
|
953
|
+
|
|
954
|
+
### Fields
|
|
955
|
+
|
|
956
|
+
_No fields._
|
|
957
|
+
|
|
958
|
+
Additional properties: string.
|
|
959
|
+
|
|
960
|
+
## FormSliderMark
|
|
961
|
+
|
|
962
|
+
Named marks on the slider track. Keys are numeric positions, values are labels
|
|
963
|
+
|
|
964
|
+
### Fields
|
|
965
|
+
|
|
966
|
+
_No fields._
|
|
967
|
+
|
|
968
|
+
Additional properties: string.
|
|
969
|
+
|
|
970
|
+
## FormSliderValidationError
|
|
971
|
+
|
|
972
|
+
Map of rule name to error message
|
|
973
|
+
|
|
974
|
+
### Fields
|
|
975
|
+
|
|
976
|
+
_No fields._
|
|
977
|
+
|
|
978
|
+
Additional properties: string.
|
|
979
|
+
|
|
980
|
+
## FormSsnValidationError
|
|
981
|
+
|
|
982
|
+
Map of rule name to error message
|
|
983
|
+
|
|
984
|
+
### Fields
|
|
985
|
+
|
|
986
|
+
_No fields._
|
|
987
|
+
|
|
988
|
+
Additional properties: string.
|
|
989
|
+
|
|
990
|
+
## FormSurveyList
|
|
991
|
+
|
|
992
|
+
### Fields
|
|
993
|
+
|
|
994
|
+
| Name | Required | Type | Description |
|
|
995
|
+
|---|---:|---|---|
|
|
996
|
+
| `isDisabled` | no | boolean | Disable this specific option |
|
|
997
|
+
| `label` | no | unknown | Display label for the option |
|
|
998
|
+
| `selectionColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Override selected surface color token for this option |
|
|
999
|
+
| `value` | yes | unknown | Value when selected |
|
|
1000
|
+
|
|
1001
|
+
No additional properties.
|
|
1002
|
+
|
|
1003
|
+
## FormSurveyRangeLabel
|
|
1004
|
+
|
|
1005
|
+
Labels for lowest and highest options
|
|
1006
|
+
|
|
1007
|
+
### Fields
|
|
1008
|
+
|
|
1009
|
+
| Name | Required | Type | Description |
|
|
1010
|
+
|---|---:|---|---|
|
|
1011
|
+
| `lower` | yes | string | Label for the lowest option |
|
|
1012
|
+
| `upper` | yes | string | Label for the highest option |
|
|
1013
|
+
|
|
1014
|
+
No additional properties.
|
|
1015
|
+
|
|
1016
|
+
## FormSurveyValidationError
|
|
1017
|
+
|
|
1018
|
+
Map of rule name to error message
|
|
1019
|
+
|
|
1020
|
+
### Fields
|
|
1021
|
+
|
|
1022
|
+
_No fields._
|
|
1023
|
+
|
|
1024
|
+
Additional properties: string.
|
|
1025
|
+
|
|
1026
|
+
## FormSwitchValidationError
|
|
1027
|
+
|
|
1028
|
+
Map of rule name to error message
|
|
1029
|
+
|
|
1030
|
+
### Fields
|
|
1031
|
+
|
|
1032
|
+
_No fields._
|
|
1033
|
+
|
|
1034
|
+
Additional properties: string.
|
|
1035
|
+
|
|
1036
|
+
## FormTextareaValidationError
|
|
1037
|
+
|
|
1038
|
+
Map of rule name to error message
|
|
1039
|
+
|
|
1040
|
+
### Fields
|
|
1041
|
+
|
|
1042
|
+
_No fields._
|
|
1043
|
+
|
|
1044
|
+
Additional properties: string.
|
|
1045
|
+
|
|
1046
|
+
## FormTextAutoSuggestSuggestion
|
|
1047
|
+
|
|
1048
|
+
### Fields
|
|
1049
|
+
|
|
1050
|
+
| Name | Required | Type | Description |
|
|
1051
|
+
|---|---:|---|---|
|
|
1052
|
+
| `label` | yes | string | Display text for the suggestion |
|
|
1053
|
+
| `value` | yes | unknown | Value stored when suggestion is selected |
|
|
1054
|
+
|
|
1055
|
+
No additional properties.
|
|
1056
|
+
|
|
1057
|
+
## FormTextAutoSuggestValidationError
|
|
1058
|
+
|
|
1059
|
+
Map of rule name to error message
|
|
1060
|
+
|
|
1061
|
+
### Fields
|
|
1062
|
+
|
|
1063
|
+
_No fields._
|
|
1064
|
+
|
|
1065
|
+
Additional properties: string.
|
|
1066
|
+
|
|
1067
|
+
## FormTextValidationError
|
|
1068
|
+
|
|
1069
|
+
Map of rule name to error message
|
|
1070
|
+
|
|
1071
|
+
### Fields
|
|
1072
|
+
|
|
1073
|
+
_No fields._
|
|
1074
|
+
|
|
1075
|
+
Additional properties: string.
|
|
1076
|
+
|
|
1077
|
+
## FormTimeValidationError
|
|
1078
|
+
|
|
1079
|
+
Map of rule name to error message
|
|
1080
|
+
|
|
1081
|
+
### Fields
|
|
1082
|
+
|
|
1083
|
+
_No fields._
|
|
1084
|
+
|
|
1085
|
+
Additional properties: string.
|
|
1086
|
+
|
|
1087
|
+
## FormTimezoneValidationError
|
|
1088
|
+
|
|
1089
|
+
Map of rule name to error message
|
|
1090
|
+
|
|
1091
|
+
### Fields
|
|
1092
|
+
|
|
1093
|
+
_No fields._
|
|
1094
|
+
|
|
1095
|
+
Additional properties: string.
|
|
1096
|
+
|
|
1097
|
+
## FormTreeFuseOption
|
|
1098
|
+
|
|
1099
|
+
Fuse.js search options for customizing search behavior
|
|
1100
|
+
|
|
1101
|
+
### Fields
|
|
1102
|
+
|
|
1103
|
+
_No fields._
|
|
1104
|
+
|
|
1105
|
+
Additional properties: unknown.
|
|
1106
|
+
|
|
1107
|
+
## FormTreeList
|
|
1108
|
+
|
|
1109
|
+
### Fields
|
|
1110
|
+
|
|
1111
|
+
| Name | Required | Type | Description |
|
|
1112
|
+
|---|---:|---|---|
|
|
1113
|
+
| `disabledInfo` | no | unknown | Tooltip shown when item is disabled |
|
|
1114
|
+
| `isDisabled` | no | boolean | Disable this item |
|
|
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 |
|
|
1120
|
+
|
|
1121
|
+
No additional properties.
|
|
1122
|
+
|
|
1123
|
+
## FormTreeSelectFuseOption
|
|
1124
|
+
|
|
1125
|
+
Fuse.js search configuration. Default: { keys: ["label", "name"] }
|
|
1126
|
+
|
|
1127
|
+
### Fields
|
|
1128
|
+
|
|
1129
|
+
_No fields._
|
|
1130
|
+
|
|
1131
|
+
Additional properties: unknown.
|
|
1132
|
+
|
|
1133
|
+
## FormTreeSelectList
|
|
1134
|
+
|
|
1135
|
+
### Fields
|
|
1136
|
+
|
|
1137
|
+
| Name | Required | Type | Description |
|
|
1138
|
+
|---|---:|---|---|
|
|
1139
|
+
| `isDisabled` | no | boolean | Disable this item |
|
|
1140
|
+
| `label` | yes | string | Display label for the item |
|
|
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 |
|
|
1144
|
+
|
|
1145
|
+
No additional properties.
|
|
1146
|
+
|
|
1147
|
+
## FormTreeSelectValidationError
|
|
1148
|
+
|
|
1149
|
+
Map of rule name to error message
|
|
1150
|
+
|
|
1151
|
+
### Fields
|
|
1152
|
+
|
|
1153
|
+
_No fields._
|
|
1154
|
+
|
|
1155
|
+
Additional properties: string.
|
|
1156
|
+
|
|
1157
|
+
## FormTreeValidationError
|
|
1158
|
+
|
|
1159
|
+
Map of rule name to error message
|
|
1160
|
+
|
|
1161
|
+
### Fields
|
|
1162
|
+
|
|
1163
|
+
_No fields._
|
|
1164
|
+
|
|
1165
|
+
Additional properties: string.
|
|
1166
|
+
|
|
1167
|
+
## FormValidationError
|
|
1168
|
+
|
|
1169
|
+
External validation errors keyed by input name
|
|
1170
|
+
|
|
1171
|
+
### Fields
|
|
1172
|
+
|
|
1173
|
+
_No fields._
|
|
1174
|
+
|
|
1175
|
+
Additional properties: string.
|
|
1176
|
+
|
|
1177
|
+
## FormValue
|
|
1178
|
+
|
|
1179
|
+
Form values model. Written to state on change/submit (read-only — push-only)
|
|
1180
|
+
|
|
1181
|
+
### Fields
|
|
1182
|
+
|
|
1183
|
+
_No fields._
|
|
1184
|
+
|
|
1185
|
+
Additional properties: unknown.
|
|
1186
|
+
|
|
1187
|
+
## FormWorkEmailValidationError
|
|
1188
|
+
|
|
1189
|
+
Map of rule name to error message
|
|
1190
|
+
|
|
1191
|
+
### Fields
|
|
1192
|
+
|
|
1193
|
+
_No fields._
|
|
1194
|
+
|
|
1195
|
+
Additional properties: string.
|
|
1196
|
+
|
|
1197
|
+
## GridAction
|
|
1198
|
+
|
|
1199
|
+
### Fields
|
|
1200
|
+
|
|
1201
|
+
| Name | Required | Type | Description |
|
|
1202
|
+
|---|---:|---|---|
|
|
1203
|
+
| `aria-label` | no | string | Accessibility label for the action button |
|
|
1204
|
+
| `aria-labelledby` | no | string | ID of element that labels the action button |
|
|
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 |
|
|
1210
|
+
|
|
1211
|
+
No additional properties.
|
|
1212
|
+
|
|
1213
|
+
## InputGroupInput
|
|
1214
|
+
|
|
1215
|
+
Main input configuration with type and inputProps
|
|
1216
|
+
|
|
1217
|
+
### Fields
|
|
1218
|
+
|
|
1219
|
+
| Name | Required | Type | Description |
|
|
1220
|
+
|---|---:|---|---|
|
|
1221
|
+
| `inputProps` | yes | [InputGroupInputProp](./types.md#inputgroupinputprop) | Props to pass to the input component |
|
|
1222
|
+
| `type` | yes | [FormInputGroupInputType](./definitions.md#forminputgroupinputtype) | Input component type |
|
|
1223
|
+
|
|
1224
|
+
No additional properties.
|
|
1225
|
+
|
|
1226
|
+
## InputGroupInputProp
|
|
1227
|
+
|
|
1228
|
+
Props to pass to the input component
|
|
1229
|
+
|
|
1230
|
+
### Fields
|
|
1231
|
+
|
|
1232
|
+
_No fields._
|
|
1233
|
+
|
|
1234
|
+
Additional properties: unknown.
|
|
1235
|
+
|
|
1236
|
+
## LayoutValue
|
|
1237
|
+
|
|
1238
|
+
### Fields
|
|
1239
|
+
|
|
1240
|
+
| Name | Required | Type | Description |
|
|
1241
|
+
|---|---:|---|---|
|
|
1242
|
+
| `border` | no | string | CSS border applied to the block wrapper, e.g. "1px solid #E0E0E0". |
|
|
1243
|
+
| `height` | no | number | Height in grid units. Default: 1 |
|
|
1244
|
+
| `identifier` | yes | string | Unique identifier for this layout entry. MUST exactly match the spec id of one of the board's direct child elements — that child is rendered inside this block. |
|
|
1245
|
+
| `maxHeight` | no | number | Maximum height in grid units |
|
|
1246
|
+
| `maxWidth` | no | number | Maximum width in grid units |
|
|
1247
|
+
| `minHeight` | no | number | Minimum height in grid units |
|
|
1248
|
+
| `minWidth` | no | number | Minimum width in grid units |
|
|
1249
|
+
| `shadow` | no | [LayoutValueShadow](./definitions.md#layoutvalueshadow) | Shadow token applied to the block wrapper, e.g. "shadowSm". |
|
|
1250
|
+
| `shapeCorner` | no | [HStackRadius](./definitions.md#hstackradius) | Shape-corner radius token for this block, e.g. "shapeCornerMd". Overrides the parent board `blockShapeCorner` for this entry only. |
|
|
1251
|
+
| `width` | no | number | Width in grid units (1–12). Default: 3 |
|
|
1252
|
+
|
|
1253
|
+
No additional properties.
|
|
1254
|
+
|
|
1255
|
+
## LinkValue
|
|
1256
|
+
|
|
1257
|
+
### Fields
|
|
1258
|
+
|
|
1259
|
+
| Name | Required | Type | Description |
|
|
1260
|
+
|---|---:|---|---|
|
|
1261
|
+
| `badge` | no | [AppNavBarBadge](./types.md#appnavbarbadge) | Badge shown next to the nav item title |
|
|
1262
|
+
| `icon` | no | string | Icon name from Icon.TYPES (e.g. FOLDER_OUTLINE) |
|
|
1263
|
+
| `isSection` | no | boolean | If true, renders as a non-interactive section header (vertical mode only) |
|
|
1264
|
+
| `links` | no | [LinkValue](./types.md#linkvalue)[] | Nested sub-navigation items |
|
|
1265
|
+
| `path` | no | string | URL path segment for this nav item |
|
|
1266
|
+
| `queryParams` | no | [QueryParam](./types.md#queryparam) | Query parameters to append when navigating to this item |
|
|
1267
|
+
| `title` | yes | string | Display label for this nav item |
|
|
1268
|
+
|
|
1269
|
+
No additional properties.
|
|
1270
|
+
|
|
1271
|
+
## Location
|
|
1272
|
+
|
|
1273
|
+
Location object with nickname and address. Required for displaying location information
|
|
1274
|
+
|
|
1275
|
+
### Fields
|
|
1276
|
+
|
|
1277
|
+
| Name | Required | Type | Description |
|
|
1278
|
+
|---|---:|---|---|
|
|
1279
|
+
| `address` | yes | [Addres](./types.md#addres) | Address object with street, city, state, country, and zip |
|
|
1280
|
+
| `nickname` | yes | string | Location nickname or display name |
|
|
1281
|
+
|
|
1282
|
+
No additional properties.
|
|
1283
|
+
|
|
1284
|
+
## LocationCardAction
|
|
1285
|
+
|
|
1286
|
+
### Fields
|
|
1287
|
+
|
|
1288
|
+
| Name | Required | Type | Description |
|
|
1289
|
+
|---|---:|---|---|
|
|
1290
|
+
| `icon` | no | string | Icon name from Icon.TYPES (e.g. "EDIT", "DELETE") |
|
|
1291
|
+
| `id` | yes | string | Unique identifier for the action |
|
|
1292
|
+
| `label` | yes | string | Label text for the action |
|
|
1293
|
+
|
|
1294
|
+
No additional properties.
|
|
1295
|
+
|
|
1296
|
+
## MaskerArg
|
|
1297
|
+
|
|
1298
|
+
### Fields
|
|
1299
|
+
|
|
1300
|
+
_No fields._
|
|
1301
|
+
|
|
1302
|
+
Additional properties: unknown.
|
|
1303
|
+
|
|
1304
|
+
## MaskerCheck
|
|
1305
|
+
|
|
1306
|
+
### Fields
|
|
1307
|
+
|
|
1308
|
+
| Name | Required | Type | Description |
|
|
1309
|
+
|---|---:|---|---|
|
|
1310
|
+
| `args` | no | [MaskerArg](./types.md#maskerarg) | |
|
|
1311
|
+
| `message` | yes | string | |
|
|
1312
|
+
| `type` | yes | string | |
|
|
1313
|
+
|
|
1314
|
+
No additional properties.
|
|
1315
|
+
|
|
1316
|
+
## MenuListList
|
|
1317
|
+
|
|
1318
|
+
### Fields
|
|
1319
|
+
|
|
1320
|
+
| Name | Required | Type | Description |
|
|
1321
|
+
|---|---:|---|---|
|
|
1322
|
+
| `description` | no | string | Description text shown inline with the label |
|
|
1323
|
+
| `disabledInfo` | no | string | Tooltip text shown for disabled items |
|
|
1324
|
+
| `isDisabled` | no | boolean | Disables this menu item |
|
|
1325
|
+
| `label` | yes | string | Display text for the menu item |
|
|
1326
|
+
| `leftIconType` | no | string | Icon name to show on the left side of the item |
|
|
1327
|
+
| `quaternaryLabel` | no | string | Quaternary text shown below tertiary label |
|
|
1328
|
+
| `rightLabel` | no | string | Text shown on the right side of the item |
|
|
1329
|
+
| `secondaryLabel` | no | string | Secondary text shown below the label |
|
|
1330
|
+
| `tag` | no | string | Tag label shown beside the item text |
|
|
1331
|
+
| `tertiaryLabel` | no | string | Tertiary text shown below secondary label |
|
|
1332
|
+
| `type` | no | [DropdownList2Type](./definitions.md#dropdownlist2type) | Visual style type for the item (WARNING or ALERT) |
|
|
1333
|
+
| `value` | yes | string | Unique value for the item |
|
|
1334
|
+
|
|
1335
|
+
No additional properties.
|
|
1336
|
+
|
|
1337
|
+
## Metadata
|
|
1338
|
+
|
|
1339
|
+
Arbitrary key/value context forwarded to the global SnackBar.onTrigger callback. Useful for analytics/logging (e.g. { source: "ProfilePage" })
|
|
1340
|
+
|
|
1341
|
+
### Fields
|
|
1342
|
+
|
|
1343
|
+
_No fields._
|
|
1344
|
+
|
|
1345
|
+
Additional properties: unknown.
|
|
1346
|
+
|
|
1347
|
+
## NestedListList
|
|
1348
|
+
|
|
1349
|
+
### Fields
|
|
1350
|
+
|
|
1351
|
+
| Name | Required | Type | Description |
|
|
1352
|
+
|---|---:|---|---|
|
|
1353
|
+
| `branches` | no | [NestedListList](./types.md#nestedlistlist)[] | Child items |
|
|
1354
|
+
| `isDefaultOpen` | no | boolean | Start expanded |
|
|
1355
|
+
| `label` | yes | string | Display text for the item |
|
|
1356
|
+
| `value` | no | string | Unique value for the item |
|
|
1357
|
+
|
|
1358
|
+
No additional properties.
|
|
1359
|
+
|
|
1360
|
+
## NumberArg
|
|
1361
|
+
|
|
1362
|
+
### Fields
|
|
1363
|
+
|
|
1364
|
+
_No fields._
|
|
1365
|
+
|
|
1366
|
+
Additional properties: unknown.
|
|
1367
|
+
|
|
1368
|
+
## NumberCheck
|
|
1369
|
+
|
|
1370
|
+
### Fields
|
|
1371
|
+
|
|
1372
|
+
| Name | Required | Type | Description |
|
|
1373
|
+
|---|---:|---|---|
|
|
1374
|
+
| `args` | no | [NumberArg](./types.md#numberarg) | |
|
|
1375
|
+
| `message` | yes | string | |
|
|
1376
|
+
| `type` | yes | string | |
|
|
1377
|
+
|
|
1378
|
+
No additional properties.
|
|
1379
|
+
|
|
1380
|
+
## NumberStringPadding
|
|
1381
|
+
|
|
1382
|
+
Adds padding characters to the input value
|
|
1383
|
+
|
|
1384
|
+
### Fields
|
|
1385
|
+
|
|
1386
|
+
| Name | Required | Type | Description |
|
|
1387
|
+
|---|---:|---|---|
|
|
1388
|
+
| `character` | yes | string | Character to use for padding |
|
|
1389
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1390
|
+
| `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Position to pad (start or end) |
|
|
1391
|
+
|
|
1392
|
+
No additional properties.
|
|
1393
|
+
|
|
1394
|
+
## ObjectUIAvatarProp
|
|
1395
|
+
|
|
1396
|
+
Avatar configuration for the header
|
|
1397
|
+
|
|
1398
|
+
### Fields
|
|
1399
|
+
|
|
1400
|
+
| Name | Required | Type | Description |
|
|
1401
|
+
|---|---:|---|---|
|
|
1402
|
+
| `icon` | no | string | Icon type string when type is ICON |
|
|
1403
|
+
| `image` | no | string | Image URL for the avatar |
|
|
1404
|
+
| `imageBackground` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Surface color token for avatar image background |
|
|
1405
|
+
| `isRound` | no | boolean | If false, square avatar is shown. Default: true |
|
|
1406
|
+
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
|
|
1407
|
+
|
|
1408
|
+
No additional properties.
|
|
1409
|
+
|
|
1410
|
+
## ObjectUIHeaderAvatarProp
|
|
1411
|
+
|
|
1412
|
+
Avatar configuration for the header
|
|
1413
|
+
|
|
1414
|
+
### Fields
|
|
1415
|
+
|
|
1416
|
+
| Name | Required | Type | Description |
|
|
1417
|
+
|---|---:|---|---|
|
|
1418
|
+
| `icon` | no | string | Icon type string when type is ICON |
|
|
1419
|
+
| `image` | no | string | Image URL for the avatar |
|
|
1420
|
+
| `imageBackground` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Surface color token for avatar image background |
|
|
1421
|
+
| `isRound` | no | boolean | If false, square avatar is shown. Default: true |
|
|
1422
|
+
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
|
|
1423
|
+
|
|
1424
|
+
No additional properties.
|
|
1425
|
+
|
|
1426
|
+
## ObjectUIStatsAction
|
|
1427
|
+
|
|
1428
|
+
### Fields
|
|
1429
|
+
|
|
1430
|
+
| Name | Required | Type | Description |
|
|
1431
|
+
|---|---:|---|---|
|
|
1432
|
+
| `aria-label` | no | string | Accessibility label for the action button |
|
|
1433
|
+
| `aria-labelledby` | no | string | ID of element that labels the action button |
|
|
1434
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
1435
|
+
| `iconType` | yes | string | Icon type name (e.g., "EDIT_OUTLINE", "DELETE") |
|
|
1436
|
+
| `id` | yes | string | Unique identifier for this action. Written to state on click |
|
|
1437
|
+
| `isDisabled` | no | boolean | Disable the action button. Default: false |
|
|
1438
|
+
| `tip` | no | unknown | Tooltip for the action button. Can be a simple string or tooltip configuration object |
|
|
1439
|
+
|
|
1440
|
+
No additional properties.
|
|
1441
|
+
|
|
1442
|
+
## PageHeaderAction
|
|
1443
|
+
|
|
1444
|
+
### Fields
|
|
1445
|
+
|
|
1446
|
+
| Name | Required | Type | Description |
|
|
1447
|
+
|---|---:|---|---|
|
|
1448
|
+
| `actionType` | no | [PageHeaderActionActionType](./definitions.md#pageheaderactionactiontype) | Type of action component to render. Default: button |
|
|
1449
|
+
| `appearance` | no | [AppNavBarActionAppearance](./definitions.md#appnavbaractionappearance) | Button visual style. Default: PRIMARY |
|
|
1450
|
+
| `icon` | no | string | Icon name from Icon.TYPES (e.g. ADD, EDIT_OUTLINE) |
|
|
1451
|
+
| `id` | yes | string | Unique identifier for the action. Written to actionClickedId state on click |
|
|
1452
|
+
| `isDisabled` | no | boolean | Disables the button. Default: false |
|
|
1453
|
+
| `label` | yes | string | Button text |
|
|
1454
|
+
| `size` | no | [ButtonSize](./definitions.md#buttonsize) | Button size. Default: M |
|
|
1455
|
+
| `variant` | no | [ButtonVariant](./definitions.md#buttonvariant) | Button variant. Default: NORMAL |
|
|
1456
|
+
|
|
1457
|
+
No additional properties.
|
|
1458
|
+
|
|
1459
|
+
## PaginateListList
|
|
1460
|
+
|
|
1461
|
+
### Fields
|
|
1462
|
+
|
|
1463
|
+
| Name | Required | Type | Description |
|
|
1464
|
+
|---|---:|---|---|
|
|
1465
|
+
| `id` | yes | unknown | Unique identifier for the item |
|
|
1466
|
+
| `label` | yes | string | Display text for the item |
|
|
1467
|
+
|
|
1468
|
+
No additional properties.
|
|
1469
|
+
|
|
1470
|
+
## PartnerCompany
|
|
1471
|
+
|
|
1472
|
+
Partner company data for profile URL routing
|
|
1473
|
+
|
|
1474
|
+
### Fields
|
|
1475
|
+
|
|
1476
|
+
_No fields._
|
|
1477
|
+
|
|
1478
|
+
Additional properties: unknown.
|
|
1479
|
+
|
|
1480
|
+
## PasswordArg
|
|
1481
|
+
|
|
1482
|
+
### Fields
|
|
1483
|
+
|
|
1484
|
+
_No fields._
|
|
1485
|
+
|
|
1486
|
+
Additional properties: unknown.
|
|
1487
|
+
|
|
1488
|
+
## PasswordCheck
|
|
1489
|
+
|
|
1490
|
+
### Fields
|
|
1491
|
+
|
|
1492
|
+
| Name | Required | Type | Description |
|
|
1493
|
+
|---|---:|---|---|
|
|
1494
|
+
| `args` | no | [PasswordArg](./types.md#passwordarg) | |
|
|
1495
|
+
| `message` | yes | string | |
|
|
1496
|
+
| `type` | yes | string | |
|
|
1497
|
+
|
|
1498
|
+
No additional properties.
|
|
1499
|
+
|
|
1500
|
+
## PasswordStringPadding
|
|
1501
|
+
|
|
1502
|
+
Pads input value with character until reaching maxLength
|
|
1503
|
+
|
|
1504
|
+
### Fields
|
|
1505
|
+
|
|
1506
|
+
| Name | Required | Type | Description |
|
|
1507
|
+
|---|---:|---|---|
|
|
1508
|
+
| `character` | yes | string | Character to use for padding |
|
|
1509
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1510
|
+
| `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Where to add padding: start or end |
|
|
1511
|
+
|
|
1512
|
+
No additional properties.
|
|
1513
|
+
|
|
1514
|
+
## PercentageArg
|
|
1515
|
+
|
|
1516
|
+
### Fields
|
|
1517
|
+
|
|
1518
|
+
_No fields._
|
|
1519
|
+
|
|
1520
|
+
Additional properties: unknown.
|
|
1521
|
+
|
|
1522
|
+
## PercentageCheck
|
|
1523
|
+
|
|
1524
|
+
### Fields
|
|
1525
|
+
|
|
1526
|
+
| Name | Required | Type | Description |
|
|
1527
|
+
|---|---:|---|---|
|
|
1528
|
+
| `args` | no | [PercentageArg](./types.md#percentagearg) | |
|
|
1529
|
+
| `message` | yes | string | |
|
|
1530
|
+
| `type` | yes | string | |
|
|
1531
|
+
|
|
1532
|
+
No additional properties.
|
|
1533
|
+
|
|
1534
|
+
## PhoneArg
|
|
1535
|
+
|
|
1536
|
+
### Fields
|
|
1537
|
+
|
|
1538
|
+
_No fields._
|
|
1539
|
+
|
|
1540
|
+
Additional properties: unknown.
|
|
1541
|
+
|
|
1542
|
+
## PhoneCheck
|
|
1543
|
+
|
|
1544
|
+
### Fields
|
|
1545
|
+
|
|
1546
|
+
| Name | Required | Type | Description |
|
|
1547
|
+
|---|---:|---|---|
|
|
1548
|
+
| `args` | no | [PhoneArg](./types.md#phonearg) | |
|
|
1549
|
+
| `message` | yes | string | |
|
|
1550
|
+
| `type` | yes | string | |
|
|
1551
|
+
|
|
1552
|
+
No additional properties.
|
|
1553
|
+
|
|
1554
|
+
## PhoneStringPadding
|
|
1555
|
+
|
|
1556
|
+
Pads input value with character until reaching maxLength
|
|
1557
|
+
|
|
1558
|
+
### Fields
|
|
1559
|
+
|
|
1560
|
+
| Name | Required | Type | Description |
|
|
1561
|
+
|---|---:|---|---|
|
|
1562
|
+
| `character` | yes | string | Character to use for padding |
|
|
1563
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
1564
|
+
| `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Where to add padding: start or end |
|
|
1565
|
+
|
|
1566
|
+
No additional properties.
|
|
1567
|
+
|
|
1568
|
+
## ProgressStepsStep
|
|
1569
|
+
|
|
1570
|
+
### Fields
|
|
1571
|
+
|
|
1572
|
+
| Name | Required | Type | Description |
|
|
1573
|
+
|---|---:|---|---|
|
|
1574
|
+
| `hasError` | no | boolean | Marks the step as having an error |
|
|
1575
|
+
| `icon` | no | string | Icon type from Icon.TYPES to display for the step |
|
|
1576
|
+
| `isDisabled` | no | boolean | Disables the step |
|
|
1577
|
+
| `subtitle` | no | string | Subtitle text for the step |
|
|
1578
|
+
| `title` | no | string | Title text for the step |
|
|
1579
|
+
|
|
1580
|
+
No additional properties.
|
|
1581
|
+
|
|
1582
|
+
## QueryParam
|
|
1583
|
+
|
|
1584
|
+
Query parameters to append when navigating to this item
|
|
1585
|
+
|
|
1586
|
+
### Fields
|
|
1587
|
+
|
|
1588
|
+
_No fields._
|
|
1589
|
+
|
|
1590
|
+
Additional properties: string.
|
|
1591
|
+
|
|
1592
|
+
## RadioArg
|
|
1593
|
+
|
|
1594
|
+
### Fields
|
|
1595
|
+
|
|
1596
|
+
_No fields._
|
|
1597
|
+
|
|
1598
|
+
Additional properties: unknown.
|
|
1599
|
+
|
|
1600
|
+
## RadioCheck
|
|
1601
|
+
|
|
1602
|
+
### Fields
|
|
1603
|
+
|
|
1604
|
+
| Name | Required | Type | Description |
|
|
1605
|
+
|---|---:|---|---|
|
|
1606
|
+
| `args` | no | [RadioArg](./types.md#radioarg) | |
|
|
1607
|
+
| `message` | yes | string | |
|
|
1608
|
+
| `type` | yes | string | |
|
|
1609
|
+
|
|
1610
|
+
No additional properties.
|
|
1611
|
+
|
|
1612
|
+
## RadioOption
|
|
1613
|
+
|
|
1614
|
+
### Fields
|
|
1615
|
+
|
|
1616
|
+
| Name | Required | Type | Description |
|
|
1617
|
+
|---|---:|---|---|
|
|
1618
|
+
| `isActive` | no | boolean | Controls focus state of the option |
|
|
1619
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
1620
|
+
| `label` | yes | string | Display text for the option |
|
|
1621
|
+
| `secondaryLabel` | no | string | Secondary text below the option label |
|
|
1622
|
+
| `tag` | no | unknown | Optional tag/label displayed with the option |
|
|
1623
|
+
| `tip` | no | string | Tooltip text shown on hover |
|
|
1624
|
+
| `value` | yes | unknown | Value stored when option is selected |
|
|
1625
|
+
|
|
1626
|
+
No additional properties.
|
|
1627
|
+
|
|
1628
|
+
## RangeSliderArg
|
|
1629
|
+
|
|
1630
|
+
### Fields
|
|
1631
|
+
|
|
1632
|
+
_No fields._
|
|
1633
|
+
|
|
1634
|
+
Additional properties: unknown.
|
|
1635
|
+
|
|
1636
|
+
## RangeSliderCheck
|
|
1637
|
+
|
|
1638
|
+
### Fields
|
|
1639
|
+
|
|
1640
|
+
| Name | Required | Type | Description |
|
|
1641
|
+
|---|---:|---|---|
|
|
1642
|
+
| `args` | no | [RangeSliderArg](./types.md#rangesliderarg) | |
|
|
1643
|
+
| `message` | yes | string | |
|
|
1644
|
+
| `type` | yes | string | |
|
|
1645
|
+
|
|
1646
|
+
No additional properties.
|
|
1647
|
+
|
|
1648
|
+
## RangeSliderMark
|
|
1649
|
+
|
|
1650
|
+
Marks on slider as {position: label} object (e.g. {10: "10$", 50: "50$"})
|
|
1651
|
+
|
|
1652
|
+
### Fields
|
|
1653
|
+
|
|
1654
|
+
_No fields._
|
|
1655
|
+
|
|
1656
|
+
Additional properties: string.
|
|
1657
|
+
|
|
1658
|
+
## RenderProp
|
|
1659
|
+
|
|
1660
|
+
Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string)
|
|
1661
|
+
|
|
1662
|
+
### Fields
|
|
1663
|
+
|
|
1664
|
+
_No fields._
|
|
1665
|
+
|
|
1666
|
+
Additional properties: [RenderPropValue](./types.md#renderpropvalue).
|
|
1667
|
+
|
|
1668
|
+
## RenderPropValue
|
|
1669
|
+
|
|
1670
|
+
### Fields
|
|
1671
|
+
|
|
1672
|
+
| Name | Required | Type | Description |
|
|
1673
|
+
|---|---:|---|---|
|
|
1674
|
+
| `isDisabled` | no | boolean | |
|
|
1675
|
+
| `tip` | no | [DaySelectorTip](./types.md#dayselectortip) | |
|
|
1676
|
+
|
|
1677
|
+
No additional properties.
|
|
1678
|
+
|
|
1679
|
+
## Role
|
|
1680
|
+
|
|
1681
|
+
### Fields
|
|
1682
|
+
|
|
1683
|
+
| Name | Required | Type | Description |
|
|
1684
|
+
|---|---:|---|---|
|
|
1685
|
+
| `fullName` | no | string | Display name |
|
|
1686
|
+
| `id` | no | string | Unique identifier |
|
|
1687
|
+
| `image` | no | string | Avatar image URL |
|
|
1688
|
+
| `inviteEmail` | no | string | Invite email (fallback label if fullName/workEmail absent) |
|
|
1689
|
+
| `partnerCompany` | no | [PartnerCompany](./types.md#partnercompany) | Partner company data for profile URL routing |
|
|
1690
|
+
| `user_cache` | no | [User_cache](./types.md#usercache) | User cache data with smallPhoto fallback |
|
|
1691
|
+
| `workEmail` | no | string | Work email |
|
|
1692
|
+
|
|
1693
|
+
No additional properties.
|
|
1694
|
+
|
|
1695
|
+
## Row
|
|
1696
|
+
|
|
1697
|
+
### Fields
|
|
1698
|
+
|
|
1699
|
+
_No fields._
|
|
1700
|
+
|
|
1701
|
+
Additional properties: string | number | boolean | null.
|
|
1702
|
+
|
|
1703
|
+
## Segment
|
|
1704
|
+
|
|
1705
|
+
### Fields
|
|
1706
|
+
|
|
1707
|
+
| Name | Required | Type | Description |
|
|
1708
|
+
|---|---:|---|---|
|
|
1709
|
+
| `segmentColor` | yes | unknown | Pebble chart color token, or semantic color token for status-related visualizations. |
|
|
1710
|
+
| `value` | yes | number | Numeric value of this segment |
|
|
1711
|
+
|
|
1712
|
+
No additional properties.
|
|
1713
|
+
|
|
1714
|
+
## SegmentedControlArg
|
|
1715
|
+
|
|
1716
|
+
### Fields
|
|
1717
|
+
|
|
1718
|
+
_No fields._
|
|
1719
|
+
|
|
1720
|
+
Additional properties: unknown.
|
|
1721
|
+
|
|
1722
|
+
## SegmentedControlCheck
|
|
1723
|
+
|
|
1724
|
+
### Fields
|
|
1725
|
+
|
|
1726
|
+
| Name | Required | Type | Description |
|
|
1727
|
+
|---|---:|---|---|
|
|
1728
|
+
| `args` | no | [SegmentedControlArg](./types.md#segmentedcontrolarg) | |
|
|
1729
|
+
| `message` | yes | string | |
|
|
1730
|
+
| `type` | yes | string | |
|
|
1731
|
+
|
|
1732
|
+
No additional properties.
|
|
1733
|
+
|
|
1734
|
+
## SegmentedControlOption
|
|
1735
|
+
|
|
1736
|
+
### Fields
|
|
1737
|
+
|
|
1738
|
+
| Name | Required | Type | Description |
|
|
1739
|
+
|---|---:|---|---|
|
|
1740
|
+
| `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style for this specific option |
|
|
1741
|
+
| `aria-label` | no | string | Accessible label, required if label is not provided (e.g. for icon-only items) |
|
|
1742
|
+
| `icon` | no | string | Icon to display for icon-only items. Requires aria-label or label for accessibility |
|
|
1743
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
1744
|
+
| `label` | no | string | Display text for the option |
|
|
1745
|
+
| `tip` | no | [SegmentedControlTip](./types.md#segmentedcontroltip) | Tooltip to show on hover for this option |
|
|
1746
|
+
| `value` | yes | string | Value stored when option is selected |
|
|
1747
|
+
|
|
1748
|
+
No additional properties.
|
|
1749
|
+
|
|
1750
|
+
## SegmentedControlRangeLabel
|
|
1751
|
+
|
|
1752
|
+
Labels to display at the start and end of the control range
|
|
1753
|
+
|
|
1754
|
+
### Fields
|
|
1755
|
+
|
|
1756
|
+
| Name | Required | Type | Description |
|
|
1757
|
+
|---|---:|---|---|
|
|
1758
|
+
| `end` | yes | string | Label at the end of the range |
|
|
1759
|
+
| `start` | yes | string | Label at the start of the range |
|
|
1760
|
+
|
|
1761
|
+
No additional properties.
|
|
1762
|
+
|
|
1763
|
+
## SegmentedControlTip
|
|
1764
|
+
|
|
1765
|
+
Tooltip to show on hover for this option
|
|
1766
|
+
|
|
1767
|
+
### Fields
|
|
1768
|
+
|
|
1769
|
+
| Name | Required | Type | Description |
|
|
1770
|
+
|---|---:|---|---|
|
|
1771
|
+
| `content` | yes | string | Tooltip text content |
|
|
1772
|
+
|
|
1773
|
+
No additional properties.
|
|
1774
|
+
|
|
1775
|
+
## SelectableGroupArg
|
|
1776
|
+
|
|
1777
|
+
### Fields
|
|
1778
|
+
|
|
1779
|
+
_No fields._
|
|
1780
|
+
|
|
1781
|
+
Additional properties: unknown.
|
|
1782
|
+
|
|
1783
|
+
## SelectableGroupCheck
|
|
1784
|
+
|
|
1785
|
+
### Fields
|
|
1786
|
+
|
|
1787
|
+
| Name | Required | Type | Description |
|
|
1788
|
+
|---|---:|---|---|
|
|
1789
|
+
| `args` | no | [SelectableGroupArg](./types.md#selectablegrouparg) | |
|
|
1790
|
+
| `message` | yes | string | |
|
|
1791
|
+
| `type` | yes | string | |
|
|
1792
|
+
|
|
1793
|
+
No additional properties.
|
|
1794
|
+
|
|
1795
|
+
## SelectableGroupList
|
|
1796
|
+
|
|
1797
|
+
### Fields
|
|
1798
|
+
|
|
1799
|
+
_No fields._
|
|
1800
|
+
|
|
1801
|
+
Additional properties: unknown.
|
|
1802
|
+
|
|
1803
|
+
## SelectableMenuList
|
|
1804
|
+
|
|
1805
|
+
### Fields
|
|
1806
|
+
|
|
1807
|
+
| Name | Required | Type | Description |
|
|
1808
|
+
|---|---:|---|---|
|
|
1809
|
+
| `isDisabled` | no | boolean | Disables this option |
|
|
1810
|
+
| `label` | yes | string | Display text for the option |
|
|
1811
|
+
| `value` | yes | string | Unique value for the option |
|
|
1812
|
+
|
|
1813
|
+
No additional properties.
|
|
1814
|
+
|
|
1815
|
+
## SelectArg
|
|
1816
|
+
|
|
1817
|
+
### Fields
|
|
1818
|
+
|
|
1819
|
+
_No fields._
|
|
1820
|
+
|
|
1821
|
+
Additional properties: unknown.
|
|
1822
|
+
|
|
1823
|
+
## SelectAvatarProp
|
|
1824
|
+
|
|
1825
|
+
Avatar configuration for the option
|
|
1826
|
+
|
|
1827
|
+
### Fields
|
|
1828
|
+
|
|
1829
|
+
| Name | Required | Type | Description |
|
|
1830
|
+
|---|---:|---|---|
|
|
1831
|
+
| `image` | no | string | URL of avatar image |
|
|
1832
|
+
| `title` | no | string | Title/alt text for avatar |
|
|
1833
|
+
|
|
1834
|
+
No additional properties.
|
|
1835
|
+
|
|
1836
|
+
## SelectCheck
|
|
1837
|
+
|
|
1838
|
+
### Fields
|
|
1839
|
+
|
|
1840
|
+
| Name | Required | Type | Description |
|
|
1841
|
+
|---|---:|---|---|
|
|
1842
|
+
| `args` | no | [SelectArg](./types.md#selectarg) | |
|
|
1843
|
+
| `message` | yes | string | |
|
|
1844
|
+
| `type` | yes | string | |
|
|
1845
|
+
|
|
1846
|
+
No additional properties.
|
|
1847
|
+
|
|
1848
|
+
## SelectFooter
|
|
1849
|
+
|
|
1850
|
+
Fixed footer at bottom of dropdown menu
|
|
1851
|
+
|
|
1852
|
+
### Fields
|
|
1853
|
+
|
|
1854
|
+
| Name | Required | Type | Description |
|
|
1855
|
+
|---|---:|---|---|
|
|
1856
|
+
| `label` | yes | string | Footer link text |
|
|
1857
|
+
| `onClick` | yes | string | Event name to emit when footer is clicked |
|
|
1858
|
+
|
|
1859
|
+
No additional properties.
|
|
1860
|
+
|
|
1861
|
+
## SelectFuseOption
|
|
1862
|
+
|
|
1863
|
+
Fuse.js search options for customizing fuzzy search behavior
|
|
1864
|
+
|
|
1865
|
+
### Fields
|
|
1866
|
+
|
|
1867
|
+
_No fields._
|
|
1868
|
+
|
|
1869
|
+
Additional properties: unknown.
|
|
1870
|
+
|
|
1871
|
+
## SelectOption
|
|
1872
|
+
|
|
1873
|
+
### Fields
|
|
1874
|
+
|
|
1875
|
+
| Name | Required | Type | Description |
|
|
1876
|
+
|---|---:|---|---|
|
|
1877
|
+
| `avatarProps` | no | [SelectAvatarProp](./types.md#selectavatarprop) | Avatar configuration for the option |
|
|
1878
|
+
| `description` | no | string | Description text shown below the label |
|
|
1879
|
+
| `flag` | no | string | Two-letter country code for flag icon (e.g. "US", "IN") |
|
|
1880
|
+
| `isDisabled` | no | boolean | Disables this specific option |
|
|
1881
|
+
| `isRecommended` | no | boolean | Marks option as recommended with a badge |
|
|
1882
|
+
| `isSeparator` | no | boolean | Renders as a visual separator instead of selectable option |
|
|
1883
|
+
| `label` | yes | string | Display text for the option |
|
|
1884
|
+
| `labelIcon` | no | string | Icon glyph name to show next to the label |
|
|
1885
|
+
| `leftIconType` | no | string | Icon glyph name to show on the left. E.g. "CHECK_CIRCLE_OUTLINE" |
|
|
1886
|
+
| `quaternaryLabel` | no | string | Quaternary label shown below tertiary label |
|
|
1887
|
+
| `rightLabel` | no | string | Label aligned to the right side of the option |
|
|
1888
|
+
| `secondaryLabel` | no | string | Secondary label shown below the main label |
|
|
1889
|
+
| `tertiaryLabel` | no | string | Tertiary label shown below secondary label |
|
|
1890
|
+
| `value` | yes | unknown | Value stored when option is selected |
|
|
1891
|
+
|
|
1892
|
+
No additional properties.
|
|
1893
|
+
|
|
1894
|
+
## ShowMoreValue
|
|
1895
|
+
|
|
1896
|
+
Configuration for show more behavior
|
|
1897
|
+
|
|
1898
|
+
### Fields
|
|
1899
|
+
|
|
1900
|
+
| Name | Required | Type | Description |
|
|
1901
|
+
|---|---:|---|---|
|
|
1902
|
+
| `size` | yes | number | Number of items to show initially before "show more" |
|
|
1903
|
+
|
|
1904
|
+
No additional properties.
|
|
1905
|
+
|
|
1906
|
+
## SignatureArg
|
|
1907
|
+
|
|
1908
|
+
### Fields
|
|
1909
|
+
|
|
1910
|
+
_No fields._
|
|
1911
|
+
|
|
1912
|
+
Additional properties: unknown.
|
|
1913
|
+
|
|
1914
|
+
## SignatureCheck
|
|
1915
|
+
|
|
1916
|
+
### Fields
|
|
1917
|
+
|
|
1918
|
+
| Name | Required | Type | Description |
|
|
1919
|
+
|---|---:|---|---|
|
|
1920
|
+
| `args` | no | [SignatureArg](./types.md#signaturearg) | |
|
|
1921
|
+
| `message` | yes | string | |
|
|
1922
|
+
| `type` | yes | string | |
|
|
1923
|
+
|
|
1924
|
+
No additional properties.
|
|
1925
|
+
|
|
1926
|
+
## SinArg
|
|
1927
|
+
|
|
1928
|
+
### Fields
|
|
1929
|
+
|
|
1930
|
+
_No fields._
|
|
1931
|
+
|
|
1932
|
+
Additional properties: unknown.
|
|
1933
|
+
|
|
1934
|
+
## SinCheck
|
|
1935
|
+
|
|
1936
|
+
### Fields
|
|
1937
|
+
|
|
1938
|
+
| Name | Required | Type | Description |
|
|
1939
|
+
|---|---:|---|---|
|
|
1940
|
+
| `args` | no | [SinArg](./types.md#sinarg) | |
|
|
1941
|
+
| `message` | yes | string | |
|
|
1942
|
+
| `type` | yes | string | |
|
|
1943
|
+
|
|
1944
|
+
No additional properties.
|
|
1945
|
+
|
|
1946
|
+
## Size
|
|
1947
|
+
|
|
1948
|
+
Horizontal size constraints for desktop layout. Object with optional default/min/max properties as CSS strings
|
|
1949
|
+
|
|
1950
|
+
### Fields
|
|
1951
|
+
|
|
1952
|
+
| Name | Required | Type | Description |
|
|
1953
|
+
|---|---:|---|---|
|
|
1954
|
+
| `default` | no | string | Default size as CSS string (e.g., "300px", "30%") |
|
|
1955
|
+
| `max` | no | string | Maximum size as CSS string (e.g., "400px", "50%") |
|
|
1956
|
+
| `min` | no | string | Minimum size as CSS string (e.g., "200px", "20%") |
|
|
1957
|
+
|
|
1958
|
+
No additional properties.
|
|
1959
|
+
|
|
1960
|
+
## Slide
|
|
1961
|
+
|
|
1962
|
+
### Fields
|
|
1963
|
+
|
|
1964
|
+
| Name | Required | Type | Description |
|
|
1965
|
+
|---|---:|---|---|
|
|
1966
|
+
| `alt` | no | string | Alt text for the slide image |
|
|
1967
|
+
| `heading` | yes | string | Slide heading text |
|
|
1968
|
+
| `img` | yes | string | Slide image URL |
|
|
1969
|
+
|
|
1970
|
+
No additional properties.
|
|
1971
|
+
|
|
1972
|
+
## SliderArg
|
|
1973
|
+
|
|
1974
|
+
### Fields
|
|
1975
|
+
|
|
1976
|
+
_No fields._
|
|
1977
|
+
|
|
1978
|
+
Additional properties: unknown.
|
|
1979
|
+
|
|
1980
|
+
## SliderCheck
|
|
1981
|
+
|
|
1982
|
+
### Fields
|
|
1983
|
+
|
|
1984
|
+
| Name | Required | Type | Description |
|
|
1985
|
+
|---|---:|---|---|
|
|
1986
|
+
| `args` | no | [SliderArg](./types.md#sliderarg) | |
|
|
1987
|
+
| `message` | yes | string | |
|
|
1988
|
+
| `type` | yes | string | |
|
|
1989
|
+
|
|
1990
|
+
No additional properties.
|
|
1991
|
+
|
|
1992
|
+
## SliderMark
|
|
1993
|
+
|
|
1994
|
+
Named marks on the slider track. Keys are numeric positions, values are labels
|
|
1995
|
+
|
|
1996
|
+
### Fields
|
|
1997
|
+
|
|
1998
|
+
_No fields._
|
|
1999
|
+
|
|
2000
|
+
Additional properties: string.
|
|
2001
|
+
|
|
2002
|
+
## SsnArg
|
|
2003
|
+
|
|
2004
|
+
### Fields
|
|
2005
|
+
|
|
2006
|
+
_No fields._
|
|
2007
|
+
|
|
2008
|
+
Additional properties: unknown.
|
|
2009
|
+
|
|
2010
|
+
## SsnCheck
|
|
2011
|
+
|
|
2012
|
+
### Fields
|
|
2013
|
+
|
|
2014
|
+
| Name | Required | Type | Description |
|
|
2015
|
+
|---|---:|---|---|
|
|
2016
|
+
| `args` | no | [SsnArg](./types.md#ssnarg) | |
|
|
2017
|
+
| `message` | yes | string | |
|
|
2018
|
+
| `type` | yes | string | |
|
|
2019
|
+
|
|
2020
|
+
No additional properties.
|
|
2021
|
+
|
|
2022
|
+
## StandAloneStep
|
|
2023
|
+
|
|
2024
|
+
### Fields
|
|
2025
|
+
|
|
2026
|
+
| Name | Required | Type | Description |
|
|
2027
|
+
|---|---:|---|---|
|
|
2028
|
+
| `avatar` | no | [AvatarValue](./types.md#avatarvalue) | Avatar configuration to display with the step. Supports image URLs |
|
|
2029
|
+
| `badge` | no | [StepperBadge](./types.md#stepperbadge) | Badge configuration to display alongside the step title |
|
|
2030
|
+
| `description` | no | string | Optional step description |
|
|
2031
|
+
| `href` | no | string | URL for the step. Renders the step as an anchor tag with this href (semantic HTML only) |
|
|
2032
|
+
| `status` | no | [StandAloneStepStatus](./definitions.md#standalonestepstatus) | Step status indicator |
|
|
2033
|
+
| `title` | yes | string | Step title text |
|
|
2034
|
+
|
|
2035
|
+
No additional properties.
|
|
2036
|
+
|
|
2037
|
+
## StepperBadge
|
|
2038
|
+
|
|
2039
|
+
Badge configuration to display alongside the step title
|
|
2040
|
+
|
|
2041
|
+
### Fields
|
|
2042
|
+
|
|
2043
|
+
| Name | Required | Type | Description |
|
|
2044
|
+
|---|---:|---|---|
|
|
2045
|
+
| `appearance` | no | [BadgeAppearance](./definitions.md#badgeappearance) | Badge color appearance |
|
|
2046
|
+
| `aria-label` | no | string | Accessibility label for the badge |
|
|
2047
|
+
| `text` | yes | string | Badge text content |
|
|
2048
|
+
|
|
2049
|
+
No additional properties.
|
|
2050
|
+
|
|
2051
|
+
## StepperStep
|
|
2052
|
+
|
|
2053
|
+
### Fields
|
|
2054
|
+
|
|
2055
|
+
| Name | Required | Type | Description |
|
|
2056
|
+
|---|---:|---|---|
|
|
2057
|
+
| `avatar` | no | [AvatarValue](./types.md#avatarvalue) | Avatar configuration to display with the step. Supports image URLs |
|
|
2058
|
+
| `badge` | no | [StepperBadge](./types.md#stepperbadge) | Badge configuration to display alongside the step title |
|
|
2059
|
+
| `description` | no | string | Optional step description |
|
|
2060
|
+
| `href` | no | string | URL for the step. Renders the step as an anchor tag with this href (semantic HTML only) |
|
|
2061
|
+
| `status` | no | [StandAloneStepStatus](./definitions.md#standalonestepstatus) | Step status indicator |
|
|
2062
|
+
| `title` | yes | string | Step title text |
|
|
2063
|
+
|
|
2064
|
+
No additional properties.
|
|
2065
|
+
|
|
2066
|
+
## SubmitButtonProp
|
|
2067
|
+
|
|
2068
|
+
Configuration for the form submit button
|
|
2069
|
+
|
|
2070
|
+
### Fields
|
|
2071
|
+
|
|
2072
|
+
| Name | Required | Type | Description |
|
|
2073
|
+
|---|---:|---|---|
|
|
2074
|
+
| `isDisabled` | no | boolean | Disable submit button |
|
|
2075
|
+
| `isFluid` | no | boolean | Stretch submit button to fill width |
|
|
2076
|
+
| `isLoading` | no | boolean | Show loading spinner on submit button. Bind to state for manual control. |
|
|
2077
|
+
| `label` | no | string | Submit button label |
|
|
2078
|
+
| `size` | no | [ButtonSize](./definitions.md#buttonsize) | Submit button size |
|
|
2079
|
+
|
|
2080
|
+
No additional properties.
|
|
2081
|
+
|
|
2082
|
+
## SurveyArg
|
|
2083
|
+
|
|
2084
|
+
### Fields
|
|
2085
|
+
|
|
2086
|
+
_No fields._
|
|
2087
|
+
|
|
2088
|
+
Additional properties: unknown.
|
|
2089
|
+
|
|
2090
|
+
## SurveyCheck
|
|
2091
|
+
|
|
2092
|
+
### Fields
|
|
2093
|
+
|
|
2094
|
+
| Name | Required | Type | Description |
|
|
2095
|
+
|---|---:|---|---|
|
|
2096
|
+
| `args` | no | [SurveyArg](./types.md#surveyarg) | |
|
|
2097
|
+
| `message` | yes | string | |
|
|
2098
|
+
| `type` | yes | string | |
|
|
2099
|
+
|
|
2100
|
+
No additional properties.
|
|
2101
|
+
|
|
2102
|
+
## SurveyList
|
|
2103
|
+
|
|
2104
|
+
### Fields
|
|
2105
|
+
|
|
2106
|
+
| Name | Required | Type | Description |
|
|
2107
|
+
|---|---:|---|---|
|
|
2108
|
+
| `isDisabled` | no | boolean | Disable this specific option |
|
|
2109
|
+
| `label` | no | unknown | Display label for the option |
|
|
2110
|
+
| `selectionColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Override selected surface color token for this option |
|
|
2111
|
+
| `value` | yes | unknown | Value when selected |
|
|
2112
|
+
|
|
2113
|
+
No additional properties.
|
|
2114
|
+
|
|
2115
|
+
## SurveyRangeLabel
|
|
2116
|
+
|
|
2117
|
+
Labels for lowest and highest options
|
|
2118
|
+
|
|
2119
|
+
### Fields
|
|
2120
|
+
|
|
2121
|
+
| Name | Required | Type | Description |
|
|
2122
|
+
|---|---:|---|---|
|
|
2123
|
+
| `lower` | yes | string | Label for the lowest option |
|
|
2124
|
+
| `upper` | yes | string | Label for the highest option |
|
|
2125
|
+
|
|
2126
|
+
No additional properties.
|
|
2127
|
+
|
|
2128
|
+
## SwitchArg
|
|
2129
|
+
|
|
2130
|
+
### Fields
|
|
2131
|
+
|
|
2132
|
+
_No fields._
|
|
2133
|
+
|
|
2134
|
+
Additional properties: unknown.
|
|
2135
|
+
|
|
2136
|
+
## SwitchCheck
|
|
2137
|
+
|
|
2138
|
+
### Fields
|
|
2139
|
+
|
|
2140
|
+
| Name | Required | Type | Description |
|
|
2141
|
+
|---|---:|---|---|
|
|
2142
|
+
| `args` | no | [SwitchArg](./types.md#switcharg) | |
|
|
2143
|
+
| `message` | yes | string | |
|
|
2144
|
+
| `type` | yes | string | |
|
|
2145
|
+
|
|
2146
|
+
No additional properties.
|
|
2147
|
+
|
|
2148
|
+
## TabBadge
|
|
2149
|
+
|
|
2150
|
+
Badge to display on the tab
|
|
2151
|
+
|
|
2152
|
+
### Fields
|
|
2153
|
+
|
|
2154
|
+
| Name | Required | Type | Description |
|
|
2155
|
+
|---|---:|---|---|
|
|
2156
|
+
| `appearance` | no | [BadgeAppearance](./definitions.md#badgeappearance) | Badge appearance variant: INFO_DARK, INFO_LIGHT, ERROR_DARK, ERROR_LIGHT, PRIMARY_DARK, PRIMARY_LIGHT, SUCCESS_DARK, SUCCESS_LIGHT, WARNING_DARK, WARNING_LIGHT, NEUTRAL, BLACK |
|
|
2157
|
+
| `text` | yes | string | Text to display in the badge |
|
|
2158
|
+
|
|
2159
|
+
No additional properties.
|
|
2160
|
+
|
|
2161
|
+
## TabItem
|
|
2162
|
+
|
|
2163
|
+
### Fields
|
|
2164
|
+
|
|
2165
|
+
| Name | Required | Type | Description |
|
|
2166
|
+
|---|---:|---|---|
|
|
2167
|
+
| `badge` | no | [TabBadge](./types.md#tabbadge) | Badge to display on the tab |
|
|
2168
|
+
| `disabled` | no | boolean | Whether this tab is disabled |
|
|
2169
|
+
| `icon` | no | string | Icon name for the tab (e.g., FOLDER_OUTLINE) |
|
|
2170
|
+
| `label` | yes | string | Display text for the tab |
|
|
2171
|
+
| `tip` | no | unknown | Tooltip to show on hover |
|
|
2172
|
+
| `value` | yes | unknown | Value for this tab option |
|
|
2173
|
+
|
|
2174
|
+
No additional properties.
|
|
2175
|
+
|
|
2176
|
+
## TextareaArg
|
|
2177
|
+
|
|
2178
|
+
### Fields
|
|
2179
|
+
|
|
2180
|
+
_No fields._
|
|
2181
|
+
|
|
2182
|
+
Additional properties: unknown.
|
|
2183
|
+
|
|
2184
|
+
## TextareaCheck
|
|
2185
|
+
|
|
2186
|
+
### Fields
|
|
2187
|
+
|
|
2188
|
+
| Name | Required | Type | Description |
|
|
2189
|
+
|---|---:|---|---|
|
|
2190
|
+
| `args` | no | [TextareaArg](./types.md#textareaarg) | |
|
|
2191
|
+
| `message` | yes | string | |
|
|
2192
|
+
| `type` | yes | string | |
|
|
2193
|
+
|
|
2194
|
+
No additional properties.
|
|
2195
|
+
|
|
2196
|
+
## TextAutoSuggestArg
|
|
2197
|
+
|
|
2198
|
+
### Fields
|
|
2199
|
+
|
|
2200
|
+
_No fields._
|
|
2201
|
+
|
|
2202
|
+
Additional properties: unknown.
|
|
2203
|
+
|
|
2204
|
+
## TextAutoSuggestCheck
|
|
2205
|
+
|
|
2206
|
+
### Fields
|
|
2207
|
+
|
|
2208
|
+
| Name | Required | Type | Description |
|
|
2209
|
+
|---|---:|---|---|
|
|
2210
|
+
| `args` | no | [TextAutoSuggestArg](./types.md#textautosuggestarg) | |
|
|
2211
|
+
| `message` | yes | string | |
|
|
2212
|
+
| `type` | yes | string | |
|
|
2213
|
+
|
|
2214
|
+
No additional properties.
|
|
2215
|
+
|
|
2216
|
+
## TextAutoSuggestStringPadding
|
|
2217
|
+
|
|
2218
|
+
Pads input value with character until reaching maxLength
|
|
2219
|
+
|
|
2220
|
+
### Fields
|
|
2221
|
+
|
|
2222
|
+
| Name | Required | Type | Description |
|
|
2223
|
+
|---|---:|---|---|
|
|
2224
|
+
| `character` | yes | string | Character to use for padding |
|
|
2225
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
2226
|
+
| `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Where to add padding: start or end |
|
|
2227
|
+
|
|
2228
|
+
No additional properties.
|
|
2229
|
+
|
|
2230
|
+
## TextAutoSuggestSuggestion
|
|
2231
|
+
|
|
2232
|
+
### Fields
|
|
2233
|
+
|
|
2234
|
+
| Name | Required | Type | Description |
|
|
2235
|
+
|---|---:|---|---|
|
|
2236
|
+
| `label` | yes | string | Display text for the suggestion |
|
|
2237
|
+
| `value` | yes | unknown | Value stored when suggestion is selected |
|
|
2238
|
+
|
|
2239
|
+
No additional properties.
|
|
2240
|
+
|
|
2241
|
+
## TextInputArg
|
|
2242
|
+
|
|
2243
|
+
### Fields
|
|
2244
|
+
|
|
2245
|
+
_No fields._
|
|
2246
|
+
|
|
2247
|
+
Additional properties: unknown.
|
|
2248
|
+
|
|
2249
|
+
## TextInputCheck
|
|
2250
|
+
|
|
2251
|
+
### Fields
|
|
2252
|
+
|
|
2253
|
+
| Name | Required | Type | Description |
|
|
2254
|
+
|---|---:|---|---|
|
|
2255
|
+
| `args` | no | [TextInputArg](./types.md#textinputarg) | |
|
|
2256
|
+
| `message` | yes | string | |
|
|
2257
|
+
| `type` | yes | string | |
|
|
2258
|
+
|
|
2259
|
+
No additional properties.
|
|
2260
|
+
|
|
2261
|
+
## TextInputStringPadding
|
|
2262
|
+
|
|
2263
|
+
Pads input value with character until reaching maxLength
|
|
2264
|
+
|
|
2265
|
+
### Fields
|
|
2266
|
+
|
|
2267
|
+
| Name | Required | Type | Description |
|
|
2268
|
+
|---|---:|---|---|
|
|
2269
|
+
| `character` | yes | string | Character to use for padding |
|
|
2270
|
+
| `maxLength` | yes | number | Target length after padding |
|
|
2271
|
+
| `position` | yes | [NumberStringPaddingPosition](./definitions.md#numberstringpaddingposition) | Where to add padding: start or end |
|
|
2272
|
+
|
|
2273
|
+
No additional properties.
|
|
2274
|
+
|
|
2275
|
+
## TimeArg
|
|
2276
|
+
|
|
2277
|
+
### Fields
|
|
2278
|
+
|
|
2279
|
+
_No fields._
|
|
2280
|
+
|
|
2281
|
+
Additional properties: unknown.
|
|
2282
|
+
|
|
2283
|
+
## TimeCheck
|
|
2284
|
+
|
|
2285
|
+
### Fields
|
|
2286
|
+
|
|
2287
|
+
| Name | Required | Type | Description |
|
|
2288
|
+
|---|---:|---|---|
|
|
2289
|
+
| `args` | no | [TimeArg](./types.md#timearg) | |
|
|
2290
|
+
| `message` | yes | string | |
|
|
2291
|
+
| `type` | yes | string | |
|
|
2292
|
+
|
|
2293
|
+
No additional properties.
|
|
2294
|
+
|
|
2295
|
+
## TimeProp
|
|
2296
|
+
|
|
2297
|
+
Configuration for time picker. Sets initial time value independently of date input
|
|
2298
|
+
|
|
2299
|
+
### Fields
|
|
2300
|
+
|
|
2301
|
+
| Name | Required | Type | Description |
|
|
2302
|
+
|---|---:|---|---|
|
|
2303
|
+
| `defaultValue` | yes | string | Default time as ISO string when no date is selected |
|
|
2304
|
+
|
|
2305
|
+
No additional properties.
|
|
2306
|
+
|
|
2307
|
+
## TimeRangeArg
|
|
2308
|
+
|
|
2309
|
+
### Fields
|
|
2310
|
+
|
|
2311
|
+
_No fields._
|
|
2312
|
+
|
|
2313
|
+
Additional properties: unknown.
|
|
2314
|
+
|
|
2315
|
+
## TimeRangeCheck
|
|
2316
|
+
|
|
2317
|
+
### Fields
|
|
2318
|
+
|
|
2319
|
+
| Name | Required | Type | Description |
|
|
2320
|
+
|---|---:|---|---|
|
|
2321
|
+
| `args` | no | [TimeRangeArg](./types.md#timerangearg) | |
|
|
2322
|
+
| `message` | yes | string | |
|
|
2323
|
+
| `type` | yes | string | |
|
|
2324
|
+
|
|
2325
|
+
No additional properties.
|
|
2326
|
+
|
|
2327
|
+
## TimezoneArg
|
|
2328
|
+
|
|
2329
|
+
### Fields
|
|
2330
|
+
|
|
2331
|
+
_No fields._
|
|
2332
|
+
|
|
2333
|
+
Additional properties: unknown.
|
|
2334
|
+
|
|
2335
|
+
## TimezoneCheck
|
|
2336
|
+
|
|
2337
|
+
### Fields
|
|
2338
|
+
|
|
2339
|
+
| Name | Required | Type | Description |
|
|
2340
|
+
|---|---:|---|---|
|
|
2341
|
+
| `args` | no | [TimezoneArg](./types.md#timezonearg) | |
|
|
2342
|
+
| `message` | yes | string | |
|
|
2343
|
+
| `type` | yes | string | |
|
|
2344
|
+
|
|
2345
|
+
No additional properties.
|
|
2346
|
+
|
|
2347
|
+
## ToggleIcon
|
|
2348
|
+
|
|
2349
|
+
Toggle icon configuration
|
|
2350
|
+
|
|
2351
|
+
### Fields
|
|
2352
|
+
|
|
2353
|
+
| Name | Required | Type | Description |
|
|
2354
|
+
|---|---:|---|---|
|
|
2355
|
+
| `align` | no | string | CSS alignSelf value. Default: center |
|
|
2356
|
+
| `margin` | no | [ButtonGroupGap](./definitions.md#buttongroupgap) | Margin spacing token for icon alignment |
|
|
2357
|
+
| `size` | no | [IconSize](./definitions.md#iconsize) | Icon size token. Default: 24 |
|
|
2358
|
+
|
|
2359
|
+
No additional properties.
|
|
2360
|
+
|
|
2361
|
+
## TreeArg
|
|
2362
|
+
|
|
2363
|
+
### Fields
|
|
2364
|
+
|
|
2365
|
+
_No fields._
|
|
2366
|
+
|
|
2367
|
+
Additional properties: unknown.
|
|
2368
|
+
|
|
2369
|
+
## TreeCheck
|
|
2370
|
+
|
|
2371
|
+
### Fields
|
|
2372
|
+
|
|
2373
|
+
| Name | Required | Type | Description |
|
|
2374
|
+
|---|---:|---|---|
|
|
2375
|
+
| `args` | no | [TreeArg](./types.md#treearg) | |
|
|
2376
|
+
| `message` | yes | string | |
|
|
2377
|
+
| `type` | yes | string | |
|
|
2378
|
+
|
|
2379
|
+
No additional properties.
|
|
2380
|
+
|
|
2381
|
+
## TreeFooter
|
|
2382
|
+
|
|
2383
|
+
Fixed footer with clickable action at bottom of tree
|
|
2384
|
+
|
|
2385
|
+
### Fields
|
|
2386
|
+
|
|
2387
|
+
| Name | Required | Type | Description |
|
|
2388
|
+
|---|---:|---|---|
|
|
2389
|
+
| `label` | yes | string | Footer button text |
|
|
2390
|
+
|
|
2391
|
+
No additional properties.
|
|
2392
|
+
|
|
2393
|
+
## TreeFuseOption
|
|
2394
|
+
|
|
2395
|
+
Fuse.js search options for customizing search behavior
|
|
2396
|
+
|
|
2397
|
+
### Fields
|
|
2398
|
+
|
|
2399
|
+
_No fields._
|
|
2400
|
+
|
|
2401
|
+
Additional properties: unknown.
|
|
2402
|
+
|
|
2403
|
+
## TreeList
|
|
2404
|
+
|
|
2405
|
+
### Fields
|
|
2406
|
+
|
|
2407
|
+
| Name | Required | Type | Description |
|
|
2408
|
+
|---|---:|---|---|
|
|
2409
|
+
| `disabledInfo` | no | unknown | Tooltip shown when item is disabled |
|
|
2410
|
+
| `isDisabled` | no | boolean | Disable this item |
|
|
2411
|
+
| `label` | yes | string | Display label for the item |
|
|
2412
|
+
| `parent` | no | string | Parent item value, null for root items |
|
|
2413
|
+
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
2414
|
+
| `tag` | no | unknown | Chip/tag to display next to the label |
|
|
2415
|
+
| `value` | yes | string | Unique identifier for the item |
|
|
2416
|
+
|
|
2417
|
+
No additional properties.
|
|
2418
|
+
|
|
2419
|
+
## TreeSelectArg
|
|
2420
|
+
|
|
2421
|
+
### Fields
|
|
2422
|
+
|
|
2423
|
+
_No fields._
|
|
2424
|
+
|
|
2425
|
+
Additional properties: unknown.
|
|
2426
|
+
|
|
2427
|
+
## TreeSelectCheck
|
|
2428
|
+
|
|
2429
|
+
### Fields
|
|
2430
|
+
|
|
2431
|
+
| Name | Required | Type | Description |
|
|
2432
|
+
|---|---:|---|---|
|
|
2433
|
+
| `args` | no | [TreeSelectArg](./types.md#treeselectarg) | |
|
|
2434
|
+
| `message` | yes | string | |
|
|
2435
|
+
| `type` | yes | string | |
|
|
2436
|
+
|
|
2437
|
+
No additional properties.
|
|
2438
|
+
|
|
2439
|
+
## TreeSelectFuseOption
|
|
2440
|
+
|
|
2441
|
+
Fuse.js search configuration. Default: { keys: ["label", "name"] }
|
|
2442
|
+
|
|
2443
|
+
### Fields
|
|
2444
|
+
|
|
2445
|
+
_No fields._
|
|
2446
|
+
|
|
2447
|
+
Additional properties: unknown.
|
|
2448
|
+
|
|
2449
|
+
## TreeSelectList
|
|
2450
|
+
|
|
2451
|
+
### Fields
|
|
2452
|
+
|
|
2453
|
+
| Name | Required | Type | Description |
|
|
2454
|
+
|---|---:|---|---|
|
|
2455
|
+
| `isDisabled` | no | boolean | Disable this item |
|
|
2456
|
+
| `label` | yes | string | Display label for the item |
|
|
2457
|
+
| `parent` | no | string | Parent item value, null for root items |
|
|
2458
|
+
| `secondaryLabel` | no | string | Supporting text below the label |
|
|
2459
|
+
| `value` | yes | string | Unique identifier for the item |
|
|
2460
|
+
|
|
2461
|
+
No additional properties.
|
|
2462
|
+
|
|
2463
|
+
## User_cache
|
|
2464
|
+
|
|
2465
|
+
User cache data with smallPhoto fallback
|
|
2466
|
+
|
|
2467
|
+
### Fields
|
|
2468
|
+
|
|
2469
|
+
| Name | Required | Type | Description |
|
|
2470
|
+
|---|---:|---|---|
|
|
2471
|
+
| `smallPhoto` | no | string | Small photo URL |
|
|
2472
|
+
|
|
2473
|
+
Additional properties: unknown.
|
|
2474
|
+
|
|
2475
|
+
## VerticalSize
|
|
2476
|
+
|
|
2477
|
+
Vertical size constraints for mobile stacked layout. Object with optional default/min/max properties as CSS strings
|
|
2478
|
+
|
|
2479
|
+
### Fields
|
|
2480
|
+
|
|
2481
|
+
| Name | Required | Type | Description |
|
|
2482
|
+
|---|---:|---|---|
|
|
2483
|
+
| `default` | no | string | Default size as CSS string (e.g., "300px", "30%") |
|
|
2484
|
+
| `max` | no | string | Maximum size as CSS string (e.g., "400px", "50%") |
|
|
2485
|
+
| `min` | no | string | Minimum size as CSS string (e.g., "200px", "20%") |
|
|
2486
|
+
|
|
2487
|
+
No additional properties.
|
|
2488
|
+
|
|
2489
|
+
## WorkEmailArg
|
|
2490
|
+
|
|
2491
|
+
### Fields
|
|
2492
|
+
|
|
2493
|
+
_No fields._
|
|
2494
|
+
|
|
2495
|
+
Additional properties: unknown.
|
|
2496
|
+
|
|
2497
|
+
## WorkEmailCheck
|
|
2498
|
+
|
|
2499
|
+
### Fields
|
|
2500
|
+
|
|
2501
|
+
| Name | Required | Type | Description |
|
|
2502
|
+
|---|---:|---|---|
|
|
2503
|
+
| `args` | no | [WorkEmailArg](./types.md#workemailarg) | |
|
|
2504
|
+
| `message` | yes | string | |
|
|
2505
|
+
| `type` | yes | string | |
|
|
2506
|
+
|
|
2507
|
+
No additional properties.
|