@rippling/pebble-sdui-web 0.21.7 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1438,7 +1438,7 @@ Events: `change`, `toggle`, `action`
1438
1438
  | `footer` | no | [DropdownFooter](./types.md#dropdownfooter) | Footer item rendered at the bottom of the list |
1439
1439
  | `isCompact` | no | boolean | Render in compact mode |
1440
1440
  | `isDisabled` | no | boolean | Disable the dropdown trigger |
1441
- | `list` | yes | [DropdownList2](./types.md#dropdownlist2) \| [DropdownListVariant2](./types.md#dropdownlistvariant2) \| [ListVariant3](./types.md#listvariant3)[] | Array of dropdown options: {label, value, isDisabled?} |
1441
+ | `list` | yes | [DropdownList2](./types.md#dropdownlist2) \| [DropdownListVariant2](./types.md#dropdownlistvariant2) \| [DropdownListVariant3](./types.md#dropdownlistvariant3)[] | Array of dropdown options: {label, value, isDisabled?} |
1442
1442
  | `maxHeight` | no | number | Max height of the dropdown list in px. Default: 224 |
1443
1443
  | `placement` | no | [DropdownPlacement](./definitions.md#dropdownplacement) | Popover position. Default: bottom-start |
1444
1444
  | `searchable` | no | boolean | Enable search within the dropdown list |
@@ -3563,6 +3563,7 @@ Grid displays data in a key-value grid layout with automatic responsive column s
3563
3563
  **Renderer types:**
3564
3564
  - TEXT: Displays plain text value. Props: { value: string, color?: text/icon color token }
3565
3565
  - LABEL: Renders a Pebble Label component. Props: { children/text, appearance, size, leftIcon/rightIcon, maxWidth, tip }. Nested icon colors must be text/icon color tokens.
3566
+ - LINK: Renders a Pebble Anchor as the value. Props: { value: string, href: string, target?: '_self' | '_blank', rel?: string, color?: text/icon color token }. Internal absolute paths use the host router; HTTP(S) URLs always open in a new tab with noopener noreferrer. Empty value renders no link. Navigation only; use Grid actions for events.
3566
3567
 
3567
3568
  **Actions:**
3568
3569
  - Each action must have unique id
@@ -3586,7 +3587,7 @@ Events: `actionClick`
3586
3587
  |---|---:|---|---|
3587
3588
  | `actionClickedId` | no | string | Stores the id of the clicked action. Bind to state path to access in actionClick event handler |
3588
3589
  | `actions` | no | [GridAction](./types.md#gridaction)[] | Array of action buttons displayed at the bottom of the grid. Each action emits actionClick event with id in state |
3589
- | `list` | yes | [GridList](./types.md#gridlist) \| [GridListVariant2](./types.md#gridlistvariant2)[] | Array of cells to display in the grid. Each cell has a label and renderer with props |
3590
+ | `list` | yes | [GridList](./types.md#gridlist) \| [GridListVariant2](./types.md#gridlistvariant2) \| [GridListVariant3](./types.md#gridlistvariant3)[] | Array of cells to display in the grid. Each cell has a label and renderer with props |
3590
3591
  | `theme` | no | [GridTheme](./definitions.md#gridtheme) | Visual theme variant. NO_CARD removes card styling, TRANSPARENT uses transparent theme, NO_PADDING removes padding. Default: card with padding |
3591
3592
 
3592
3593
  No additional properties.
@@ -3764,6 +3765,43 @@ Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
3764
3765
 
3765
3766
  No additional properties.
3766
3767
 
3768
+ ## Iframe
3769
+
3770
+ Embed external content using an iframe with configurable dimensions and security settings.
3771
+
3772
+ src: URL to load in the iframe. Required unless srcDoc is set.
3773
+ srcDoc: inline HTML (markup, styles, images, links) instead of a URL. Always sandboxed: no cookies/localStorage, no scripts unless allow-scripts is requested. Add allow-popups for target=_blank links.
3774
+ title: accessible title for screen readers.
3775
+ width/height: CSS value string or number in pixels.
3776
+ allow: optional native iframe Permissions Policy. Grant only the capabilities the embed requires.
3777
+ allowFullScreen: allows fullscreen mode when true.
3778
+ reloadSignal: changing this string or number reloads the iframe without changing src.
3779
+ sandbox: extra tokens to grant. Commonly needed: allow-forms, allow-popups, allow-modals, allow-downloads. allow-scripts is always added for src URLs but not for srcDoc. allow-top-navigation(-by-user-activation) and allow-popups-to-escape-sandbox are always stripped. allow-same-origin is honored only for Rippling-trusted vendor hosts; other embeds run in an opaque origin (document.cookie and localStorage blocked) — use token-based auth via URL or postMessage.
3780
+ loading: omit (eager) for primary content; use lazy for below-the-fold embeds.
3781
+
3782
+ Catalog key: `Iframe`
3783
+ Builder: `Iframe`
3784
+ Props type: `IframeProps`
3785
+ Accepts children: no
3786
+ Events: _none_
3787
+
3788
+ ### Props
3789
+
3790
+ | Name | Required | Type | Description |
3791
+ |---|---:|---|---|
3792
+ | `allow` | no | string | Permissions Policy delegated to the embedded document through the native iframe allow attribute. |
3793
+ | `allowFullScreen` | no | boolean | Allows fullscreen mode when true. |
3794
+ | `height` | no | string \| number | CSS length string or pixel number. Default: 600px. |
3795
+ | `loading` | no | [IframeLoading](./definitions.md#iframeloading) | Use lazy for below-the-fold or secondary embeds to defer loading until near the viewport. Omit (eager) for primary content that must render immediately. |
3796
+ | `reloadSignal` | no | string \| number | Changing this value reloads the embedded document. |
3797
+ | `sandbox` | no | string | Sandbox tokens to grant, e.g. allow-forms, allow-popups (new-tab links), allow-modals. allow-scripts is always added for src URLs; srcDoc embeds get no tokens unless requested. allow-top-navigation is always stripped. allow-same-origin is honored only for trusted vendor hosts (appetize.io); otherwise document.cookie and localStorage are unavailable to the embed. |
3798
+ | `src` | no | string | URL of the document to embed. Required unless srcDoc is set; ignored when srcDoc is present. |
3799
+ | `srcDoc` | no | string | Inline HTML document (markup, styles, images, links) to embed instead of loading a URL. Always sandboxed in an opaque origin: no cookies/localStorage, and scripts do not run unless you explicitly request allow-scripts. Use sandbox="allow-popups" if links should open in a new tab. |
3800
+ | `title` | no | string | Accessible title for screen readers. |
3801
+ | `width` | no | string \| number | CSS length string or pixel number. Default: 100%. |
3802
+
3803
+ No additional properties.
3804
+
3767
3805
  ## Image
3768
3806
 
3769
3807
  Displays an image with optional theme-aware light/dark sources, lazy loading, and click interaction. Use for static or decorative images — use Avatar for user profile pictures, Icon for symbolic glyphs, or ImageViewer for zoomable image galleries.
@@ -3784,7 +3822,7 @@ Events: `press`, `load`, `error`
3784
3822
  | `assetFilter` | no | boolean | Apply dark mode filter for dark themes. Default: false |
3785
3823
  | `borderRadius` | no | [BoxRadius](./definitions.md#boxradius) | Border radius token, e.g. "shapeCornerMd" |
3786
3824
  | `height` | no | number \| string | Image height in px or CSS string |
3787
- | `loading` | no | [ImageLoading](./definitions.md#imageloading) | Loading strategy. Default: eager |
3825
+ | `loading` | no | [IframeLoading](./definitions.md#iframeloading) | Loading strategy. Default: eager |
3788
3826
  | `src` | no | string \| [Src](./types.md#src) | Image URL or theme-aware source object with light/dark variants |
3789
3827
  | `theme` | no | [ImageTheme](./definitions.md#imagetheme) | Image theme. COVER for cover positioning |
3790
3828
  | `width` | no | number \| string | Image width in px or CSS string |
@@ -4437,24 +4475,40 @@ No additional properties.
4437
4475
 
4438
4476
  Header section of an entity overview (person, organization, device) displaying an avatar, title, caption, optional label chip, and an optional primary action. Used at the top of ObjectUI layouts to identify the entity at a glance.
4439
4477
 
4440
- ObjectUIHeader renders the header section of an ObjectUI layout with an avatar, title, caption, optional label chip, and optional primary action. Clicking primaryAction emits the primaryAction event. primaryActionLabel is deprecated and kept only for backward compatibility; prefer primaryAction.label for new specs. Complex actions (button dropdowns, select actions, responsive action groups) are not supported — compose those with separate JSON-render components outside ObjectUIHeader.
4478
+ ObjectUIHeader renders the header section of an ObjectUI layout with an avatar, title, caption, optional label chip, primary action, and responsive actions.
4479
+
4480
+ **Rich title and caption:**
4481
+ Use the title and caption string props for simple headers, or slots.title and slots.caption (arrays of element IDs) for rich content such as text with Badge, Status, or Label. Each non-empty slot replaces its corresponding string prop; an absent or empty slot uses the string fallback. A referenced element that is hidden or renders null still selects the slot, so keep the title text visible and conditionally hide only its supplemental atoms. Ordinary children are not rendered. Slot content is passed through to the React header: include a semantic heading in the title slot (for example Text with as: "h3" and typestyle: "typestyleTitleSmall"); strings get the built-in h3 styling automatically. Compose multiple atoms in an HStack with align: "center", wrap: "wrap", and a spacing token. The legacy label chip remains alongside the title. Slot elements support standard state expressions and their own events.
4482
+
4483
+ **Responsive actions:**
4484
+ - actions.list supports BUTTON and ICON actions and follows the React ObjectUI.Header actions shape.
4485
+ - Each action requires a unique id. Clicking it writes the id to actionClickedId, then emits action.
4486
+ - Bind actionClickedId to state to identify the clicked action in the event handler.
4487
+ - actions.limit controls how many actions remain visible before overflow behavior applies.
4488
+ - isDisabled and shouldShowSpinner support nested state expressions. Loading actions do not emit action, including from overflow; overflow items do not display a spinner.
4489
+ - Give ICON actions a label or aria-label for a meaningful accessible name and overflow text. If both are omitted, the icon name is used as a fallback.
4490
+ - Control action visibility by resolving actions.list from state or a conditional expression; there is no per-action visibility callback in JSON.
4491
+
4492
+ Clicking primaryAction emits primaryAction. primaryActionLabel is deprecated and kept only for backward compatibility; prefer primaryAction.label for new specs. buttonDropdownActions and inputSelectActions remain unsupported because their nested interactive APIs are not serializable.
4441
4493
 
4442
4494
  Catalog key: `ObjectUIHeader`
4443
4495
  Builder: `ObjectUIHeader`
4444
4496
  Props type: `ObjectUIHeaderProps`
4445
4497
  Accepts children: no
4446
- Events: `primaryAction`
4498
+ Events: `primaryAction`, `action`
4447
4499
 
4448
4500
  ### Props
4449
4501
 
4450
4502
  | Name | Required | Type | Description |
4451
4503
  |---|---:|---|---|
4504
+ | `actionClickedId` | no | string | Stores the clicked actions.list item id. Bind to state to read it in action handlers |
4505
+ | `actions` | no | [ObjectUIHeaderAction](./types.md#objectuiheaderaction) | Responsive action list. Clicking an item emits action and updates actionClickedId |
4452
4506
  | `avatarProps` | no | [ObjectUIHeaderAvatarProp](./types.md#objectuiheaderavatarprop) | Avatar configuration for the header |
4453
- | `caption` | no | string | Header caption text below the title |
4507
+ | `caption` | no | string | Header caption text below the title. Fallback when the caption slot is absent or empty |
4454
4508
  | `label` | no | [LabelValue](./types.md#labelvalue) | Label chip displayed next to the title |
4455
4509
  | `primaryAction` | no | [ObjectUIHeaderPrimaryAction](./types.md#objectuiheaderprimaryaction) | Primary action button. Clicking it emits the primaryAction event |
4456
4510
  | `primaryActionLabel` | no | string | Deprecated. Use primaryAction.label instead for the primary action button text |
4457
- | `title` | no | string | Header title text |
4511
+ | `title` | no | string | Header title text. Fallback when the title slot is absent or empty |
4458
4512
 
4459
4513
  No additional properties.
4460
4514
 
@@ -4470,6 +4524,7 @@ ObjectUIStats displays key metrics in a grid layout within an ObjectUI page. Use
4470
4524
  **Renderer types:**
4471
4525
  - TEXT: Displays plain text value. Props: { value: string, color?: text/icon color token }
4472
4526
  - LABEL: Renders a Pebble Label component. Props: { children/text, appearance, size, leftIcon/rightIcon, maxWidth, tip }. Nested icon colors must be text/icon color tokens.
4527
+ - LINK: Renders a Pebble Anchor as the value. Props: { value: string, href: string, target?: '_self' | '_blank', rel?: string, color?: text/icon color token }. Internal absolute paths use the host router; HTTP(S) URLs always open in a new tab with noopener noreferrer. Empty value renders no link. Navigation only; use Grid actions for events.
4473
4528
 
4474
4529
  **Actions:**
4475
4530
  - Each action must have unique id
@@ -4493,7 +4548,7 @@ Events: `actionClick`
4493
4548
  |---|---:|---|---|
4494
4549
  | `actionClickedId` | no | string | Stores the id of the clicked action. Bind to state path to access in actionClick event handler |
4495
4550
  | `actions` | no | [ObjectUIStatsAction](./types.md#objectuistatsaction)[] | Array of action buttons displayed at the bottom of the grid. Each action emits actionClick event with id in state |
4496
- | `list` | yes | [ObjectUIStatsList](./types.md#objectuistatslist) \| [ObjectUIStatsListVariant2](./types.md#objectuistatslistvariant2)[] | Array of cells to display in the stats grid. Each cell has a label and renderer with props |
4551
+ | `list` | yes | [ObjectUIStatsList](./types.md#objectuistatslist) \| [ObjectUIStatsListVariant2](./types.md#objectuistatslistvariant2) \| [ObjectUIStatsListVariant3](./types.md#objectuistatslistvariant3)[] | Array of cells to display in the stats grid. Each cell has a label and renderer with props |
4497
4552
 
4498
4553
  No additional properties.
4499
4554
 
@@ -5985,7 +6040,7 @@ Events: _none_
5985
6040
  | Name | Required | Type | Description |
5986
6041
  |---|---:|---|---|
5987
6042
  | `align` | no | [HeadingAlign](./definitions.md#headingalign) | Text alignment |
5988
- | `as` | no | string | HTML element to render (e.g. "p", "span", "div", "pre"). Default: p |
6043
+ | `as` | no | string | HTML element to render: p, span, div, pre, or h1–h6. Default: p |
5989
6044
  | `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token resolved via the current theme. |
5990
6045
  | `decoration` | no | string | Text decoration CSS value (e.g. "underline", "line-through") |
5991
6046
  | `inline` | no | boolean | Display as inline element instead of block |
@@ -6567,7 +6622,7 @@ Events: _none_
6567
6622
  |---|---:|---|---|
6568
6623
  | `name` | no | string | Name attribute for the iframe element |
6569
6624
  | `allowFullScreen` | no | boolean | Allow fullscreen mode. Default: true |
6570
- | `loading` | no | [ImageLoading](./definitions.md#imageloading) | Iframe loading strategy. Default: eager |
6625
+ | `loading` | no | [IframeLoading](./definitions.md#iframeloading) | Iframe loading strategy. Default: eager |
6571
6626
  | `src` | yes | string | Video URL or embed URL (e.g. YouTube, Vimeo) |
6572
6627
  | `width` | no | number | Width of the video player in pixels. Default: 912 |
6573
6628
 
@@ -2873,7 +2873,7 @@ Referenced by:
2873
2873
  |---|---|---|
2874
2874
  | type | `IconTip` | `placement` |
2875
2875
 
2876
- ## ImageLoading
2876
+ ## IframeLoading
2877
2877
 
2878
2878
  TypeScript type:
2879
2879
 
@@ -2892,6 +2892,7 @@ Referenced by:
2892
2892
 
2893
2893
  | Kind | Entity | Field |
2894
2894
  |---|---|---|
2895
+ | component | `Iframe` | `loading` |
2895
2896
  | component | `Image` | `loading` |
2896
2897
  | component | `Video` | `loading` |
2897
2898
 
@@ -2,7 +2,7 @@
2
2
  # custom-apps Catalog
3
3
 
4
4
  Catalog: `custom-apps`
5
- Version: `1.12.8`
5
+ Version: `1.14.0`
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.
@@ -1222,6 +1222,16 @@ Additional properties: unknown.
1222
1222
 
1223
1223
  Additional properties: unknown.
1224
1224
 
1225
+ ## DropdownListVariant3
1226
+
1227
+ ### Fields
1228
+
1229
+ | Name | Required | Type | Description |
1230
+ |---|---:|---|---|
1231
+ | `isSeparator` | yes | true | Render a visual separator |
1232
+
1233
+ No additional properties.
1234
+
1225
1235
  ## DropdownTag
1226
1236
 
1227
1237
  ### Fields
@@ -2704,6 +2714,19 @@ No additional properties.
2704
2714
 
2705
2715
  No additional properties.
2706
2716
 
2717
+ ## GridListVariant3
2718
+
2719
+ ### Fields
2720
+
2721
+ | Name | Required | Type | Description |
2722
+ |---|---:|---|---|
2723
+ | `label` | yes | string \| number | Label displayed in the cell header. String or number value |
2724
+ | `props` | yes | Record<string, unknown> | Props for a linked cell: { value, href, target?, rel?, color? }. Uses Anchor navigation; HTTP(S) links open in a new tab with noopener noreferrer. Color must be a Pebble text/icon color token. |
2725
+ | `renderer` | yes | "LINK" | Renderer type for the cell value. LINK renders an Anchor. |
2726
+ | `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
2727
+
2728
+ No additional properties.
2729
+
2707
2730
  ## GridProp
2708
2731
 
2709
2732
  Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
@@ -3079,16 +3102,6 @@ No additional properties.
3079
3102
 
3080
3103
  No additional properties.
3081
3104
 
3082
- ## ListVariant3
3083
-
3084
- ### Fields
3085
-
3086
- | Name | Required | Type | Description |
3087
- |---|---:|---|---|
3088
- | `isSeparator` | yes | true | Render a visual separator |
3089
-
3090
- No additional properties.
3091
-
3092
3105
  ## LoadConfig
3093
3106
 
3094
3107
  Semantic Lottie load configuration object
@@ -3258,6 +3271,19 @@ Avatar configuration for the header
3258
3271
 
3259
3272
  No additional properties.
3260
3273
 
3274
+ ## ObjectUIHeaderAction
3275
+
3276
+ Responsive action list. Clicking an item emits action and updates actionClickedId
3277
+
3278
+ ### Fields
3279
+
3280
+ | Name | Required | Type | Description |
3281
+ |---|---:|---|---|
3282
+ | `limit` | yes | number | Maximum visible actions before remaining actions move into an overflow menu |
3283
+ | `list` | yes | [ObjectUIHeaderList](./types.md#objectuiheaderlist) \| [ObjectUIHeaderListVariant2](./types.md#objectuiheaderlistvariant2)[] | Responsive button and icon actions shown in the header |
3284
+
3285
+ No additional properties.
3286
+
3261
3287
  ## ObjectUIHeaderAvatarProp
3262
3288
 
3263
3289
  Avatar configuration for the header
@@ -3290,6 +3316,30 @@ No additional properties.
3290
3316
 
3291
3317
  No additional properties.
3292
3318
 
3319
+ ## ObjectUIHeaderList
3320
+
3321
+ ### Fields
3322
+
3323
+ | Name | Required | Type | Description |
3324
+ |---|---:|---|---|
3325
+ | `id` | yes | string | JSON-only action identifier written to actionClickedId before the action event |
3326
+ | `props` | yes | Record<string, unknown> | |
3327
+ | `type` | yes | "BUTTON" | |
3328
+
3329
+ No additional properties.
3330
+
3331
+ ## ObjectUIHeaderListVariant2
3332
+
3333
+ ### Fields
3334
+
3335
+ | Name | Required | Type | Description |
3336
+ |---|---:|---|---|
3337
+ | `id` | yes | string | JSON-only action identifier written to actionClickedId before the action event |
3338
+ | `props` | yes | Record<string, unknown> | |
3339
+ | `type` | yes | "ICON" | |
3340
+
3341
+ No additional properties.
3342
+
3293
3343
  ## ObjectUIHeaderPrimaryAction
3294
3344
 
3295
3345
  Primary action button. Clicking it emits the primaryAction event
@@ -3374,6 +3424,19 @@ No additional properties.
3374
3424
 
3375
3425
  No additional properties.
3376
3426
 
3427
+ ## ObjectUIStatsListVariant3
3428
+
3429
+ ### Fields
3430
+
3431
+ | Name | Required | Type | Description |
3432
+ |---|---:|---|---|
3433
+ | `label` | yes | string \| number | Label displayed in the cell header. String or number value |
3434
+ | `props` | yes | Record<string, unknown> | Props for a linked cell: { value, href, target?, rel?, color? }. Uses Anchor navigation; HTTP(S) links open in a new tab with noopener noreferrer. Color must be a Pebble text/icon color token. |
3435
+ | `renderer` | yes | "LINK" | Renderer type for the cell value. LINK renders an Anchor. |
3436
+ | `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
3437
+
3438
+ No additional properties.
3439
+
3377
3440
  ## ObjectUIStatsProp
3378
3441
 
3379
3442
  Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rippling/pebble-sdui-web",
3
- "version": "0.21.7",
3
+ "version": "0.23.0",
4
4
  "description": "Type-safe TypeScript web SDK for authoring json-render specs",
5
5
  "repository": {
6
6
  "type": "git",