@rippling/pebble-sdui-web 0.18.2 → 0.19.1

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.
@@ -255,7 +255,7 @@ No additional properties.
255
255
 
256
256
  A visual representation of an entity, such as a user, organization, or product. Use circular shape (isRounded=true) for people and rounded square (isRounded=false) for non-human entities like organizations or brands.
257
257
 
258
- Type semantics: USER is the default for people (shows image or initials fallback). TEXT shows first+last initials from title. ICON displays a specified icon to represent an entity. NUMBER indicates overflow count in avatar lists. RIPPLING is exclusive to the Rippling brand. Badge and flag are mutually exclusive — use either badge or flagCountryCode, not both. When using flagCountryCode, surfaceColor is required. tip.content accepts a plain string for tooltip text shown on hover.
258
+ Type semantics: USER is the default for people (shows image or initials fallback). TEXT shows first+last initials from title. ICON displays a specified icon to represent an entity. LOGO renders a known brand from Avatar.LOGOS and falls back to an icon placeholder while loading or on failure. NUMBER indicates overflow count in avatar lists. RIPPLING is the dedicated Rippling brand path. Badge and flag are mutually exclusive — use either badge or flagCountryCode, not both. When using flagCountryCode, surfaceColor is required. tip.content accepts a plain string for tooltip text shown on hover.
259
259
 
260
260
  Catalog key: `Avatar`
261
261
  Builder: `Avatar`
@@ -279,6 +279,8 @@ Events: `press`
279
279
  | `imageBackground` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color token behind the avatar image |
280
280
  | `isCompact` | no | boolean | Compact mode hides title and caption. Default: false |
281
281
  | `isRounded` | no | boolean | Fully rounded (circle) shape. Default: true |
282
+ | `logo` | no | [AvatarLogo](./definitions.md#avatarlogo) | Logo id from Avatar.LOGOS when type is LOGO |
283
+ | `placeholderIcon` | no | string \| [AvatarPlaceholderIcon](./types.md#avatarplaceholdericon) | Placeholder icon for LOGO avatars while loading or if the logo cannot be shown. Defaults to IMAGE_OUTLINE |
282
284
  | `size` | no | 24 \| 32 \| 40 \| 56 \| 64 | Avatar size in pixels. One of: 24, 32, 40, 56, 64. Default: 40 |
283
285
  | `surfaceColor` | no | [AvatarImageBackground](./definitions.md#avatarimagebackground) | Surface color for flag background. Pebble color token. Required with flagCountryCode |
284
286
  | `tip` | no | [AvatarTip](./types.md#avatartip) | Tooltip shown on avatar hover. Object with content string and optional title |
@@ -310,6 +312,7 @@ Events: _none_
310
312
  | `aria-labelledby` | no | string | ID of element that labels the avatar list |
311
313
  | `isRounded` | no | boolean | If false, avatars render as rounded squares |
312
314
  | `limit` | no | number | Maximum number of avatars to display before +N overflow |
315
+ | `logo` | no | [AvatarLogo](./definitions.md#avatarlogo) | Shared logo id for list-level LOGO avatars. Prefer roles[].avatar.logo when entries differ |
313
316
  | `modalTitle` | no | string | Title of the modal shown when clicking overflow |
314
317
  | `roles` | no | [Role](./types.md#role)[] | Array of role/person objects for avatars |
315
318
  | `size` | no | 24 \| 32 \| 40 \| 56 \| 64 | Avatar size in pixels. One of: 24, 32, 40, 56, 64. Default: 40 |
@@ -1590,7 +1593,7 @@ No additional properties.
1590
1593
 
1591
1594
  A layout wrapper that provides consistent structure around form inputs, including a label, required indicator, helper or error message, tooltip, read-only mode, and inline (side-by-side) layout option. Use Field to wrap any form input component.
1592
1595
 
1593
- Field is a layout wrapper for form inputs. Place the actual input component as a child. helperMessage can be a plain string or an object { message, status } where status "ERROR" shows the message as an error.
1596
+ Field is a layout wrapper for form inputs. Place the actual input component in `children`. Use the string `label` prop for plain text or `slots.label` for rich label content; the named slot takes precedence. helperMessage can be a plain string or an object { message, status } where status "ERROR" shows the message as an error.
1594
1597
 
1595
1598
  Catalog key: `Field`
1596
1599
  Builder: `Field`
@@ -1812,7 +1815,7 @@ Stores a boolean (true/false) value keyed by `name` in the parent Form's values.
1812
1815
  Use `defaultValue: true` to pre-check the box.
1813
1816
  Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync. Reads initial value from state (controlled); access current value in on.change actions via `{ $state: "/path" }`.
1814
1817
  onChange emits "change".
1815
- Rich labels: children (if any) are rendered as the checkbox label and take precedence over the `label` prop; `label` remains the string fallback. Use this for labels containing inline elements, e.g. an agreement checkbox whose label embeds a Link. Use Text with inline=true so copy and links flow inline, and Link with href. Note: the label container programmatically clicks the input, so clicking an embedded Link will also toggle the checkbox. Prefer the plain string `label` for simple text.
1818
+ Rich labels: `slots.label` takes precedence over legacy label children, which take precedence over the string `label` prop. Use Text with inline=true so copy and links flow inline, and Link with href. Note: the label container programmatically clicks the input, so clicking an embedded Link will also toggle the checkbox. Prefer the plain string `label` for simple text.
1816
1819
 
1817
1820
  Catalog key: `FormCheckbox`
1818
1821
  Builder: `FormCheckbox`
@@ -1848,6 +1851,7 @@ No additional properties.
1848
1851
 
1849
1852
  A Form-registered checkbox group for use inside a Form component.
1850
1853
 
1854
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
1851
1855
  Must be placed inside a Form element — registers with Form and does not work standalone.
1852
1856
  Stores an array of selected values keyed by `name` in the parent Form's values.
1853
1857
  Uses Form.Input.Checkbox.Group internally — the Form-aware variant of CheckboxGroup.
@@ -1908,6 +1912,7 @@ No additional properties.
1908
1912
 
1909
1913
  A Form-registered currency field for use inside a Form component.
1910
1914
 
1915
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
1911
1916
  Must be placed inside a Form element — it registers with Form and does not work standalone.
1912
1917
  Values flow through the parent Form's `values` push-binding on submit/change.
1913
1918
  Use `prefix` to set the currency symbol (e.g. "USD", "$").
@@ -1951,6 +1956,7 @@ No additional properties.
1951
1956
 
1952
1957
  A Form-registered date picker for use inside a Form component.
1953
1958
 
1959
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
1954
1960
  Must be placed inside a Form element — registers with Form and does not work standalone.
1955
1961
  Stores a date string in the chosen format (default: `yyyy-MM-dd`) keyed by `name` in the parent Form's values.
1956
1962
  Always supply defaultValue as a yyyy-MM-dd string regardless of the display format.
@@ -1996,6 +2002,7 @@ No additional properties.
1996
2002
 
1997
2003
  A Form-registered date range picker for selecting start and end dates inside a Form component.
1998
2004
 
2005
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
1999
2006
  Must be placed inside a Form element — registers with Form and does not work standalone.
2000
2007
  Stores an array of two date strings [startDate, endDate] keyed by `name` in the parent Form values.
2001
2008
  Bind `value` with `{ $bindState: "/path" }` to initialize the range picker from state and keep state in sync.
@@ -2049,6 +2056,7 @@ No additional properties.
2049
2056
 
2050
2057
  A Form-registered day-of-week selector for use inside a Form component.
2051
2058
 
2059
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2052
2060
  Must be placed inside a Form element — it registers with Form and does not work standalone.
2053
2061
  Single-select stores a day name string; isMulti stores an array of day name strings.
2054
2062
  Valid day names: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
@@ -2085,6 +2093,7 @@ No additional properties.
2085
2093
 
2086
2094
  A Form-registered email field with built-in email validation, for use inside a Form component.
2087
2095
 
2096
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2088
2097
  Must be placed inside a Form element — registers with Form and does not work standalone.
2089
2098
  Pebble applies isEmail validation by default for Form.Input.Email.
2090
2099
  Values flow through the parent Form's `values` push-binding on submit/change.
@@ -2157,6 +2166,7 @@ No additional properties.
2157
2166
 
2158
2167
  A Form-registered file upload field for use inside a Form component.
2159
2168
 
2169
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2160
2170
  Must be placed inside a Form element — it registers with Form and does not work standalone.
2161
2171
  Individual values are not bound to state; they flow through the parent Form's `values` push-binding on submit/change.
2162
2172
  Use `validations` for Form rule strings.
@@ -2205,6 +2215,7 @@ No additional properties.
2205
2215
 
2206
2216
  A Form-registered file upload field for use inside a Form component.
2207
2217
 
2218
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2208
2219
  Must be placed inside a Form element — it registers with Form and does not work standalone.
2209
2220
  Individual values are not bound to state; they flow through the parent Form's `values` push-binding on submit/change.
2210
2221
  Use `validations` for Form rule strings.
@@ -2351,6 +2362,7 @@ No additional properties.
2351
2362
 
2352
2363
  A Form-registered grouped input layout that combines one main input with optional prefix and suffix inputs.
2353
2364
 
2365
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2354
2366
  Must be placed inside a Form element.
2355
2367
  `input`, `prefix`, and `suffix` use the same input configuration shape as standalone InputGroup; their `inputProps` are direct Pebble input props.
2356
2368
  For nested Select inputs, use Pebble `list` instead of the json-render Select catalog `options` prop.
@@ -2397,6 +2409,7 @@ No additional properties.
2397
2409
 
2398
2410
  A Form-registered masked text input for values with a fixed format.
2399
2411
 
2412
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2400
2413
  Must be placed inside a Form element — registers with Form and does not work standalone.
2401
2414
  Mask characters: 9 = digit, a = letter, * = any character.
2402
2415
  Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
@@ -2446,6 +2459,7 @@ No additional properties.
2446
2459
 
2447
2460
  A Form-registered numeric field for use inside a Form component.
2448
2461
 
2462
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2449
2463
  Must be placed inside a Form element — registers with Form and does not work standalone.
2450
2464
  Values flow through the parent Form's `values` push-binding on submit/change.
2451
2465
  Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync. Reads initial value from state (controlled); access current value in on.change actions via `{ $state: "/path" }`.
@@ -2500,6 +2514,7 @@ No additional properties.
2500
2514
 
2501
2515
  A Form-registered password field with show/hide toggle, for use inside a Form component.
2502
2516
 
2517
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2503
2518
  Must be placed inside a Form element — registers with Form and does not work standalone.
2504
2519
  Includes a built-in show/hide toggle for the password.
2505
2520
  Values flow through the parent Form's `values` push-binding on submit/change.
@@ -2551,6 +2566,7 @@ No additional properties.
2551
2566
 
2552
2567
  A Form-registered percentage field for use inside a Form component.
2553
2568
 
2569
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2554
2570
  Must be placed inside a Form element — it registers with Form and does not work standalone.
2555
2571
  Values flow through the parent Form's `values` push-binding on submit/change.
2556
2572
  Use `lowerLimit` and `upperLimit` to constrain the allowed range.
@@ -2595,6 +2611,7 @@ No additional properties.
2595
2611
 
2596
2612
  A Form-registered phone number field with region-based formatting, for use inside a Form component.
2597
2613
 
2614
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2598
2615
  Must be placed inside a Form element — registers with Form and does not work standalone.
2599
2616
  Stores the formatted phone number string keyed by `name` in the parent Form's values.
2600
2617
  Use defaultRegion to set the formatting region (US, IN, CA, etc.). Defaults to US.
@@ -2646,6 +2663,7 @@ No additional properties.
2646
2663
 
2647
2664
  A Form-registered radio group for use inside a Form component.
2648
2665
 
2666
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2649
2667
  Must be placed inside a Form element — registers with Form and does not work standalone.
2650
2668
  Stores the selected option's `value` keyed by `name` in the parent Form's values.
2651
2669
  Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync. Reads initial value from state (controlled); access current value in on.change actions via `{ $state: "/path" }`.
@@ -2716,6 +2734,7 @@ No additional properties.
2716
2734
 
2717
2735
  A Form-registered segmented control for use inside a Form component.
2718
2736
 
2737
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2719
2738
  Must be placed inside a Form element — it registers with Form and does not work standalone.
2720
2739
  Single-select stores a string; isMulti stores an array of strings.
2721
2740
  Values flow through the parent Form's `values` push-binding on submit/change.
@@ -2757,6 +2776,7 @@ No additional properties.
2757
2776
 
2758
2777
  A Form-registered dropdown select for use inside a Form component.
2759
2778
 
2779
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2760
2780
  Must be placed inside a Form element — registers with Form and does not work standalone.
2761
2781
  Single-select stores the selected value; isMulti stores an array of selected values.
2762
2782
  Values flow through the parent Form's `values` push-binding on submit/change.
@@ -2811,6 +2831,7 @@ No additional properties.
2811
2831
 
2812
2832
  A Form-registered card-based selection group for single or multi-choice choices inside a Form.
2813
2833
 
2834
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2814
2835
  Must be placed inside a Form element — registers with Form and does not work standalone.
2815
2836
  Single-select stores one value; `isMulti` stores an array of selected values.
2816
2837
  Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
@@ -2853,6 +2874,7 @@ No additional properties.
2853
2874
 
2854
2875
  A Form-registered signature capture input for drawing or typing a signature inside a Form.
2855
2876
 
2877
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2856
2878
  Must be placed inside a Form element — registers with Form and does not work standalone.
2857
2879
  Stores a base64 PNG data URL string keyed by `name` in the parent Form values.
2858
2880
  Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
@@ -2894,6 +2916,7 @@ No additional properties.
2894
2916
 
2895
2917
  A Form-registered SIN (Social Insurance Number) masked field for use inside a Form. Applies the Canadian SIN format mask (999 999 999) automatically.
2896
2918
 
2919
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2897
2920
  Must be placed inside a Form element — it registers with Form and does not work standalone.
2898
2921
  The Canadian SIN mask (999 999 999) is applied automatically — no need to configure the mask.
2899
2922
  Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync. Reads initial value from state (controlled); access current value in on.change actions via `{ $state: "/path" }`.
@@ -2931,6 +2954,7 @@ No additional properties.
2931
2954
 
2932
2955
  A Form-registered slider for use inside a Form component.
2933
2956
 
2957
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2934
2958
  Must be placed inside a Form element — it registers with Form and does not work standalone.
2935
2959
  Values flow through the parent Form's `values` push-binding on submit/change.
2936
2960
  Use `marks` to label specific positions on the slider track.
@@ -2973,6 +2997,7 @@ No additional properties.
2973
2997
 
2974
2998
  A Form-registered SSN (Social Security Number) masked field for use inside a Form. Applies the US SSN format mask (999-99-9999) automatically.
2975
2999
 
3000
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
2976
3001
  Must be placed inside a Form element — it registers with Form and does not work standalone.
2977
3002
  The US SSN mask (999-99-9999) is applied automatically — no need to configure the mask.
2978
3003
  Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync. Reads initial value from state (controlled); access current value in on.change actions via `{ $state: "/path" }`.
@@ -3010,6 +3035,7 @@ No additional properties.
3010
3035
 
3011
3036
  A Form-registered survey/rating input for collecting a bounded opinion or score inside a Form.
3012
3037
 
3038
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
3013
3039
  Must be placed inside a Form element — registers with Form and does not work standalone.
3014
3040
  Single-select stores one value; `isMulti` stores an array of selected values.
3015
3041
  Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
@@ -3049,6 +3075,7 @@ No additional properties.
3049
3075
 
3050
3076
  A Form-registered toggle switch for use inside a Form component.
3051
3077
 
3078
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
3052
3079
  Must be placed inside a Form element — it registers with Form and does not work standalone.
3053
3080
  Stores a boolean (true/false) value keyed by `name` in the parent Form's values.
3054
3081
  Use `defaultValue: true` to pre-toggle the switch on.
@@ -3096,6 +3123,7 @@ Browser/input behavior props such as `minLength`, `autoCapitalize`, `autoCorrect
3096
3123
  Use `validationErrors` to override default error messages per rule.
3097
3124
  `helperMessage` displays supporting text below the input. Validation errors temporarily replace it, and it returns when validation clears.
3098
3125
  `isRequired` blocks form submission when empty and shows an error.
3126
+ Labels: use the string `label` prop for plain text. For rich labels, provide element IDs through the named `slots.label` slot; it takes precedence over `label` and can compose inline Text, Link, or other renderable SDUI elements.
3099
3127
  Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync. Reads initial value from state (controlled); access current value in on.change actions via `{ $state: "/path" }`.
3100
3128
  onChange emits "change"; onBlur emits "blur".
3101
3129
 
@@ -3145,6 +3173,7 @@ No additional properties.
3145
3173
 
3146
3174
  A Form-registered multi-line textarea for use inside a Form component.
3147
3175
 
3176
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
3148
3177
  Must be placed inside a Form element — registers with Form and does not work standalone.
3149
3178
  Values flow through the parent Form's `values` push-binding on submit/change.
3150
3179
  Set hasCharsLimit with maxLength to show a character counter.
@@ -3188,6 +3217,7 @@ No additional properties.
3188
3217
 
3189
3218
  A Form-registered text field with auto-suggest dropdown for use inside a Form component.
3190
3219
 
3220
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
3191
3221
  Must be placed inside a Form element — it registers with Form and does not work standalone.
3192
3222
  Values flow through the parent Form's `values` push-binding on submit/change.
3193
3223
  Pass `list` as the React-style flat suggestion list. Common fields are `label`, `value`, and `isDisabled`; extra serializable item metadata is preserved.
@@ -3230,6 +3260,7 @@ No additional properties.
3230
3260
 
3231
3261
  A Form-registered time picker field for use inside a Form component.
3232
3262
 
3263
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
3233
3264
  Must be placed inside a Form element — it registers with Form and does not work standalone.
3234
3265
  Accepts ISO 8601 time strings or "HH:MM AM/PM" format as defaultValue.
3235
3266
  Use timezone to specify the IANA timezone name for display and value handling.
@@ -3279,6 +3310,7 @@ No additional properties.
3279
3310
 
3280
3311
  A Form-registered timezone selector for choosing an IANA timezone inside a Form.
3281
3312
 
3313
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
3282
3314
  Must be placed inside a Form element — registers with Form and does not work standalone.
3283
3315
  Stores an IANA timezone identifier string keyed by `name` in the parent Form values.
3284
3316
  Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
@@ -3326,6 +3358,7 @@ No additional properties.
3326
3358
 
3327
3359
  A Form-registered tree selection field for use inside a Form component.
3328
3360
 
3361
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
3329
3362
  Must be placed inside a Form element — it registers with Form and does not work standalone.
3330
3363
  Set parent to the value of the parent node to build tree hierarchy; null for root nodes.
3331
3364
  Use isMulti to allow selecting multiple nodes.
@@ -3376,6 +3409,7 @@ No additional properties.
3376
3409
 
3377
3410
  A Form-registered tree-select dropdown field for use inside a Form component.
3378
3411
 
3412
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
3379
3413
  Must be placed inside a Form element — it registers with Form and does not work standalone.
3380
3414
  Set parent to the value of the parent node to build tree hierarchy; null for root nodes.
3381
3415
  Use isMulti to allow selecting multiple values displayed as chips.
@@ -3430,6 +3464,7 @@ No additional properties.
3430
3464
 
3431
3465
  A Form-registered work email field for use inside a Form component.
3432
3466
 
3467
+ Labels: use the string `label` prop for plain text or provide element IDs through `slots.label` for rich content; the named slot takes precedence over the string fallback.
3433
3468
  Must be placed inside a Form element — it registers with Form and does not work standalone.
3434
3469
  Use domainList to restrict suggestions to specific email domains.
3435
3470
  The field validates email format automatically.
@@ -6047,6 +6082,7 @@ Use prefix/suffix for units or icons - pass Icon.TYPES names like "SEARCH_OUTLIN
6047
6082
  Use inputMode to hint the virtual keyboard type on mobile devices
6048
6083
  Use stringPadding to automatically pad values (e.g., "1" → "001" with {position: "start", maxLength: 3, character: "0"})
6049
6084
  ARIA attributes support accessibility - use aria-label or aria-labelledby for screen reader labels
6085
+ Use the string `label` prop for plain text. For rich labels, provide element IDs through `slots.label`; the named slot takes precedence over the string fallback.
6050
6086
  Standalone — does not register with Form; use FormText inside a Form instead.
6051
6087
 
6052
6088
  Catalog key: `TextInput`
@@ -6273,7 +6309,7 @@ No additional properties.
6273
6309
 
6274
6310
  A supportive floating text box that offers contextual details about an associated element when hovered over or focused. Use for supplementary, non-critical information such as labelling icon buttons or describing ambiguous UI elements.
6275
6311
 
6276
- Wrap any element with Tip to show a tooltip on hover. The child element is the hover target. Use isVisible to control tooltip programmatically via state binding. Skipped: padding/className/truncateClassName (CSS overrides), shallSkipOverflowY (internal overflow), isMobileDevice/shouldPop (function props), middleware/overwriteMiddleware (Popper internals), primaryAction/secondaryAction (deprecated TipAction objects with onClick callbacks), persist (deprecated, always true).
6312
+ Wrap any element with Tip to show a tooltip on hover. The child element is the hover target. Use the content prop for plain text or slots.content for rich nested content; the slot takes precedence. Use isVisible to control tooltip programmatically via state binding. Skipped: padding/className/truncateClassName (CSS overrides), shallSkipOverflowY (internal overflow), isMobileDevice/shouldPop (function props), middleware/overwriteMiddleware (Popper internals), primaryAction/secondaryAction (deprecated TipAction objects with onClick callbacks), persist (deprecated, always true).
6277
6313
 
6278
6314
  Catalog key: `Tip`
6279
6315
  Builder: `Tip`
@@ -6286,7 +6322,7 @@ Events: _none_
6286
6322
  | Name | Required | Type | Description |
6287
6323
  |---|---:|---|---|
6288
6324
  | `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip theme. Default: LIGHT |
6289
- | `content` | yes | string | Tooltip text content |
6325
+ | `content` | no | string | Plain text tooltip content. Use slots.content for rich content |
6290
6326
  | `hideOnDocumentScroll` | no | boolean | Hide tooltip when the document is scrolled. Default: false |
6291
6327
  | `isDelayed` | no | boolean | Add delay before showing/hiding the tooltip. Default: false |
6292
6328
  | `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
@@ -3,4 +3,98 @@
3
3
 
4
4
  Import computed function helpers from `@rippling/pebble-sdui-web/catalogs/custom-apps`. Read [definitions.md](./definitions.md) for enum values linked from param tables.
5
5
 
6
- _This catalog does not define computed functions._
6
+ ## arrayCompact
7
+
8
+ Remove null and undefined entries while preserving false, zero, and empty strings.
9
+
10
+ Catalog key: `array_compact`
11
+ Helper: `arrayCompact`
12
+ Params type: `ArrayCompactParams`
13
+
14
+ ### Params
15
+
16
+ | Name | Required | Type | Description |
17
+ |---|---:|---|---|
18
+ | `items` | yes | unknown[] | |
19
+
20
+ No additional properties.
21
+
22
+ ## arrayFilter
23
+
24
+ Return array items matching a composable predicate.
25
+
26
+ where supports eq and contains comparisons plus nested and/or groups.
27
+ field is a path on each item. value may be a literal or another json-render expression.
28
+ Comparisons are case-sensitive by default; set caseSensitive to false for case-insensitive strings.
29
+
30
+ Catalog key: `array_filter`
31
+ Helper: `arrayFilter`
32
+ Params type: `ArrayFilterParams`
33
+
34
+ ### Params
35
+
36
+ | Name | Required | Type | Description |
37
+ |---|---:|---|---|
38
+ | `items` | yes | unknown[] | |
39
+ | `where` | yes | unknown | |
40
+
41
+ No additional properties.
42
+
43
+ ## arrayIncludes
44
+
45
+ Return whether a scalar array contains a scalar value.
46
+
47
+ Catalog key: `array_includes`
48
+ Helper: `arrayIncludes`
49
+ Params type: `ArrayIncludesParams`
50
+
51
+ ### Params
52
+
53
+ | Name | Required | Type | Description |
54
+ |---|---:|---|---|
55
+ | `items` | yes | string \| number \| boolean \| null[] | |
56
+ | `value` | yes | string \| number \| boolean \| null | |
57
+
58
+ No additional properties.
59
+
60
+ ## arrayMap
61
+
62
+ Project a field or a named set of fields from every array item.
63
+
64
+ select may be a field path such as "entityId", returning one value per item.
65
+ select may also map output keys to input field paths, for example { id: "entityId" }.
66
+ Non-object items and missing fields produce undefined; compose with array_compact to remove them.
67
+
68
+ Catalog key: `array_map`
69
+ Helper: `arrayMap`
70
+ Params type: `ArrayMapParams`
71
+
72
+ ### Params
73
+
74
+ | Name | Required | Type | Description |
75
+ |---|---:|---|---|
76
+ | `items` | yes | unknown[] | |
77
+ | `select` | yes | string \| [SelectValue](./types.md#selectvalue) | |
78
+
79
+ No additional properties.
80
+
81
+ ## arraySome
82
+
83
+ Return whether at least one array item matches a composable predicate.
84
+
85
+ where supports eq and contains comparisons plus nested and/or groups.
86
+ field is a path on each item. value may be a literal or another json-render expression.
87
+ Comparisons are case-sensitive by default; set caseSensitive to false for case-insensitive strings.
88
+
89
+ Catalog key: `array_some`
90
+ Helper: `arraySome`
91
+ Params type: `ArraySomeParams`
92
+
93
+ ### Params
94
+
95
+ | Name | Required | Type | Description |
96
+ |---|---:|---|---|
97
+ | `items` | yes | unknown[] | |
98
+ | `where` | yes | unknown | |
99
+
100
+ No additional properties.
@@ -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
 
@@ -434,6 +438,27 @@ Referenced by:
434
438
  |---|---|---|
435
439
  | component | `AppNavBar` | `theme` |
436
440
 
441
+ ## ArrayPredicateValueOperator
442
+
443
+ TypeScript type:
444
+
445
+ ```ts
446
+ "eq" | "contains"
447
+ ```
448
+
449
+ Allowed values:
450
+
451
+ | Value |
452
+ |---|
453
+ | `eq` |
454
+ | `contains` |
455
+
456
+ Referenced by:
457
+
458
+ | Kind | Entity | Field |
459
+ |---|---|---|
460
+ | type | `ArrayPredicateValue` | `operator` |
461
+
437
462
  ## AtomsSeparatorTheme
438
463
 
439
464
  TypeScript type:
@@ -544,17 +569,107 @@ Referenced by:
544
569
  | component | `SupportButton` | `imageBackground` |
545
570
  | component | `VStack` | `backgroundColor` |
546
571
  | type | `AvatarIcon` | `backgroundColor` |
572
+ | type | `AvatarListIcon` | `backgroundColor` |
573
+ | type | `AvatarListPlaceholderIcon` | `backgroundColor` |
574
+ | type | `AvatarPlaceholderIcon` | `backgroundColor` |
547
575
  | type | `FormSurveyList` | `selectionColor` |
548
576
  | type | `ObjectUIAvatarProp` | `imageBackground` |
549
577
  | type | `ObjectUIHeaderAvatarProp` | `imageBackground` |
578
+ | type | `StepperPlaceholderIcon` | `backgroundColor` |
550
579
  | type | `SurveyList` | `selectionColor` |
551
580
 
581
+ ## AvatarLogo
582
+
583
+ TypeScript type:
584
+
585
+ ```ts
586
+ "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"
587
+ ```
588
+
589
+ Allowed values:
590
+
591
+ | Value |
592
+ |---|
593
+ | `amplitude` |
594
+ | `asana` |
595
+ | `ashby` |
596
+ | `atlassian` |
597
+ | `bitrise` |
598
+ | `box` |
599
+ | `buildkite` |
600
+ | `cloudflare` |
601
+ | `contentful` |
602
+ | `context7` |
603
+ | `datadog` |
604
+ | `deel` |
605
+ | `dropbox` |
606
+ | `excalidraw` |
607
+ | `expo` |
608
+ | `figma` |
609
+ | `gem` |
610
+ | `github` |
611
+ | `gitlab` |
612
+ | `gmail` |
613
+ | `gong` |
614
+ | `googlecalendar` |
615
+ | `googlechat` |
616
+ | `googledocs` |
617
+ | `googledrive` |
618
+ | `googleforms` |
619
+ | `googlesheets` |
620
+ | `googleslides` |
621
+ | `googleworkspace` |
622
+ | `greenhouse` |
623
+ | `incidentio` |
624
+ | `ironclad` |
625
+ | `iterable` |
626
+ | `jumpcloud` |
627
+ | `launchdarkly` |
628
+ | `linear` |
629
+ | `logrocket` |
630
+ | `lucid` |
631
+ | `mermaidchart` |
632
+ | `metaview` |
633
+ | `microsoftcalendar` |
634
+ | `microsoftexcel` |
635
+ | `microsoftonedrive` |
636
+ | `microsoftoutlook` |
637
+ | `microsoftteams` |
638
+ | `microsoftword` |
639
+ | `mutiny` |
640
+ | `netsuite` |
641
+ | `notion` |
642
+ | `peopleapi` |
643
+ | `ramp` |
644
+ | `ranger` |
645
+ | `rippling` |
646
+ | `salesforce` |
647
+ | `sendoso` |
648
+ | `sentry` |
649
+ | `slack` |
650
+ | `snowflake` |
651
+ | `stripe` |
652
+ | `symmetrypayroll` |
653
+ | `vantage` |
654
+ | `zoom` |
655
+
656
+ Referenced by:
657
+
658
+ | Kind | Entity | Field |
659
+ |---|---|---|
660
+ | component | `Avatar` | `logo` |
661
+ | component | `AvatarList` | `logo` |
662
+ | type | `AvatarListAvatar` | `logo` |
663
+ | type | `ObjectUIAvatarProp` | `logo` |
664
+ | type | `ObjectUIHeaderAvatarProp` | `logo` |
665
+ | type | `StepperAvatar` | `logo` |
666
+
552
667
  ## AvatarType
553
668
 
554
669
  TypeScript type:
555
670
 
556
671
  ```ts
557
- "USER" | "ICON" | "TEXT" | "NUMBER" | "RIPPLING"
672
+ "USER" | "ICON" | "TEXT" | "NUMBER" | "RIPPLING" | "LOGO"
558
673
  ```
559
674
 
560
675
  Allowed values:
@@ -566,6 +681,7 @@ Allowed values:
566
681
  | `TEXT` |
567
682
  | `NUMBER` |
568
683
  | `RIPPLING` |
684
+ | `LOGO` |
569
685
 
570
686
  Referenced by:
571
687
 
@@ -573,6 +689,7 @@ Referenced by:
573
689
  |---|---|---|
574
690
  | component | `Avatar` | `type` |
575
691
  | component | `AvatarList` | `type` |
692
+ | type | `AvatarListAvatar` | `type` |
576
693
  | type | `ObjectUIAvatarProp` | `type` |
577
694
  | type | `ObjectUIHeaderAvatarProp` | `type` |
578
695
 
@@ -4104,7 +4221,7 @@ Referenced by:
4104
4221
  TypeScript type:
4105
4222
 
4106
4223
  ```ts
4107
- "ICON" | "RIPPLING" | "TEXT" | "USER" | "NUMBER"
4224
+ "ICON" | "RIPPLING" | "TEXT" | "USER" | "NUMBER" | "LOGO"
4108
4225
  ```
4109
4226
 
4110
4227
  Allowed values:
@@ -4116,6 +4233,7 @@ Allowed values:
4116
4233
  | `TEXT` |
4117
4234
  | `USER` |
4118
4235
  | `NUMBER` |
4236
+ | `LOGO` |
4119
4237
 
4120
4238
  Referenced by:
4121
4239
 
@@ -2,7 +2,7 @@
2
2
  # custom-apps Catalog
3
3
 
4
4
  Catalog: `custom-apps`
5
- Version: `1.9.2`
5
+ Version: `1.10.1`
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.