@rippling/pebble-sdui-web 0.15.2 → 0.18.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.
@@ -201,9 +201,9 @@ No additional properties.
201
201
 
202
202
  ## AppNavBar
203
203
 
204
- Application navigation bar with routing support. Displays a horizontal tab bar or vertical sidebar with links, icons, badges, and optional nested sub-navigation. Use for top-level page navigation.
204
+ Application navigation bar with optional routing. Displays a header without tabs when links are omitted or empty. With links, it displays a horizontal tab bar or vertical sidebar with icons, badges, and optional nested sub-navigation.
205
205
 
206
- AppNavBar renders a navigation bar using Tabs.LINK internally. Links can be flat or nested (via the links field on each nav item). In vertical mode, items with isSection: true render as non-interactive section headers. Use $bindState on activeUrl to two-way bind the active tab path to state — it updates automatically when the user clicks a nav item. Use baseURL to prefix all paths. Use theme to control padding and borders.
206
+ AppNavBar renders a navigation bar using Tabs.LINK internally. Links can be flat or nested (via the links field on each nav item). In vertical mode, items with isSection: true render as non-interactive section headers. Use $bindState on activeUrl to two-way bind the active tab path to state — it updates automatically when the user clicks a nav item. Use baseURL to prefix all paths. Use theme to control padding and borders.Omit links or pass an empty array to render the title, actions, and children without a tab list
207
207
 
208
208
  Catalog key: `AppNavBar`
209
209
  Builder: `AppNavBar`
@@ -221,7 +221,7 @@ Events: `navigate`, `action`
221
221
  | `baseURL` | no | string | Base URL prefix prepended to all link paths |
222
222
  | `isLogoRound` | no | boolean | If true, logo has rounded corners |
223
223
  | `isVertical` | no | boolean | If true, renders a vertical sidebar navigation instead of horizontal tabs |
224
- | `links` | yes | Record<string, unknown>[] | Array of navigation items defining the nav structure |
224
+ | `links` | no | Record<string, unknown>[] | Navigation items. Omit or pass an empty array to render the header without tabs |
225
225
  | `logoUrl` | no | string | URL for a logo image in the header area |
226
226
  | `shouldPersistQueryParams` | no | boolean | If true, existing query parameters are preserved across navigation |
227
227
  | `size` | no | number | Fixed width in pixels for horizontal layout. 0 or omitted for fluid width |
@@ -1654,7 +1654,7 @@ No additional properties.
1654
1654
 
1655
1655
  A file upload input that allows users to drag and drop files into a drop zone or click to browse. Supports single or multiple file uploads with configurable file type restrictions, size limits, and optional image cropping.
1656
1656
 
1657
- onChange stores an array of file objects in state, each with {name, type, content, progress, hasError} where content is a base64 data URL string. Use supportTypes with file extensions like [".pdf", ".png"] — NOT MIME types. Custom extensions are allowed. module is deprecated but supported for upload bucket hints; prefer metadata.module when possible. When multiple is false, only one file is stored.
1657
+ onChange stores an array of file objects in state, each with {name, type, content, progress, hasError} where content is a base64 data URL string. Use supportTypes with file extensions like [".pdf", ".png"] — NOT MIME types. Custom extensions are allowed. module is deprecated but supported for upload bucket hints; prefer metadata.module when possible. maxFiles limits the total selected files across the current value plus new picks; extra files are ignored and the user is told to remove a file before adding another. When multiple is false, only one file is stored.
1658
1658
 
1659
1659
  Catalog key: `FileDrop`
1660
1660
  Builder: `FileDrop`
@@ -1681,6 +1681,7 @@ Events: `change`, `blur`
1681
1681
  | `isReadOnly` | no | boolean | Makes the file input read-only |
1682
1682
  | `isRequired` | no | boolean | Marks the field as required |
1683
1683
  | `label` | no | string | Label text above the file drop area |
1684
+ | `maxFiles` | no | number | Max number of files allowed in total |
1684
1685
  | `maxFileSize` | no | number | Max file size in MB per attachment |
1685
1686
  | `maxTotalFileSize` | no | number | Max total size in MB for all attachments |
1686
1687
  | `metadata` | no | unknown | JSON-serializable metadata sent with upload requests |
@@ -1825,6 +1826,7 @@ Events: `change`
1825
1826
  |---|---:|---|---|
1826
1827
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
1827
1828
  | `defaultValue` | no | boolean | Initial checked state when uncontrolled |
1829
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
1828
1830
  | `isDisabled` | no | boolean | Disables the input |
1829
1831
  | `isIndeterminate` | no | boolean | Sets checkbox to indeterminate (neither checked nor unchecked) state |
1830
1832
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -1864,6 +1866,7 @@ Events: `change`
1864
1866
  |---|---:|---|---|
1865
1867
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
1866
1868
  | `defaultValue` | no | unknown[] | Initial array of selected values when uncontrolled |
1869
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
1867
1870
  | `id` | no | string | HTML id attribute for the checkbox group |
1868
1871
  | `isDisabled` | no | boolean | Disables the input |
1869
1872
  | `isHorizontal` | no | boolean | Arrange options in a row |
@@ -1929,6 +1932,7 @@ Events: `change`, `blur`
1929
1932
  | `currencyTypeProps` | no | [FormCurrencyCurrencyTypeProp](./types.md#formcurrencycurrencytypeprop) | Nested Select props for the currency selector |
1930
1933
  | `decimalPlaces` | no | number | Number of decimal places allowed. Default: 2 |
1931
1934
  | `defaultValue` | no | string \| number \| [FormCurrencyDefaultValue](./types.md#formcurrencydefaultvalue) \| null | Initial currency value set in Form on mount |
1935
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
1932
1936
  | `isDisabled` | no | boolean | Disables the input |
1933
1937
  | `isReadOnly` | no | boolean | Makes the input read-only |
1934
1938
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -1967,6 +1971,7 @@ Events: `change`
1967
1971
  | `canClear` | no | boolean | Show clear button |
1968
1972
  | `defaultValue` | no | string | Initial date value (yyyy-MM-dd) or null set in Form on mount |
1969
1973
  | `format` | no | [CalendarFormat](./definitions.md#calendarformat) | Date display format. Default: MM/dd/yyyy |
1974
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
1970
1975
  | `id` | no | string | HTML id attribute for the input |
1971
1976
  | `isDisabled` | no | boolean | Disables the input |
1972
1977
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2013,6 +2018,7 @@ Events: `change`
2013
2018
  | `divider` | no | string | Separator between date units (e.g. "/" or "-") |
2014
2019
  | `endDateLabel` | no | string | Label for the end date field |
2015
2020
  | `format` | no | [CalendarFormat](./definitions.md#calendarformat) | Date display format. Default: MM/dd/yyyy |
2021
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2016
2022
  | `hideStepper` | no | boolean | If true, arrow navigation key to increment/decrement date will be hidden. Default: false |
2017
2023
  | `id` | no | string | HTML id attribute for the date range input |
2018
2024
  | `isCalendarDefaultOpen` | no | boolean | If true, calendar will be open by default on mount |
@@ -2062,6 +2068,7 @@ Events: `change`
2062
2068
  |---|---:|---|---|
2063
2069
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2064
2070
  | `defaultValue` | no | [DaySelectorDefaultValue](./definitions.md#dayselectordefaultvalue) \| [DaySelectorDefaultValue](./definitions.md#dayselectordefaultvalue)[] | Initial day(s) when uncontrolled |
2071
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2065
2072
  | `isDisabled` | no | boolean | Disables the input |
2066
2073
  | `isMulti` | no | boolean | Allow multiple day selection. Default: false |
2067
2074
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2097,6 +2104,7 @@ Events: `change`, `blur`
2097
2104
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2098
2105
  | `autoComplete` | no | string | Browser autocomplete hint |
2099
2106
  | `defaultValue` | no | string | Initial default value for uncontrolled usage |
2107
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2100
2108
  | `isDisabled` | no | boolean | Disables the input |
2101
2109
  | `isReadOnly` | no | boolean | Makes the input read-only |
2102
2110
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -2173,6 +2181,7 @@ Events: `change`, `blur`
2173
2181
  | `cropperConfig` | no | [FormFileCropperConfig](./types.md#formfilecropperconfig) | Cropper configuration |
2174
2182
  | `defaultValue` | no | [FormFileDefaultValue](./types.md#formfiledefaultvalue)[] | Default files to show when no value is provided |
2175
2183
  | `enableCropper` | no | boolean | Enable image cropping for selected images |
2184
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2176
2185
  | `icon` | no | string | Icon name from Icon.TYPES to show above placeholder |
2177
2186
  | `isDisabled` | no | boolean | Disables the input |
2178
2187
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2204,6 +2213,7 @@ Use `validationErrors` to override default error messages per rule.
2204
2213
  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" }`.
2205
2214
  onChange emits "change"; onBlur emits "blur".
2206
2215
  supportTypes expects file extensions with dot prefix, e.g. [".pdf", ".png", ".jpg"]. Do NOT use MIME types.
2216
+ maxFiles counts files already in the field and newly selected files together; extra files are ignored until a file is removed.
2207
2217
  Use metadata to pass JSON-serializable upload context through to the underlying FileDrop upload flow.
2208
2218
 
2209
2219
  Catalog key: `FormFileDrop`
@@ -2221,11 +2231,13 @@ Events: `change`, `blur`
2221
2231
  | `cropperConfig` | no | [FormFileDropCropperConfig](./types.md#formfiledropcropperconfig) | Cropper configuration |
2222
2232
  | `defaultValue` | no | [FormFileDropDefaultValue](./types.md#formfiledropdefaultvalue)[] | Default files to show when no value is provided |
2223
2233
  | `enableCropper` | no | boolean | Enable image cropping for selected images |
2234
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2224
2235
  | `icon` | no | string | Icon name from Icon.TYPES to show above placeholder |
2225
2236
  | `isDisabled` | no | boolean | Disables the input |
2226
2237
  | `isReadOnly` | no | boolean | Makes the input read-only |
2227
2238
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
2228
2239
  | `label` | no | string | Label text above the file drop area |
2240
+ | `maxFiles` | no | number | Max number of files allowed in total |
2229
2241
  | `maxFileSize` | no | number | Max file size in MB per attachment |
2230
2242
  | `maxTotalFileSize` | no | number | Max total size in MB for all attachments |
2231
2243
  | `metadata` | no | unknown | JSON-serializable metadata sent with upload requests |
@@ -2360,6 +2372,7 @@ Events: `change`
2360
2372
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2361
2373
  | `defaultValue` | no | unknown | Initial value for the main input on mount |
2362
2374
  | `hasSeparateFormControls` | no | boolean | When true, prefix and suffix input configurations are rendered as separate Form fields inside the group |
2375
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2363
2376
  | `input` | yes | [FormInputGroupInput](./types.md#forminputgroupinput) | Main input configuration with type and inputProps |
2364
2377
  | `isDisabled` | no | boolean | Disables all inputs in the group |
2365
2378
  | `isReadOnly` | no | boolean | Makes all inputs in the group read-only |
@@ -2406,6 +2419,7 @@ Events: `change`, `blur`
2406
2419
  | `defaultValue` | no | string | Initial masked value set in Form on mount |
2407
2420
  | `fixedCharsPrefix` | no | string | Fixes characters at the beginning of the value |
2408
2421
  | `fixedCharsSuffix` | no | string | Fixes characters at the end of the value |
2422
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2409
2423
  | `id` | no | string | Explicit HTML element id |
2410
2424
  | `isDisabled` | no | boolean | Disables the input |
2411
2425
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2452,6 +2466,7 @@ Events: `change`, `blur`, `changeRaw`, `changeCalculationState`
2452
2466
  | `autoFocus` | no | boolean | Auto-focus on mount |
2453
2467
  | `decimalPlaces` | no | number | Number of decimal places. Default: 2 |
2454
2468
  | `defaultValue` | no | string \| number | Initial default value for uncontrolled usage |
2469
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2455
2470
  | `isDisabled` | no | boolean | Disables the input |
2456
2471
  | `isIntegerOnly` | no | boolean | Restrict to integer values only |
2457
2472
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2507,6 +2522,7 @@ Events: `change`, `blur`
2507
2522
  | `autoCorrect` | no | [EmailAutoCorrect](./definitions.md#emailautocorrect) | Auto-correct: off or on |
2508
2523
  | `autoFocus` | no | boolean | Auto-focus on mount |
2509
2524
  | `defaultValue` | no | string | Initial default value for uncontrolled usage |
2525
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2510
2526
  | `inputMode` | no | [EmailInputMode](./definitions.md#emailinputmode) | Virtual keyboard type hint |
2511
2527
  | `isDisabled` | no | boolean | Disables the input |
2512
2528
  | `isOriginalInputReadOnly` | no | boolean | Sets readonly mode directly on input HTML element |
@@ -2556,6 +2572,7 @@ Events: `change`, `blur`
2556
2572
  | `allowNegative` | no | boolean | Whether negative values are allowed. Default: false |
2557
2573
  | `decimalPlaces` | no | number | Number of decimal places allowed. Default: 2 |
2558
2574
  | `defaultValue` | no | number | Default percentage value when uncontrolled |
2575
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2559
2576
  | `isDisabled` | no | boolean | Disables the input |
2560
2577
  | `isReadOnly` | no | boolean | Makes the input read-only |
2561
2578
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -2602,6 +2619,7 @@ Events: `change`, `blur`, `countryCodeChange`
2602
2619
  | `countryCodeValue` | no | string | [Deprecated] Use countryCode.value instead. Bound selected country code for the legacy dropdown shape |
2603
2620
  | `defaultRegion` | no | string | Default country region code for formatting, e.g. "US", "IN", "CA". Default: US |
2604
2621
  | `defaultValue` | no | string | Initial default value for uncontrolled usage |
2622
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2605
2623
  | `inputMode` | no | [EmailInputMode](./definitions.md#emailinputmode) | Virtual keyboard type hint |
2606
2624
  | `isCountryCodeDisabled` | no | boolean | [Deprecated] Use countryCode.isDisabled instead for the legacy dropdown shape |
2607
2625
  | `isCountryCodeReadOnly` | no | boolean | [Deprecated] Use countryCode.isReadOnly instead for the legacy dropdown shape |
@@ -2645,6 +2663,7 @@ Events: `change`
2645
2663
  |---|---:|---|---|
2646
2664
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2647
2665
  | `defaultValue` | no | unknown | Initial value when uncontrolled |
2666
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2648
2667
  | `isDisabled` | no | boolean | Disables the input |
2649
2668
  | `isHorizontal` | no | boolean | Arrange options in a row |
2650
2669
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2660,6 +2679,39 @@ Events: `change`
2660
2679
 
2661
2680
  No additional properties.
2662
2681
 
2682
+ ## FormRecordLookup
2683
+
2684
+ Searches and selects a record from a searchable model, such as custom objects, Employee, Department, Team, Work Location, Computer, Job Requisition, or Applicant, as a registered form field.
2685
+
2686
+ Provide name to register the lookup with its parent form. The change event is notification-only; observe selected record ids through bound value state. Searchability and viewer record access are enforced by the backend at query time.
2687
+
2688
+ Catalog key: `FormRecordLookup`
2689
+ Builder: `FormRecordLookup`
2690
+ Props type: `FormRecordLookupProps`
2691
+ Accepts children: no
2692
+ Events: `change`
2693
+
2694
+ ### Props
2695
+
2696
+ | Name | Required | Type | Description |
2697
+ |---|---:|---|---|
2698
+ | `name` | yes | string | Non-empty field name used to register the lookup with the parent form. |
2699
+ | `canClear` | no | boolean | Controls whether the value can be cleared. |
2700
+ | `defaultValue` | no | string \| string[] | Initial uncontrolled record id, or record id array when isMulti is true. |
2701
+ | `isDisabled` | no | boolean | Disables searching and selection changes. |
2702
+ | `isMenuDefaultOpen` | no | boolean | Opens the menu when the field mounts. |
2703
+ | `isMulti` | no | boolean | Allows selecting multiple records. |
2704
+ | `isReadOnly` | no | boolean | Displays the value without allowing changes. |
2705
+ | `isRequired` | no | boolean | Marks the field required in its parent form. |
2706
+ | `label` | no | string | Label displayed above the lookup. |
2707
+ | `objectApiName` | yes | string | RQL API name of the model whose records can be searched. The backend rejects models that are not lookup-supported or that the viewer cannot access. |
2708
+ | `placeholder` | no | string | Search input placeholder. |
2709
+ | `shouldShowSearchIcon` | no | boolean | Controls whether the search icon is shown. |
2710
+ | `tip` | no | string | Supplementary text displayed with the label. |
2711
+ | `value` | no | string \| string[] | Controlled record id, or record id array when isMulti is true. |
2712
+
2713
+ No additional properties.
2714
+
2663
2715
  ## FormSegmentedControl
2664
2716
 
2665
2717
  A Form-registered segmented control for use inside a Form component.
@@ -2684,6 +2736,7 @@ Events: `change`
2684
2736
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2685
2737
  | `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style variant. Default: PRIMARY |
2686
2738
  | `defaultValue` | no | string \| string[] | Initial value when uncontrolled |
2739
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2687
2740
  | `isDisabled` | no | boolean | Disables the input |
2688
2741
  | `isFluid` | no | boolean | Stretches control to fill container width |
2689
2742
  | `isMulti` | no | boolean | Allows selecting multiple options |
@@ -2729,6 +2782,7 @@ Events: `change`, `blur`
2729
2782
  | `dropdownHeight` | no | number | Sets dropdown menu height in pixels |
2730
2783
  | `emptyListPlaceholder` | no | string \| [FormSelectEmptyListPlaceholder](./types.md#formselectemptylistplaceholder) | Placeholder when dropdown list is empty. Can be string or object with state-specific placeholders |
2731
2784
  | `fuseOptions` | no | [FormSelectFuseOption](./types.md#formselectfuseoption) | Fuse.js search options for customizing fuzzy search behavior |
2785
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2732
2786
  | `isDisabled` | no | boolean | Disables the input |
2733
2787
  | `isMenuDefaultOpen` | no | boolean | If true, dropdown menu will be open by default |
2734
2788
  | `isMulti` | no | boolean | Allow multiple selections |
@@ -2777,6 +2831,7 @@ Events: `change`
2777
2831
  | `aria-label` | no | string | Accessible label for screen readers |
2778
2832
  | `aria-labelledby` | no | string | ID of element that labels this input for screen readers |
2779
2833
  | `defaultValue` | no | string \| number \| string \| number[] | Initial selection when uncontrolled |
2834
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2780
2835
  | `id` | no | string | Unique DOM id for the input element |
2781
2836
  | `isDisabled` | no | boolean | Disables the input |
2782
2837
  | `isMulti` | no | boolean | Allow multiple selection. Default: false |
@@ -2818,6 +2873,7 @@ Events: `change`
2818
2873
  | `aria-label` | no | string | Accessible label for screen readers |
2819
2874
  | `aria-labelledby` | no | string | ID of element that labels this input |
2820
2875
  | `defaultValue` | no | string | Initial default signature value |
2876
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2821
2877
  | `id` | no | string | Unique DOM element ID |
2822
2878
  | `isDisabled` | no | boolean | Disables the input |
2823
2879
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2857,6 +2913,7 @@ Events: `change`, `blur`
2857
2913
  | `defaultValue` | no | string | Initial masked value set in Form on mount |
2858
2914
  | `fixedCharsPrefix` | no | string | Fixes characters at the beginning of the value |
2859
2915
  | `fixedCharsSuffix` | no | string | Fixes characters at the end of the value |
2916
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2860
2917
  | `isDisabled` | no | boolean | Disables the input |
2861
2918
  | `isReadOnly` | no | boolean | Makes the input read-only |
2862
2919
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -2894,6 +2951,7 @@ Events: `change`
2894
2951
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2895
2952
  | `appearance` | no | [FormSliderAppearance](./definitions.md#formsliderappearance) | Sets slider appearance. Default: PRIMARY |
2896
2953
  | `defaultValue` | no | number | Initial value when uncontrolled. Default: 0 |
2954
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2897
2955
  | `hideTooltip` | no | boolean | Hide the value tooltip. Default: false |
2898
2956
  | `isDisabled` | no | boolean | Disables the input |
2899
2957
  | `isDotsVisible` | no | boolean | If true renders slider with dots. Default: true |
@@ -2934,6 +2992,7 @@ Events: `change`, `blur`
2934
2992
  | `defaultValue` | no | string | Initial masked value set in Form on mount |
2935
2993
  | `fixedCharsPrefix` | no | string | Fixes characters at the beginning of the value |
2936
2994
  | `fixedCharsSuffix` | no | string | Fixes characters at the end of the value |
2995
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2937
2996
  | `isDisabled` | no | boolean | Disables the input |
2938
2997
  | `isReadOnly` | no | boolean | Makes the input read-only |
2939
2998
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -2969,6 +3028,7 @@ Events: `change`
2969
3028
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2970
3029
  | `caption` | no | string | Caption text displayed below the survey |
2971
3030
  | `defaultValue` | no | string \| number \| string \| number[] | Initial selected value(s) set on mount |
3031
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2972
3032
  | `isDisabled` | no | boolean | Disables the input |
2973
3033
  | `isMulti` | no | boolean | Allow multiple selections. Default: false |
2974
3034
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -3010,6 +3070,7 @@ Events: `change`
3010
3070
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
3011
3071
  | `compact` | no | boolean | Use compact size variant |
3012
3072
  | `defaultValue` | no | boolean | Initial toggle state when uncontrolled |
3073
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
3013
3074
  | `isDisabled` | no | boolean | Disables the input |
3014
3075
  | `isReadOnly` | no | boolean | Makes the input read-only |
3015
3076
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -3033,6 +3094,7 @@ Individual values are not bound to state; they flow through the parent Form's `v
3033
3094
  Use `validations` for Form rule strings: "isEmail", "minLength:5", "maxLength:100", "isNumeric", etc.
3034
3095
  Browser/input behavior props such as `minLength`, `autoCapitalize`, `autoCorrect`, `spellCheck`, `inputMode`, `stringPadding`, and `shouldPersistCursorPosition` preserve the underlying Text input API.
3035
3096
  Use `validationErrors` to override default error messages per rule.
3097
+ `helperMessage` displays supporting text below the input. Validation errors temporarily replace it, and it returns when validation clears.
3036
3098
  `isRequired` blocks form submission when empty and shows an error.
3037
3099
  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" }`.
3038
3100
  onChange emits "change"; onBlur emits "blur".
@@ -3054,6 +3116,7 @@ Events: `change`, `blur`
3054
3116
  | `autoFocus` | no | boolean | Auto-focus on mount |
3055
3117
  | `canClear` | no | boolean | Show clear button |
3056
3118
  | `defaultValue` | no | string | Initial default value for uncontrolled usage |
3119
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
3057
3120
  | `inputMode` | no | [EmailInputMode](./definitions.md#emailinputmode) | Virtual keyboard type hint |
3058
3121
  | `isDisabled` | no | boolean | Disables the input |
3059
3122
  | `isOriginalInputReadOnly` | no | boolean | Sets readonly mode directly on input HTML element |
@@ -3104,6 +3167,7 @@ Events: `change`, `blur`, `focus`
3104
3167
  | `defaultValue` | no | string | Initial default value for uncontrolled usage |
3105
3168
  | `hasCharsLimit` | no | boolean | Show character count indicator. Requires maxLength to be set |
3106
3169
  | `height` | no | number | Fixed height in pixels |
3170
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
3107
3171
  | `isDisabled` | no | boolean | Disables the input |
3108
3172
  | `isReadOnly` | no | boolean | Makes the input read-only |
3109
3173
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -3144,6 +3208,7 @@ Events: `change`, `blur`
3144
3208
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
3145
3209
  | `defaultValue` | no | string | Initial value set in Form on mount |
3146
3210
  | `fuseOptions` | no | [FormTextAutoSuggestFuseOption](./types.md#formtextautosuggestfuseoption) | Fuse.js search options for customizing suggestion filtering |
3211
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
3147
3212
  | `isDisabled` | no | boolean | Disables the input |
3148
3213
  | `isPositionFixed` | no | boolean | Use fixed positioning for dropdown menu. Useful in scrollable containers |
3149
3214
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -3186,6 +3251,7 @@ Events: `change`, `blur`
3186
3251
  | `alwaysShowTimezone` | no | boolean | If true, timezone abbreviation will always be shown. Default: false |
3187
3252
  | `defaultSelectionStartTime` | no | string | Time to start the selection scroll from when shouldAllowTimeSelection is true (e.g. "08:00 AM") |
3188
3253
  | `defaultValue` | no | string | Initial value — ISO 8601 or "HH:MM AM/PM" time string |
3254
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
3189
3255
  | `isDateTimeInline` | no | boolean | Make input inline, removes border, padding and width fits input/placeholder content |
3190
3256
  | `isDisabled` | no | boolean | Disables the input |
3191
3257
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -3235,6 +3301,7 @@ Events: `change`, `blur`, `focus`
3235
3301
  | `displayShortFormat` | no | boolean | Display timezone abbreviation |
3236
3302
  | `dropdownHeight` | no | number | Height of the dropdown menu in pixels |
3237
3303
  | `emptyListPlaceholder` | no | string | Placeholder text shown when no timezone matches the search |
3304
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
3238
3305
  | `isDisabled` | no | boolean | Disables the input |
3239
3306
  | `isMenuDefaultOpen` | no | boolean | If true, the dropdown menu will be open by default on mount |
3240
3307
  | `isPositionFixed` | no | boolean | Use fixed positioning for dropdown (useful in scrollable containers) |
@@ -3285,6 +3352,7 @@ Events: `change`
3285
3352
  | `hasIndependentActions` | no | boolean | In multiSelect, action on an item does not affect selection of parent or child items |
3286
3353
  | `hasIndependentChildActions` | no | boolean | Actions on child in multi select do not affect selection of ancestors |
3287
3354
  | `hasStaticParentNodes` | no | boolean | Makes parent nodes non-actionable (only manage hierarchy) |
3355
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
3288
3356
  | `isDisabled` | no | boolean | Disables the input |
3289
3357
  | `isMulti` | no | boolean | Allow multiple selection. Default: false |
3290
3358
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -3335,6 +3403,7 @@ Events: `change`
3335
3403
  | `hasIndependentActions` | no | boolean | In multiSelect, action on an item does not affect selection of parent or child items |
3336
3404
  | `hasIndependentChildActions` | no | boolean | Actions on child in multi select do not affect selection of ancestors |
3337
3405
  | `hasStaticParentNodes` | no | boolean | Makes parent nodes non-actionable (only manage hierarchy) |
3406
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
3338
3407
  | `isDisabled` | no | boolean | Disables the input |
3339
3408
  | `isMenuDefaultOpen` | no | boolean | If true, dropdown menu will be open by default |
3340
3409
  | `isMulti` | no | boolean | Allow multiple selection. Default: false |
@@ -3381,6 +3450,7 @@ Events: `change`, `blur`
3381
3450
  | `autoComplete` | no | string | Browser autocomplete hint |
3382
3451
  | `defaultValue` | no | string | Initial default value for uncontrolled usage |
3383
3452
  | `domainList` | no | string \| string[] \| [FormWorkEmailDomainList](./types.md#formworkemaildomainlist)[] \| [FormWorkEmailDomainList](./types.md#formworkemaildomainlist)[] | Email domain list for selection. Can be: single string, array of strings ["acme.com"], array of {label, value, tag?} objects (FlatList), or array of {label, list} objects (NestedList) for grouped domains |
3453
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
3384
3454
  | `isDisabled` | no | boolean | Disables the input |
3385
3455
  | `isReadOnly` | no | boolean | Makes the input read-only |
3386
3456
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -3684,6 +3754,26 @@ Events: _none_
3684
3754
 
3685
3755
  No additional properties.
3686
3756
 
3757
+ ## Interval
3758
+
3759
+ Emits a tick event repeatedly after the configured delay. Renders no UI and stops when unmounted.
3760
+
3761
+ Bind an action to on.tick. The first tick fires after delay milliseconds, matching window.setInterval.
3762
+
3763
+ Catalog key: `Interval`
3764
+ Builder: `Interval`
3765
+ Props type: `IntervalProps`
3766
+ Accepts children: no
3767
+ Events: `tick`
3768
+
3769
+ ### Props
3770
+
3771
+ | Name | Required | Type | Description |
3772
+ |---|---:|---|---|
3773
+ | `delay` | yes | number | Time in milliseconds between tick events. |
3774
+
3775
+ No additional properties.
3776
+
3687
3777
  ## ItemNavigator
3688
3778
 
3689
3779
  A compact control for stepping through items one at a time, with either an "X of Y items" label or clickable position dots. Use for sequential item-by-item navigation such as cycling through detail views, carousel items, search results, or review queues — not for page-based navigation (use Pagination instead).
@@ -4852,6 +4942,37 @@ Events: `change`, `beforeChange`, `afterChange`, `blur`
4852
4942
 
4853
4943
  No additional properties.
4854
4944
 
4945
+ ## RecordLookup
4946
+
4947
+ Searches and selects a record from a searchable model, such as custom objects, Employee, Department, Team, Work Location, Computer, Job Requisition, or Applicant.
4948
+
4949
+ Use a controlled value with $bindState or defaultValue for an uncontrolled initial value. The change event is notification-only; observe selected record ids through bound value state. Searchability and viewer record access are enforced by the backend at query time.
4950
+
4951
+ Catalog key: `RecordLookup`
4952
+ Builder: `RecordLookup`
4953
+ Props type: `RecordLookupProps`
4954
+ Accepts children: no
4955
+ Events: `change`
4956
+
4957
+ ### Props
4958
+
4959
+ | Name | Required | Type | Description |
4960
+ |---|---:|---|---|
4961
+ | `canClear` | no | boolean | Controls whether the value can be cleared. |
4962
+ | `defaultValue` | no | string \| string[] | Initial uncontrolled record id, or record id array when isMulti is true. |
4963
+ | `isDisabled` | no | boolean | Disables searching and selection changes. |
4964
+ | `isMenuDefaultOpen` | no | boolean | Opens the menu when the field mounts. |
4965
+ | `isMulti` | no | boolean | Allows selecting multiple records. |
4966
+ | `isReadOnly` | no | boolean | Displays the value without allowing changes. |
4967
+ | `label` | no | string | Label displayed above the lookup. |
4968
+ | `objectApiName` | yes | string | RQL API name of the model whose records can be searched. The backend rejects models that are not lookup-supported or that the viewer cannot access. |
4969
+ | `placeholder` | no | string | Search input placeholder. |
4970
+ | `shouldShowSearchIcon` | no | boolean | Controls whether the search icon is shown. |
4971
+ | `tip` | no | string | Supplementary text displayed with the label. |
4972
+ | `value` | no | string \| string[] | Controlled record id, or record id array when isMulti is true. |
4973
+
4974
+ No additional properties.
4975
+
4855
4976
  ## ReportLoader
4856
4977
 
4857
4978
  A skeleton placeholder shown while tabular report content is loading. Use when the content area will contain a data report with header and detail rows, and you want to reduce perceived loading time and prevent layout shift.
@@ -5561,6 +5682,43 @@ Events: `click`
5561
5682
 
5562
5683
  No additional properties.
5563
5684
 
5685
+ ## SuperGrid
5686
+
5687
+ Server-configured data grid. The backend owns column definitions, sorting, search, quick filters, and empty-state messaging — only `gridId` is required. Use `contextFilters` to scope rows and filter options from external page state (e.g. a record selector).
5688
+
5689
+ gridId: required. Must match a registered SuperGrid id on the backend. The frontend fetches column config and data automatically.
5690
+ configContext: optional query context sent when fetching config. Use it for backend-owned dynamic config variants such as title, caption, or empty-state text.
5691
+ contextFilters: optional array of { field, operation, value } filters merged into every data and filter-dropdown query. Use to pre-scope the grid from page-level state without requiring the user to apply filters manually.
5692
+ width: optional CSS width string or pixel number passed to the underlying Grid.
5693
+ height: optional CSS height string. Omit to let the grid auto-size. Pass an explicit value (e.g. "500px") when embedding inside a fixed-height container.
5694
+ caption: optional sub-title rendered beneath the grid title. Falls back to the backend-configured caption when omitted.
5695
+ rowActions: optional static row action configs. Dynamic per-row factories are not supported in SDUI; use booleans for isDisabled/isHidden.
5696
+ Events do not receive payload arguments. Bind rowClickedData, rowActionClickedId, or rowActionClickedData with $bindState, then read those paths with $state inside rowClick or rowActionClick actions.
5697
+ SuperGrid writes the bound clicked state before emitting rowClick or rowActionClick.
5698
+
5699
+ Catalog key: `SuperGrid`
5700
+ Builder: `SuperGrid`
5701
+ Props type: `SuperGridProps`
5702
+ Accepts children: no
5703
+ Events: `rowClick`, `rowActionClick`
5704
+
5705
+ ### Props
5706
+
5707
+ | Name | Required | Type | Description |
5708
+ |---|---:|---|---|
5709
+ | `caption` | no | string | Optional caption rendered below the grid title. |
5710
+ | `configContext` | no | [ConfigContext](./types.md#configcontext) | Query context sent to dynamic config modifiers for backend-owned variants. |
5711
+ | `contextFilters` | no | [ContextFilter](./types.md#contextfilter)[] | Filters derived from external state that scope data and filter-dropdown queries. Applied in addition to any user-applied filters. |
5712
+ | `gridId` | yes | string | Unique identifier for the grid configuration fetched from the backend. |
5713
+ | `height` | no | string | Any CSS height string (e.g. "400px", "60vh"). When omitted the grid auto-sizes to its rows. |
5714
+ | `rowActionClickedData` | no | unknown | Bind to state with $bindState to receive clicked row action row data before rowActionClick emits. |
5715
+ | `rowActionClickedId` | no | string | Bind to state with $bindState to receive the clicked row action id before rowActionClick emits. |
5716
+ | `rowActions` | no | [RowAction](./types.md#rowaction)[] | Static row action buttons. On click, SuperGrid writes rowActionClickedId and rowActionClickedData before emitting rowActionClick. |
5717
+ | `rowClickedData` | no | unknown | Bind to state with $bindState to receive clicked row data before rowClick emits. |
5718
+ | `width` | no | string \| number | Grid width as a CSS width string or pixel number. |
5719
+
5720
+ No additional properties.
5721
+
5564
5722
  ## SupportButton
5565
5723
 
5566
5724
  A prominent card-like action button with title, caption, icon or image, and optional badge for dashboard entry points.
@@ -1599,6 +1599,38 @@ Referenced by:
1599
1599
  | type | `LabelValue` | `size` |
1600
1600
  | type | `ObjectUIStatsProp` | `size` |
1601
1601
 
1602
+ ## ContextFilterOperation
1603
+
1604
+ TypeScript type:
1605
+
1606
+ ```ts
1607
+ "eq" | "ne" | "gt" | "ge" | "lt" | "le" | "in" | "ni" | "contains" | "starts_with" | "ends_with" | "is_empty" | "is_not_empty"
1608
+ ```
1609
+
1610
+ Allowed values:
1611
+
1612
+ | Value |
1613
+ |---|
1614
+ | `eq` |
1615
+ | `ne` |
1616
+ | `gt` |
1617
+ | `ge` |
1618
+ | `lt` |
1619
+ | `le` |
1620
+ | `in` |
1621
+ | `ni` |
1622
+ | `contains` |
1623
+ | `starts_with` |
1624
+ | `ends_with` |
1625
+ | `is_empty` |
1626
+ | `is_not_empty` |
1627
+
1628
+ Referenced by:
1629
+
1630
+ | Kind | Entity | Field |
1631
+ |---|---|---|
1632
+ | type | `ContextFilter` | `operation` |
1633
+
1602
1634
  ## CountryIconAlignment
1603
1635
 
1604
1636
  TypeScript type:
@@ -3545,6 +3577,69 @@ Referenced by:
3545
3577
  |---|---|---|
3546
3578
  | component | `Responsive` | `mode` |
3547
3579
 
3580
+ ## RowActionAppearance
3581
+
3582
+ TypeScript type:
3583
+
3584
+ ```ts
3585
+ "OUTLINE" | "GHOST"
3586
+ ```
3587
+
3588
+ Allowed values:
3589
+
3590
+ | Value |
3591
+ |---|
3592
+ | `OUTLINE` |
3593
+ | `GHOST` |
3594
+
3595
+ Referenced by:
3596
+
3597
+ | Kind | Entity | Field |
3598
+ |---|---|---|
3599
+ | type | `RowAction` | `appearance` |
3600
+
3601
+ ## RowActionPlacement
3602
+
3603
+ TypeScript type:
3604
+
3605
+ ```ts
3606
+ "inline" | "menu"
3607
+ ```
3608
+
3609
+ Allowed values:
3610
+
3611
+ | Value |
3612
+ |---|
3613
+ | `inline` |
3614
+ | `menu` |
3615
+
3616
+ Referenced by:
3617
+
3618
+ | Kind | Entity | Field |
3619
+ |---|---|---|
3620
+ | type | `RowAction` | `placement` |
3621
+
3622
+ ## RowActionType
3623
+
3624
+ TypeScript type:
3625
+
3626
+ ```ts
3627
+ "Button" | "IconButton"
3628
+ ```
3629
+
3630
+ Allowed values:
3631
+
3632
+ | Value |
3633
+ |---|
3634
+ | `Button` |
3635
+ | `IconButton` |
3636
+
3637
+ Referenced by:
3638
+
3639
+ | Kind | Entity | Field |
3640
+ |---|---|---|
3641
+ | type | `RowAction` | `type` |
3642
+
3548
3643
  ## SegmentSegmentColor
3549
3644
 
3550
3645
  TypeScript type:
@@ -2,7 +2,7 @@
2
2
  # custom-apps Catalog
3
3
 
4
4
  Catalog: `custom-apps`
5
- Version: `1.5.4`
5
+ Version: `1.9.2`
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.
@@ -693,6 +693,28 @@ No additional properties.
693
693
 
694
694
  No additional properties.
695
695
 
696
+ ## ConfigContext
697
+
698
+ Query context sent to dynamic config modifiers for backend-owned variants.
699
+
700
+ ### Fields
701
+
702
+ _No fields._
703
+
704
+ Additional properties: string.
705
+
706
+ ## ContextFilter
707
+
708
+ ### Fields
709
+
710
+ | Name | Required | Type | Description |
711
+ |---|---:|---|---|
712
+ | `field` | yes | string | |
713
+ | `operation` | yes | [ContextFilterOperation](./definitions.md#contextfilteroperation) | |
714
+ | `value` | yes | unknown | |
715
+
716
+ No additional properties.
717
+
696
718
  ## CountryIcon
697
719
 
698
720
  ### Fields
@@ -3632,6 +3654,25 @@ _No fields._
3632
3654
 
3633
3655
  Additional properties: string | number | boolean | null.
3634
3656
 
3657
+ ## RowAction
3658
+
3659
+ ### Fields
3660
+
3661
+ | Name | Required | Type | Description |
3662
+ |---|---:|---|---|
3663
+ | `appearance` | no | [RowActionAppearance](./definitions.md#rowactionappearance) | Button appearance. Defaults to GHOST. |
3664
+ | `icon` | no | string | Icon name from Icon.TYPES, such as EDIT_OUTLINE. |
3665
+ | `iconColor` | no | string | Icon color token or CSS color string. |
3666
+ | `id` | yes | string | Unique identifier for the row action. |
3667
+ | `isDisabled` | no | boolean | Disable the action for every row. |
3668
+ | `isHidden` | no | boolean | Hide the action for every row. |
3669
+ | `label` | yes | string | Visible label for the row action. |
3670
+ | `placement` | no | [RowActionPlacement](./definitions.md#rowactionplacement) | Where the action is rendered. Defaults to the Grid row-actions behavior. |
3671
+ | `tip` | no | string | Tooltip text for the action. |
3672
+ | `type` | no | [RowActionType](./definitions.md#rowactiontype) | Button style to render. Defaults to Button. |
3673
+
3674
+ No additional properties.
3675
+
3635
3676
  ## Segment
3636
3677
 
3637
3678
  ### Fields
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rippling/pebble-sdui-web",
3
- "version": "0.15.2",
3
+ "version": "0.18.2",
4
4
  "description": "Type-safe TypeScript web SDK for authoring json-render specs",
5
5
  "repository": {
6
6
  "type": "git",