@rippling/pebble-sdui-web 0.18.1 → 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.
@@ -1826,6 +1826,7 @@ Events: `change`
1826
1826
  |---|---:|---|---|
1827
1827
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
1828
1828
  | `defaultValue` | no | boolean | Initial checked state when uncontrolled |
1829
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
1829
1830
  | `isDisabled` | no | boolean | Disables the input |
1830
1831
  | `isIndeterminate` | no | boolean | Sets checkbox to indeterminate (neither checked nor unchecked) state |
1831
1832
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -1865,6 +1866,7 @@ Events: `change`
1865
1866
  |---|---:|---|---|
1866
1867
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
1867
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. |
1868
1870
  | `id` | no | string | HTML id attribute for the checkbox group |
1869
1871
  | `isDisabled` | no | boolean | Disables the input |
1870
1872
  | `isHorizontal` | no | boolean | Arrange options in a row |
@@ -1930,6 +1932,7 @@ Events: `change`, `blur`
1930
1932
  | `currencyTypeProps` | no | [FormCurrencyCurrencyTypeProp](./types.md#formcurrencycurrencytypeprop) | Nested Select props for the currency selector |
1931
1933
  | `decimalPlaces` | no | number | Number of decimal places allowed. Default: 2 |
1932
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. |
1933
1936
  | `isDisabled` | no | boolean | Disables the input |
1934
1937
  | `isReadOnly` | no | boolean | Makes the input read-only |
1935
1938
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -1968,6 +1971,7 @@ Events: `change`
1968
1971
  | `canClear` | no | boolean | Show clear button |
1969
1972
  | `defaultValue` | no | string | Initial date value (yyyy-MM-dd) or null set in Form on mount |
1970
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. |
1971
1975
  | `id` | no | string | HTML id attribute for the input |
1972
1976
  | `isDisabled` | no | boolean | Disables the input |
1973
1977
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2014,6 +2018,7 @@ Events: `change`
2014
2018
  | `divider` | no | string | Separator between date units (e.g. "/" or "-") |
2015
2019
  | `endDateLabel` | no | string | Label for the end date field |
2016
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. |
2017
2022
  | `hideStepper` | no | boolean | If true, arrow navigation key to increment/decrement date will be hidden. Default: false |
2018
2023
  | `id` | no | string | HTML id attribute for the date range input |
2019
2024
  | `isCalendarDefaultOpen` | no | boolean | If true, calendar will be open by default on mount |
@@ -2063,6 +2068,7 @@ Events: `change`
2063
2068
  |---|---:|---|---|
2064
2069
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2065
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. |
2066
2072
  | `isDisabled` | no | boolean | Disables the input |
2067
2073
  | `isMulti` | no | boolean | Allow multiple day selection. Default: false |
2068
2074
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2098,6 +2104,7 @@ Events: `change`, `blur`
2098
2104
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2099
2105
  | `autoComplete` | no | string | Browser autocomplete hint |
2100
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. |
2101
2108
  | `isDisabled` | no | boolean | Disables the input |
2102
2109
  | `isReadOnly` | no | boolean | Makes the input read-only |
2103
2110
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -2174,6 +2181,7 @@ Events: `change`, `blur`
2174
2181
  | `cropperConfig` | no | [FormFileCropperConfig](./types.md#formfilecropperconfig) | Cropper configuration |
2175
2182
  | `defaultValue` | no | [FormFileDefaultValue](./types.md#formfiledefaultvalue)[] | Default files to show when no value is provided |
2176
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. |
2177
2185
  | `icon` | no | string | Icon name from Icon.TYPES to show above placeholder |
2178
2186
  | `isDisabled` | no | boolean | Disables the input |
2179
2187
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2223,6 +2231,7 @@ Events: `change`, `blur`
2223
2231
  | `cropperConfig` | no | [FormFileDropCropperConfig](./types.md#formfiledropcropperconfig) | Cropper configuration |
2224
2232
  | `defaultValue` | no | [FormFileDropDefaultValue](./types.md#formfiledropdefaultvalue)[] | Default files to show when no value is provided |
2225
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. |
2226
2235
  | `icon` | no | string | Icon name from Icon.TYPES to show above placeholder |
2227
2236
  | `isDisabled` | no | boolean | Disables the input |
2228
2237
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2363,6 +2372,7 @@ Events: `change`
2363
2372
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2364
2373
  | `defaultValue` | no | unknown | Initial value for the main input on mount |
2365
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. |
2366
2376
  | `input` | yes | [FormInputGroupInput](./types.md#forminputgroupinput) | Main input configuration with type and inputProps |
2367
2377
  | `isDisabled` | no | boolean | Disables all inputs in the group |
2368
2378
  | `isReadOnly` | no | boolean | Makes all inputs in the group read-only |
@@ -2409,6 +2419,7 @@ Events: `change`, `blur`
2409
2419
  | `defaultValue` | no | string | Initial masked value set in Form on mount |
2410
2420
  | `fixedCharsPrefix` | no | string | Fixes characters at the beginning of the value |
2411
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. |
2412
2423
  | `id` | no | string | Explicit HTML element id |
2413
2424
  | `isDisabled` | no | boolean | Disables the input |
2414
2425
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2455,6 +2466,7 @@ Events: `change`, `blur`, `changeRaw`, `changeCalculationState`
2455
2466
  | `autoFocus` | no | boolean | Auto-focus on mount |
2456
2467
  | `decimalPlaces` | no | number | Number of decimal places. Default: 2 |
2457
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. |
2458
2470
  | `isDisabled` | no | boolean | Disables the input |
2459
2471
  | `isIntegerOnly` | no | boolean | Restrict to integer values only |
2460
2472
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2510,6 +2522,7 @@ Events: `change`, `blur`
2510
2522
  | `autoCorrect` | no | [EmailAutoCorrect](./definitions.md#emailautocorrect) | Auto-correct: off or on |
2511
2523
  | `autoFocus` | no | boolean | Auto-focus on mount |
2512
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. |
2513
2526
  | `inputMode` | no | [EmailInputMode](./definitions.md#emailinputmode) | Virtual keyboard type hint |
2514
2527
  | `isDisabled` | no | boolean | Disables the input |
2515
2528
  | `isOriginalInputReadOnly` | no | boolean | Sets readonly mode directly on input HTML element |
@@ -2559,6 +2572,7 @@ Events: `change`, `blur`
2559
2572
  | `allowNegative` | no | boolean | Whether negative values are allowed. Default: false |
2560
2573
  | `decimalPlaces` | no | number | Number of decimal places allowed. Default: 2 |
2561
2574
  | `defaultValue` | no | number | Default percentage value when uncontrolled |
2575
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2562
2576
  | `isDisabled` | no | boolean | Disables the input |
2563
2577
  | `isReadOnly` | no | boolean | Makes the input read-only |
2564
2578
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -2605,6 +2619,7 @@ Events: `change`, `blur`, `countryCodeChange`
2605
2619
  | `countryCodeValue` | no | string | [Deprecated] Use countryCode.value instead. Bound selected country code for the legacy dropdown shape |
2606
2620
  | `defaultRegion` | no | string | Default country region code for formatting, e.g. "US", "IN", "CA". Default: US |
2607
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. |
2608
2623
  | `inputMode` | no | [EmailInputMode](./definitions.md#emailinputmode) | Virtual keyboard type hint |
2609
2624
  | `isCountryCodeDisabled` | no | boolean | [Deprecated] Use countryCode.isDisabled instead for the legacy dropdown shape |
2610
2625
  | `isCountryCodeReadOnly` | no | boolean | [Deprecated] Use countryCode.isReadOnly instead for the legacy dropdown shape |
@@ -2648,6 +2663,7 @@ Events: `change`
2648
2663
  |---|---:|---|---|
2649
2664
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2650
2665
  | `defaultValue` | no | unknown | Initial value when uncontrolled |
2666
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2651
2667
  | `isDisabled` | no | boolean | Disables the input |
2652
2668
  | `isHorizontal` | no | boolean | Arrange options in a row |
2653
2669
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2663,6 +2679,39 @@ Events: `change`
2663
2679
 
2664
2680
  No additional properties.
2665
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
+
2666
2715
  ## FormSegmentedControl
2667
2716
 
2668
2717
  A Form-registered segmented control for use inside a Form component.
@@ -2687,6 +2736,7 @@ Events: `change`
2687
2736
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2688
2737
  | `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style variant. Default: PRIMARY |
2689
2738
  | `defaultValue` | no | string \| string[] | Initial value when uncontrolled |
2739
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2690
2740
  | `isDisabled` | no | boolean | Disables the input |
2691
2741
  | `isFluid` | no | boolean | Stretches control to fill container width |
2692
2742
  | `isMulti` | no | boolean | Allows selecting multiple options |
@@ -2732,6 +2782,7 @@ Events: `change`, `blur`
2732
2782
  | `dropdownHeight` | no | number | Sets dropdown menu height in pixels |
2733
2783
  | `emptyListPlaceholder` | no | string \| [FormSelectEmptyListPlaceholder](./types.md#formselectemptylistplaceholder) | Placeholder when dropdown list is empty. Can be string or object with state-specific placeholders |
2734
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. |
2735
2786
  | `isDisabled` | no | boolean | Disables the input |
2736
2787
  | `isMenuDefaultOpen` | no | boolean | If true, dropdown menu will be open by default |
2737
2788
  | `isMulti` | no | boolean | Allow multiple selections |
@@ -2780,6 +2831,7 @@ Events: `change`
2780
2831
  | `aria-label` | no | string | Accessible label for screen readers |
2781
2832
  | `aria-labelledby` | no | string | ID of element that labels this input for screen readers |
2782
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. |
2783
2835
  | `id` | no | string | Unique DOM id for the input element |
2784
2836
  | `isDisabled` | no | boolean | Disables the input |
2785
2837
  | `isMulti` | no | boolean | Allow multiple selection. Default: false |
@@ -2821,6 +2873,7 @@ Events: `change`
2821
2873
  | `aria-label` | no | string | Accessible label for screen readers |
2822
2874
  | `aria-labelledby` | no | string | ID of element that labels this input |
2823
2875
  | `defaultValue` | no | string | Initial default signature value |
2876
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
2824
2877
  | `id` | no | string | Unique DOM element ID |
2825
2878
  | `isDisabled` | no | boolean | Disables the input |
2826
2879
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -2860,6 +2913,7 @@ Events: `change`, `blur`
2860
2913
  | `defaultValue` | no | string | Initial masked value set in Form on mount |
2861
2914
  | `fixedCharsPrefix` | no | string | Fixes characters at the beginning of the value |
2862
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. |
2863
2917
  | `isDisabled` | no | boolean | Disables the input |
2864
2918
  | `isReadOnly` | no | boolean | Makes the input read-only |
2865
2919
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -2897,6 +2951,7 @@ Events: `change`
2897
2951
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2898
2952
  | `appearance` | no | [FormSliderAppearance](./definitions.md#formsliderappearance) | Sets slider appearance. Default: PRIMARY |
2899
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. |
2900
2955
  | `hideTooltip` | no | boolean | Hide the value tooltip. Default: false |
2901
2956
  | `isDisabled` | no | boolean | Disables the input |
2902
2957
  | `isDotsVisible` | no | boolean | If true renders slider with dots. Default: true |
@@ -2937,6 +2992,7 @@ Events: `change`, `blur`
2937
2992
  | `defaultValue` | no | string | Initial masked value set in Form on mount |
2938
2993
  | `fixedCharsPrefix` | no | string | Fixes characters at the beginning of the value |
2939
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. |
2940
2996
  | `isDisabled` | no | boolean | Disables the input |
2941
2997
  | `isReadOnly` | no | boolean | Makes the input read-only |
2942
2998
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -2972,6 +3028,7 @@ Events: `change`
2972
3028
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
2973
3029
  | `caption` | no | string | Caption text displayed below the survey |
2974
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. |
2975
3032
  | `isDisabled` | no | boolean | Disables the input |
2976
3033
  | `isMulti` | no | boolean | Allow multiple selections. Default: false |
2977
3034
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -3013,6 +3070,7 @@ Events: `change`
3013
3070
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
3014
3071
  | `compact` | no | boolean | Use compact size variant |
3015
3072
  | `defaultValue` | no | boolean | Initial toggle state when uncontrolled |
3073
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
3016
3074
  | `isDisabled` | no | boolean | Disables the input |
3017
3075
  | `isReadOnly` | no | boolean | Makes the input read-only |
3018
3076
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -3036,6 +3094,7 @@ Individual values are not bound to state; they flow through the parent Form's `v
3036
3094
  Use `validations` for Form rule strings: "isEmail", "minLength:5", "maxLength:100", "isNumeric", etc.
3037
3095
  Browser/input behavior props such as `minLength`, `autoCapitalize`, `autoCorrect`, `spellCheck`, `inputMode`, `stringPadding`, and `shouldPersistCursorPosition` preserve the underlying Text input API.
3038
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.
3039
3098
  `isRequired` blocks form submission when empty and shows an error.
3040
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" }`.
3041
3100
  onChange emits "change"; onBlur emits "blur".
@@ -3057,6 +3116,7 @@ Events: `change`, `blur`
3057
3116
  | `autoFocus` | no | boolean | Auto-focus on mount |
3058
3117
  | `canClear` | no | boolean | Show clear button |
3059
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. |
3060
3120
  | `inputMode` | no | [EmailInputMode](./definitions.md#emailinputmode) | Virtual keyboard type hint |
3061
3121
  | `isDisabled` | no | boolean | Disables the input |
3062
3122
  | `isOriginalInputReadOnly` | no | boolean | Sets readonly mode directly on input HTML element |
@@ -3107,6 +3167,7 @@ Events: `change`, `blur`, `focus`
3107
3167
  | `defaultValue` | no | string | Initial default value for uncontrolled usage |
3108
3168
  | `hasCharsLimit` | no | boolean | Show character count indicator. Requires maxLength to be set |
3109
3169
  | `height` | no | number | Fixed height in pixels |
3170
+ | `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
3110
3171
  | `isDisabled` | no | boolean | Disables the input |
3111
3172
  | `isReadOnly` | no | boolean | Makes the input read-only |
3112
3173
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -3147,6 +3208,7 @@ Events: `change`, `blur`
3147
3208
  | `name` | yes | string | Field name — drives the Form value key inside the parent Form |
3148
3209
  | `defaultValue` | no | string | Initial value set in Form on mount |
3149
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. |
3150
3212
  | `isDisabled` | no | boolean | Disables the input |
3151
3213
  | `isPositionFixed` | no | boolean | Use fixed positioning for dropdown menu. Useful in scrollable containers |
3152
3214
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -3189,6 +3251,7 @@ Events: `change`, `blur`
3189
3251
  | `alwaysShowTimezone` | no | boolean | If true, timezone abbreviation will always be shown. Default: false |
3190
3252
  | `defaultSelectionStartTime` | no | string | Time to start the selection scroll from when shouldAllowTimeSelection is true (e.g. "08:00 AM") |
3191
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. |
3192
3255
  | `isDateTimeInline` | no | boolean | Make input inline, removes border, padding and width fits input/placeholder content |
3193
3256
  | `isDisabled` | no | boolean | Disables the input |
3194
3257
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -3238,6 +3301,7 @@ Events: `change`, `blur`, `focus`
3238
3301
  | `displayShortFormat` | no | boolean | Display timezone abbreviation |
3239
3302
  | `dropdownHeight` | no | number | Height of the dropdown menu in pixels |
3240
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. |
3241
3305
  | `isDisabled` | no | boolean | Disables the input |
3242
3306
  | `isMenuDefaultOpen` | no | boolean | If true, the dropdown menu will be open by default on mount |
3243
3307
  | `isPositionFixed` | no | boolean | Use fixed positioning for dropdown (useful in scrollable containers) |
@@ -3288,6 +3352,7 @@ Events: `change`
3288
3352
  | `hasIndependentActions` | no | boolean | In multiSelect, action on an item does not affect selection of parent or child items |
3289
3353
  | `hasIndependentChildActions` | no | boolean | Actions on child in multi select do not affect selection of ancestors |
3290
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. |
3291
3356
  | `isDisabled` | no | boolean | Disables the input |
3292
3357
  | `isMulti` | no | boolean | Allow multiple selection. Default: false |
3293
3358
  | `isReadOnly` | no | boolean | Makes the input read-only |
@@ -3338,6 +3403,7 @@ Events: `change`
3338
3403
  | `hasIndependentActions` | no | boolean | In multiSelect, action on an item does not affect selection of parent or child items |
3339
3404
  | `hasIndependentChildActions` | no | boolean | Actions on child in multi select do not affect selection of ancestors |
3340
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. |
3341
3407
  | `isDisabled` | no | boolean | Disables the input |
3342
3408
  | `isMenuDefaultOpen` | no | boolean | If true, dropdown menu will be open by default |
3343
3409
  | `isMulti` | no | boolean | Allow multiple selection. Default: false |
@@ -3384,6 +3450,7 @@ Events: `change`, `blur`
3384
3450
  | `autoComplete` | no | string | Browser autocomplete hint |
3385
3451
  | `defaultValue` | no | string | Initial default value for uncontrolled usage |
3386
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. |
3387
3454
  | `isDisabled` | no | boolean | Disables the input |
3388
3455
  | `isReadOnly` | no | boolean | Makes the input read-only |
3389
3456
  | `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
@@ -4875,6 +4942,37 @@ Events: `change`, `beforeChange`, `afterChange`, `blur`
4875
4942
 
4876
4943
  No additional properties.
4877
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
+
4878
4976
  ## ReportLoader
4879
4977
 
4880
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.
@@ -2,7 +2,7 @@
2
2
  # custom-apps Catalog
3
3
 
4
4
  Catalog: `custom-apps`
5
- Version: `1.9.1`
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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rippling/pebble-sdui-web",
3
- "version": "0.18.1",
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",