@rippling/pebble-sdui-web 0.21.6 → 0.22.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.
@@ -3764,6 +3764,43 @@ Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
3764
3764
 
3765
3765
  No additional properties.
3766
3766
 
3767
+ ## Iframe
3768
+
3769
+ Embed external content using an iframe with configurable dimensions and security settings.
3770
+
3771
+ src: URL to load in the iframe. Required unless srcDoc is set.
3772
+ 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.
3773
+ title: accessible title for screen readers.
3774
+ width/height: CSS value string or number in pixels.
3775
+ allow: optional native iframe Permissions Policy. Grant only the capabilities the embed requires.
3776
+ allowFullScreen: allows fullscreen mode when true.
3777
+ reloadSignal: changing this string or number reloads the iframe without changing src.
3778
+ 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.
3779
+ loading: omit (eager) for primary content; use lazy for below-the-fold embeds.
3780
+
3781
+ Catalog key: `Iframe`
3782
+ Builder: `Iframe`
3783
+ Props type: `IframeProps`
3784
+ Accepts children: no
3785
+ Events: _none_
3786
+
3787
+ ### Props
3788
+
3789
+ | Name | Required | Type | Description |
3790
+ |---|---:|---|---|
3791
+ | `allow` | no | string | Permissions Policy delegated to the embedded document through the native iframe allow attribute. |
3792
+ | `allowFullScreen` | no | boolean | Allows fullscreen mode when true. |
3793
+ | `height` | no | string \| number | CSS length string or pixel number. Default: 600px. |
3794
+ | `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. |
3795
+ | `reloadSignal` | no | string \| number | Changing this value reloads the embedded document. |
3796
+ | `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. |
3797
+ | `src` | no | string | URL of the document to embed. Required unless srcDoc is set; ignored when srcDoc is present. |
3798
+ | `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. |
3799
+ | `title` | no | string | Accessible title for screen readers. |
3800
+ | `width` | no | string \| number | CSS length string or pixel number. Default: 100%. |
3801
+
3802
+ No additional properties.
3803
+
3767
3804
  ## Image
3768
3805
 
3769
3806
  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 +3821,7 @@ Events: `press`, `load`, `error`
3784
3821
  | `assetFilter` | no | boolean | Apply dark mode filter for dark themes. Default: false |
3785
3822
  | `borderRadius` | no | [BoxRadius](./definitions.md#boxradius) | Border radius token, e.g. "shapeCornerMd" |
3786
3823
  | `height` | no | number \| string | Image height in px or CSS string |
3787
- | `loading` | no | [ImageLoading](./definitions.md#imageloading) | Loading strategy. Default: eager |
3824
+ | `loading` | no | [IframeLoading](./definitions.md#iframeloading) | Loading strategy. Default: eager |
3788
3825
  | `src` | no | string \| [Src](./types.md#src) | Image URL or theme-aware source object with light/dark variants |
3789
3826
  | `theme` | no | [ImageTheme](./definitions.md#imagetheme) | Image theme. COVER for cover positioning |
3790
3827
  | `width` | no | number \| string | Image width in px or CSS string |
@@ -4922,6 +4959,7 @@ Events: _none_
4922
4959
  | `completedPercent` | no | number | Progress percentage (0-100). Canonical ProgressBar value prop |
4923
4960
  | `isIndeterminate` | no | boolean | Shows indeterminate loading animation |
4924
4961
  | `label` | no | string | Deprecated compatibility prop for wrapper-level label text outside ProgressBar |
4962
+ | `shape` | no | [ProgressBarShape](./definitions.md#progressbarshape) | Shape of the progress bar track and indicator. Default: rounded |
4925
4963
  | `showPercentage` | no | boolean | Deprecated compatibility prop for wrapper-level percentage text outside ProgressBar |
4926
4964
  | `testId` | no | string | Deprecated testing-only prop kept for backward compatibility. Default: progress-bar |
4927
4965
  | `value` | no | number | Deprecated. Use completedPercent instead |
@@ -6566,7 +6604,7 @@ Events: _none_
6566
6604
  |---|---:|---|---|
6567
6605
  | `name` | no | string | Name attribute for the iframe element |
6568
6606
  | `allowFullScreen` | no | boolean | Allow fullscreen mode. Default: true |
6569
- | `loading` | no | [ImageLoading](./definitions.md#imageloading) | Iframe loading strategy. Default: eager |
6607
+ | `loading` | no | [IframeLoading](./definitions.md#iframeloading) | Iframe loading strategy. Default: eager |
6570
6608
  | `src` | yes | string | Video URL or embed URL (e.g. YouTube, Vimeo) |
6571
6609
  | `width` | no | number | Width of the video player in pixels. Default: 912 |
6572
6610
 
@@ -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
 
@@ -3717,6 +3718,27 @@ Referenced by:
3717
3718
  |---|---|---|
3718
3719
  | component | `ProgressBar` | `appearance` |
3719
3720
 
3721
+ ## ProgressBarShape
3722
+
3723
+ TypeScript type:
3724
+
3725
+ ```ts
3726
+ "rounded" | "square"
3727
+ ```
3728
+
3729
+ Allowed values:
3730
+
3731
+ | Value |
3732
+ |---|
3733
+ | `rounded` |
3734
+ | `square` |
3735
+
3736
+ Referenced by:
3737
+
3738
+ | Kind | Entity | Field |
3739
+ |---|---|---|
3740
+ | component | `ProgressBar` | `shape` |
3741
+
3720
3742
  ## ResponsiveAbove
3721
3743
 
3722
3744
  TypeScript type:
@@ -2,7 +2,7 @@
2
2
  # custom-apps Catalog
3
3
 
4
4
  Catalog: `custom-apps`
5
- Version: `1.12.7`
5
+ Version: `1.13.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rippling/pebble-sdui-web",
3
- "version": "0.21.6",
3
+ "version": "0.22.0",
4
4
  "description": "Type-safe TypeScript web SDK for authoring json-render specs",
5
5
  "repository": {
6
6
  "type": "git",