@rippling/pebble-sdui-web 0.18.1 → 0.18.4
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 +1 -1
- package/dist/catalogs/custom-apps/component-events.d.ts +2 -0
- package/dist/catalogs/custom-apps/component-props.d.ts +107 -5
- package/dist/catalogs/custom-apps/components.d.ts +73 -71
- package/dist/catalogs/custom-apps/index.cjs +2 -2
- package/dist/catalogs/custom-apps/index.cjs.map +1 -1
- package/dist/catalogs/custom-apps/index.d.ts +3 -3
- package/dist/catalogs/custom-apps/index.js +1567 -281
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/core/component-utils.cjs +1 -1
- package/dist/core/component-utils.cjs.map +1 -1
- package/dist/core/component-utils.d.ts +16 -2
- package/dist/core/component-utils.js +4 -4
- package/dist/core/component-utils.js.map +1 -1
- package/dist/core/spec.cjs +1 -1
- package/dist/core/spec.cjs.map +1 -1
- package/dist/core/spec.d.ts +1 -0
- package/dist/core/spec.js +63 -56
- package/dist/core/spec.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +137 -3
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +99 -2
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +72 -0
- package/package.json +1 -1
|
@@ -156,6 +156,9 @@ Referenced by:
|
|
|
156
156
|
| component | `ToggleableArrow` | `arrowUpColor` |
|
|
157
157
|
| component | `VStack` | `color` |
|
|
158
158
|
| type | `AvatarIcon` | `color` |
|
|
159
|
+
| type | `AvatarListIcon` | `color` |
|
|
160
|
+
| type | `AvatarListPlaceholderIcon` | `color` |
|
|
161
|
+
| type | `AvatarPlaceholderIcon` | `color` |
|
|
159
162
|
| type | `ButtonIcon` | `color` |
|
|
160
163
|
| type | `ChipIcon` | `color` |
|
|
161
164
|
| type | `CountryIcon` | `color` |
|
|
@@ -170,6 +173,7 @@ Referenced by:
|
|
|
170
173
|
| type | `ObjectUIStatsAction` | `color` |
|
|
171
174
|
| type | `ObjectUIStatsLeftIcon` | `color` |
|
|
172
175
|
| type | `ObjectUIStatsRightIcon` | `color` |
|
|
176
|
+
| type | `StepperPlaceholderIcon` | `color` |
|
|
173
177
|
|
|
174
178
|
## AiIconSize
|
|
175
179
|
|
|
@@ -544,17 +548,107 @@ Referenced by:
|
|
|
544
548
|
| component | `SupportButton` | `imageBackground` |
|
|
545
549
|
| component | `VStack` | `backgroundColor` |
|
|
546
550
|
| type | `AvatarIcon` | `backgroundColor` |
|
|
551
|
+
| type | `AvatarListIcon` | `backgroundColor` |
|
|
552
|
+
| type | `AvatarListPlaceholderIcon` | `backgroundColor` |
|
|
553
|
+
| type | `AvatarPlaceholderIcon` | `backgroundColor` |
|
|
547
554
|
| type | `FormSurveyList` | `selectionColor` |
|
|
548
555
|
| type | `ObjectUIAvatarProp` | `imageBackground` |
|
|
549
556
|
| type | `ObjectUIHeaderAvatarProp` | `imageBackground` |
|
|
557
|
+
| type | `StepperPlaceholderIcon` | `backgroundColor` |
|
|
550
558
|
| type | `SurveyList` | `selectionColor` |
|
|
551
559
|
|
|
560
|
+
## AvatarLogo
|
|
561
|
+
|
|
562
|
+
TypeScript type:
|
|
563
|
+
|
|
564
|
+
```ts
|
|
565
|
+
"amplitude" | "asana" | "ashby" | "atlassian" | "bitrise" | "box" | "buildkite" | "cloudflare" | "contentful" | "context7" | "datadog" | "deel" | "dropbox" | "excalidraw" | "expo" | "figma" | "gem" | "github" | "gitlab" | "gmail" | "gong" | "googlecalendar" | "googlechat" | "googledocs" | "googledrive" | "googleforms" | "googlesheets" | "googleslides" | "googleworkspace" | "greenhouse" | "incidentio" | "ironclad" | "iterable" | "jumpcloud" | "launchdarkly" | "linear" | "logrocket" | "lucid" | "mermaidchart" | "metaview" | "microsoftcalendar" | "microsoftexcel" | "microsoftonedrive" | "microsoftoutlook" | "microsoftteams" | "microsoftword" | "mutiny" | "netsuite" | "notion" | "peopleapi" | "ramp" | "ranger" | "rippling" | "salesforce" | "sendoso" | "sentry" | "slack" | "snowflake" | "stripe" | "symmetrypayroll" | "vantage" | "zoom"
|
|
566
|
+
```
|
|
567
|
+
|
|
568
|
+
Allowed values:
|
|
569
|
+
|
|
570
|
+
| Value |
|
|
571
|
+
|---|
|
|
572
|
+
| `amplitude` |
|
|
573
|
+
| `asana` |
|
|
574
|
+
| `ashby` |
|
|
575
|
+
| `atlassian` |
|
|
576
|
+
| `bitrise` |
|
|
577
|
+
| `box` |
|
|
578
|
+
| `buildkite` |
|
|
579
|
+
| `cloudflare` |
|
|
580
|
+
| `contentful` |
|
|
581
|
+
| `context7` |
|
|
582
|
+
| `datadog` |
|
|
583
|
+
| `deel` |
|
|
584
|
+
| `dropbox` |
|
|
585
|
+
| `excalidraw` |
|
|
586
|
+
| `expo` |
|
|
587
|
+
| `figma` |
|
|
588
|
+
| `gem` |
|
|
589
|
+
| `github` |
|
|
590
|
+
| `gitlab` |
|
|
591
|
+
| `gmail` |
|
|
592
|
+
| `gong` |
|
|
593
|
+
| `googlecalendar` |
|
|
594
|
+
| `googlechat` |
|
|
595
|
+
| `googledocs` |
|
|
596
|
+
| `googledrive` |
|
|
597
|
+
| `googleforms` |
|
|
598
|
+
| `googlesheets` |
|
|
599
|
+
| `googleslides` |
|
|
600
|
+
| `googleworkspace` |
|
|
601
|
+
| `greenhouse` |
|
|
602
|
+
| `incidentio` |
|
|
603
|
+
| `ironclad` |
|
|
604
|
+
| `iterable` |
|
|
605
|
+
| `jumpcloud` |
|
|
606
|
+
| `launchdarkly` |
|
|
607
|
+
| `linear` |
|
|
608
|
+
| `logrocket` |
|
|
609
|
+
| `lucid` |
|
|
610
|
+
| `mermaidchart` |
|
|
611
|
+
| `metaview` |
|
|
612
|
+
| `microsoftcalendar` |
|
|
613
|
+
| `microsoftexcel` |
|
|
614
|
+
| `microsoftonedrive` |
|
|
615
|
+
| `microsoftoutlook` |
|
|
616
|
+
| `microsoftteams` |
|
|
617
|
+
| `microsoftword` |
|
|
618
|
+
| `mutiny` |
|
|
619
|
+
| `netsuite` |
|
|
620
|
+
| `notion` |
|
|
621
|
+
| `peopleapi` |
|
|
622
|
+
| `ramp` |
|
|
623
|
+
| `ranger` |
|
|
624
|
+
| `rippling` |
|
|
625
|
+
| `salesforce` |
|
|
626
|
+
| `sendoso` |
|
|
627
|
+
| `sentry` |
|
|
628
|
+
| `slack` |
|
|
629
|
+
| `snowflake` |
|
|
630
|
+
| `stripe` |
|
|
631
|
+
| `symmetrypayroll` |
|
|
632
|
+
| `vantage` |
|
|
633
|
+
| `zoom` |
|
|
634
|
+
|
|
635
|
+
Referenced by:
|
|
636
|
+
|
|
637
|
+
| Kind | Entity | Field |
|
|
638
|
+
|---|---|---|
|
|
639
|
+
| component | `Avatar` | `logo` |
|
|
640
|
+
| component | `AvatarList` | `logo` |
|
|
641
|
+
| type | `AvatarListAvatar` | `logo` |
|
|
642
|
+
| type | `ObjectUIAvatarProp` | `logo` |
|
|
643
|
+
| type | `ObjectUIHeaderAvatarProp` | `logo` |
|
|
644
|
+
| type | `StepperAvatar` | `logo` |
|
|
645
|
+
|
|
552
646
|
## AvatarType
|
|
553
647
|
|
|
554
648
|
TypeScript type:
|
|
555
649
|
|
|
556
650
|
```ts
|
|
557
|
-
"USER" | "ICON" | "TEXT" | "NUMBER" | "RIPPLING"
|
|
651
|
+
"USER" | "ICON" | "TEXT" | "NUMBER" | "RIPPLING" | "LOGO"
|
|
558
652
|
```
|
|
559
653
|
|
|
560
654
|
Allowed values:
|
|
@@ -566,6 +660,7 @@ Allowed values:
|
|
|
566
660
|
| `TEXT` |
|
|
567
661
|
| `NUMBER` |
|
|
568
662
|
| `RIPPLING` |
|
|
663
|
+
| `LOGO` |
|
|
569
664
|
|
|
570
665
|
Referenced by:
|
|
571
666
|
|
|
@@ -573,6 +668,7 @@ Referenced by:
|
|
|
573
668
|
|---|---|---|
|
|
574
669
|
| component | `Avatar` | `type` |
|
|
575
670
|
| component | `AvatarList` | `type` |
|
|
671
|
+
| type | `AvatarListAvatar` | `type` |
|
|
576
672
|
| type | `ObjectUIAvatarProp` | `type` |
|
|
577
673
|
| type | `ObjectUIHeaderAvatarProp` | `type` |
|
|
578
674
|
|
|
@@ -4104,7 +4200,7 @@ Referenced by:
|
|
|
4104
4200
|
TypeScript type:
|
|
4105
4201
|
|
|
4106
4202
|
```ts
|
|
4107
|
-
"ICON" | "RIPPLING" | "TEXT" | "USER" | "NUMBER"
|
|
4203
|
+
"ICON" | "RIPPLING" | "TEXT" | "USER" | "NUMBER" | "LOGO"
|
|
4108
4204
|
```
|
|
4109
4205
|
|
|
4110
4206
|
Allowed values:
|
|
@@ -4116,6 +4212,7 @@ Allowed values:
|
|
|
4116
4212
|
| `TEXT` |
|
|
4117
4213
|
| `USER` |
|
|
4118
4214
|
| `NUMBER` |
|
|
4215
|
+
| `LOGO` |
|
|
4119
4216
|
|
|
4120
4217
|
Referenced by:
|
|
4121
4218
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
# custom-apps Catalog
|
|
3
3
|
|
|
4
4
|
Catalog: `custom-apps`
|
|
5
|
-
Version: `1.9.
|
|
5
|
+
Version: `1.9.4`
|
|
6
6
|
SDK language: `typescript`
|
|
7
7
|
|
|
8
8
|
Use this catalog index after you have chosen this catalog for the spec. Do not mix components, actions, computed functions, or render helpers from another catalog unless that catalog explicitly documents compatibility.
|
|
@@ -287,6 +287,59 @@ No additional properties.
|
|
|
287
287
|
|
|
288
288
|
No additional properties.
|
|
289
289
|
|
|
290
|
+
## AvatarListAvatar
|
|
291
|
+
|
|
292
|
+
Per-role avatar overrides. Use this when different entries need different avatar types or logos
|
|
293
|
+
|
|
294
|
+
### Fields
|
|
295
|
+
|
|
296
|
+
| Name | Required | Type | Description |
|
|
297
|
+
|---|---:|---|---|
|
|
298
|
+
| `icon` | no | string \| [AvatarListIcon](./types.md#avatarlisticon) | Icon override when this role uses avatar type ICON |
|
|
299
|
+
| `image` | no | string | Avatar image URL override for this role |
|
|
300
|
+
| `isRounded` | no | boolean | Rounded shape override for this role |
|
|
301
|
+
| `logo` | no | [AvatarLogo](./definitions.md#avatarlogo) | Logo id from Avatar.LOGOS for this role |
|
|
302
|
+
| `placeholderIcon` | no | string \| [AvatarListPlaceholderIcon](./types.md#avatarlistplaceholdericon) | Placeholder icon shown while a role logo loads or if it cannot be shown |
|
|
303
|
+
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar type override for this role |
|
|
304
|
+
|
|
305
|
+
No additional properties.
|
|
306
|
+
|
|
307
|
+
## AvatarListIcon
|
|
308
|
+
|
|
309
|
+
### Fields
|
|
310
|
+
|
|
311
|
+
| Name | Required | Type | Description |
|
|
312
|
+
|---|---:|---|---|
|
|
313
|
+
| `backgroundColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | |
|
|
314
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | |
|
|
315
|
+
| `type` | yes | string | |
|
|
316
|
+
|
|
317
|
+
No additional properties.
|
|
318
|
+
|
|
319
|
+
## AvatarListPlaceholderIcon
|
|
320
|
+
|
|
321
|
+
### Fields
|
|
322
|
+
|
|
323
|
+
| Name | Required | Type | Description |
|
|
324
|
+
|---|---:|---|---|
|
|
325
|
+
| `backgroundColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | |
|
|
326
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | |
|
|
327
|
+
| `type` | yes | string | |
|
|
328
|
+
|
|
329
|
+
No additional properties.
|
|
330
|
+
|
|
331
|
+
## AvatarPlaceholderIcon
|
|
332
|
+
|
|
333
|
+
### Fields
|
|
334
|
+
|
|
335
|
+
| Name | Required | Type | Description |
|
|
336
|
+
|---|---:|---|---|
|
|
337
|
+
| `backgroundColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | |
|
|
338
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | |
|
|
339
|
+
| `type` | yes | string | |
|
|
340
|
+
|
|
341
|
+
No additional properties.
|
|
342
|
+
|
|
290
343
|
## AvatarTip
|
|
291
344
|
|
|
292
345
|
Tooltip shown on avatar hover. Object with content string and optional title
|
|
@@ -3116,6 +3169,8 @@ Avatar configuration for the header
|
|
|
3116
3169
|
| `image` | no | string | Image URL for the avatar |
|
|
3117
3170
|
| `imageBackground` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color token for avatar image background |
|
|
3118
3171
|
| `isRound` | no | boolean | If false, square avatar is shown. Default: true |
|
|
3172
|
+
| `logo` | no | [AvatarLogo](./definitions.md#avatarlogo) | Logo id from Avatar.LOGOS when type is LOGO |
|
|
3173
|
+
| `placeholderIcon` | no | string | Placeholder icon for LOGO avatars while loading or if the logo cannot be shown |
|
|
3119
3174
|
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
|
|
3120
3175
|
|
|
3121
3176
|
No additional properties.
|
|
@@ -3132,6 +3187,8 @@ Avatar configuration for the header
|
|
|
3132
3187
|
| `image` | no | string | Image URL for the avatar |
|
|
3133
3188
|
| `imageBackground` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color token for avatar image background |
|
|
3134
3189
|
| `isRound` | no | boolean | If false, square avatar is shown. Default: true |
|
|
3190
|
+
| `logo` | no | [AvatarLogo](./definitions.md#avatarlogo) | Logo id from Avatar.LOGOS when type is LOGO |
|
|
3191
|
+
| `placeholderIcon` | no | string | Placeholder icon for LOGO avatars while loading or if the logo cannot be shown |
|
|
3135
3192
|
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type |
|
|
3136
3193
|
|
|
3137
3194
|
No additional properties.
|
|
@@ -3636,6 +3693,7 @@ Additional properties: string.
|
|
|
3636
3693
|
|
|
3637
3694
|
| Name | Required | Type | Description |
|
|
3638
3695
|
|---|---:|---|---|
|
|
3696
|
+
| `avatar` | no | [AvatarListAvatar](./types.md#avatarlistavatar) | Per-role avatar overrides. Use this when different entries need different avatar types or logos |
|
|
3639
3697
|
| `fullName` | no | string | Display name |
|
|
3640
3698
|
| `id` | no | string | Unique identifier |
|
|
3641
3699
|
| `image` | no | string | Avatar image URL |
|
|
@@ -4103,6 +4161,8 @@ Avatar configuration to display with the step. Supports image URLs
|
|
|
4103
4161
|
| Name | Required | Type | Description |
|
|
4104
4162
|
|---|---:|---|---|
|
|
4105
4163
|
| `imageUrl` | no | string | URL of the avatar image |
|
|
4164
|
+
| `logo` | no | [AvatarLogo](./definitions.md#avatarlogo) | Logo id from Avatar.LOGOS when type is LOGO |
|
|
4165
|
+
| `placeholderIcon` | no | string \| [StepperPlaceholderIcon](./types.md#stepperplaceholdericon) | Placeholder icon for LOGO avatars while loading or if the logo cannot be shown |
|
|
4106
4166
|
| `type` | no | [StepperAvatarType](./definitions.md#stepperavatartype) | Avatar type |
|
|
4107
4167
|
|
|
4108
4168
|
No additional properties.
|
|
@@ -4121,6 +4181,18 @@ Badge configuration to display alongside the step title
|
|
|
4121
4181
|
|
|
4122
4182
|
No additional properties.
|
|
4123
4183
|
|
|
4184
|
+
## StepperPlaceholderIcon
|
|
4185
|
+
|
|
4186
|
+
### Fields
|
|
4187
|
+
|
|
4188
|
+
| Name | Required | Type | Description |
|
|
4189
|
+
|---|---:|---|---|
|
|
4190
|
+
| `backgroundColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | |
|
|
4191
|
+
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | |
|
|
4192
|
+
| `type` | yes | string | |
|
|
4193
|
+
|
|
4194
|
+
No additional properties.
|
|
4195
|
+
|
|
4124
4196
|
## StepperStep
|
|
4125
4197
|
|
|
4126
4198
|
### Fields
|