@rippling/pebble-sdui-web 0.18.1 → 0.18.4
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.
- package/dist/catalogs/custom-apps/catalog.d.ts +1 -1
- package/dist/catalogs/custom-apps/component-events.d.ts +2 -0
- package/dist/catalogs/custom-apps/component-props.d.ts +107 -5
- package/dist/catalogs/custom-apps/components.d.ts +73 -71
- package/dist/catalogs/custom-apps/index.cjs +2 -2
- package/dist/catalogs/custom-apps/index.cjs.map +1 -1
- package/dist/catalogs/custom-apps/index.d.ts +3 -3
- package/dist/catalogs/custom-apps/index.js +1567 -281
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/core/component-utils.cjs +1 -1
- package/dist/core/component-utils.cjs.map +1 -1
- package/dist/core/component-utils.d.ts +16 -2
- package/dist/core/component-utils.js +4 -4
- package/dist/core/component-utils.js.map +1 -1
- package/dist/core/spec.cjs +1 -1
- package/dist/core/spec.cjs.map +1 -1
- package/dist/core/spec.d.ts +1 -0
- package/dist/core/spec.js +63 -56
- package/dist/core/spec.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +137 -3
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +99 -2
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +72 -0
- package/package.json +1 -1
|
@@ -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
|
|
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
|
|
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:
|
|
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`
|
|
@@ -1826,6 +1829,7 @@ Events: `change`
|
|
|
1826
1829
|
|---|---:|---|---|
|
|
1827
1830
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
1828
1831
|
| `defaultValue` | no | boolean | Initial checked state when uncontrolled |
|
|
1832
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
1829
1833
|
| `isDisabled` | no | boolean | Disables the input |
|
|
1830
1834
|
| `isIndeterminate` | no | boolean | Sets checkbox to indeterminate (neither checked nor unchecked) state |
|
|
1831
1835
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -1847,6 +1851,7 @@ No additional properties.
|
|
|
1847
1851
|
|
|
1848
1852
|
A Form-registered checkbox group for use inside a Form component.
|
|
1849
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.
|
|
1850
1855
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
1851
1856
|
Stores an array of selected values keyed by `name` in the parent Form's values.
|
|
1852
1857
|
Uses Form.Input.Checkbox.Group internally — the Form-aware variant of CheckboxGroup.
|
|
@@ -1865,6 +1870,7 @@ Events: `change`
|
|
|
1865
1870
|
|---|---:|---|---|
|
|
1866
1871
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
1867
1872
|
| `defaultValue` | no | unknown[] | Initial array of selected values when uncontrolled |
|
|
1873
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
1868
1874
|
| `id` | no | string | HTML id attribute for the checkbox group |
|
|
1869
1875
|
| `isDisabled` | no | boolean | Disables the input |
|
|
1870
1876
|
| `isHorizontal` | no | boolean | Arrange options in a row |
|
|
@@ -1906,6 +1912,7 @@ No additional properties.
|
|
|
1906
1912
|
|
|
1907
1913
|
A Form-registered currency field for use inside a Form component.
|
|
1908
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.
|
|
1909
1916
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
1910
1917
|
Values flow through the parent Form's `values` push-binding on submit/change.
|
|
1911
1918
|
Use `prefix` to set the currency symbol (e.g. "USD", "$").
|
|
@@ -1930,6 +1937,7 @@ Events: `change`, `blur`
|
|
|
1930
1937
|
| `currencyTypeProps` | no | [FormCurrencyCurrencyTypeProp](./types.md#formcurrencycurrencytypeprop) | Nested Select props for the currency selector |
|
|
1931
1938
|
| `decimalPlaces` | no | number | Number of decimal places allowed. Default: 2 |
|
|
1932
1939
|
| `defaultValue` | no | string \| number \| [FormCurrencyDefaultValue](./types.md#formcurrencydefaultvalue) \| null | Initial currency value set in Form on mount |
|
|
1940
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
1933
1941
|
| `isDisabled` | no | boolean | Disables the input |
|
|
1934
1942
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
1935
1943
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
@@ -1948,6 +1956,7 @@ No additional properties.
|
|
|
1948
1956
|
|
|
1949
1957
|
A Form-registered date picker for use inside a Form component.
|
|
1950
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.
|
|
1951
1960
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
1952
1961
|
Stores a date string in the chosen format (default: `yyyy-MM-dd`) keyed by `name` in the parent Form's values.
|
|
1953
1962
|
Always supply defaultValue as a yyyy-MM-dd string regardless of the display format.
|
|
@@ -1968,6 +1977,7 @@ Events: `change`
|
|
|
1968
1977
|
| `canClear` | no | boolean | Show clear button |
|
|
1969
1978
|
| `defaultValue` | no | string | Initial date value (yyyy-MM-dd) or null set in Form on mount |
|
|
1970
1979
|
| `format` | no | [CalendarFormat](./definitions.md#calendarformat) | Date display format. Default: MM/dd/yyyy |
|
|
1980
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
1971
1981
|
| `id` | no | string | HTML id attribute for the input |
|
|
1972
1982
|
| `isDisabled` | no | boolean | Disables the input |
|
|
1973
1983
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -1992,6 +2002,7 @@ No additional properties.
|
|
|
1992
2002
|
|
|
1993
2003
|
A Form-registered date range picker for selecting start and end dates inside a Form component.
|
|
1994
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.
|
|
1995
2006
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
1996
2007
|
Stores an array of two date strings [startDate, endDate] keyed by `name` in the parent Form values.
|
|
1997
2008
|
Bind `value` with `{ $bindState: "/path" }` to initialize the range picker from state and keep state in sync.
|
|
@@ -2014,6 +2025,7 @@ Events: `change`
|
|
|
2014
2025
|
| `divider` | no | string | Separator between date units (e.g. "/" or "-") |
|
|
2015
2026
|
| `endDateLabel` | no | string | Label for the end date field |
|
|
2016
2027
|
| `format` | no | [CalendarFormat](./definitions.md#calendarformat) | Date display format. Default: MM/dd/yyyy |
|
|
2028
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2017
2029
|
| `hideStepper` | no | boolean | If true, arrow navigation key to increment/decrement date will be hidden. Default: false |
|
|
2018
2030
|
| `id` | no | string | HTML id attribute for the date range input |
|
|
2019
2031
|
| `isCalendarDefaultOpen` | no | boolean | If true, calendar will be open by default on mount |
|
|
@@ -2044,6 +2056,7 @@ No additional properties.
|
|
|
2044
2056
|
|
|
2045
2057
|
A Form-registered day-of-week selector for use inside a Form component.
|
|
2046
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.
|
|
2047
2060
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
2048
2061
|
Single-select stores a day name string; isMulti stores an array of day name strings.
|
|
2049
2062
|
Valid day names: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
|
|
@@ -2063,6 +2076,7 @@ Events: `change`
|
|
|
2063
2076
|
|---|---:|---|---|
|
|
2064
2077
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
2065
2078
|
| `defaultValue` | no | [DaySelectorDefaultValue](./definitions.md#dayselectordefaultvalue) \| [DaySelectorDefaultValue](./definitions.md#dayselectordefaultvalue)[] | Initial day(s) when uncontrolled |
|
|
2079
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2066
2080
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2067
2081
|
| `isMulti` | no | boolean | Allow multiple day selection. Default: false |
|
|
2068
2082
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -2079,6 +2093,7 @@ No additional properties.
|
|
|
2079
2093
|
|
|
2080
2094
|
A Form-registered email field with built-in email validation, for use inside a Form component.
|
|
2081
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.
|
|
2082
2097
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
2083
2098
|
Pebble applies isEmail validation by default for Form.Input.Email.
|
|
2084
2099
|
Values flow through the parent Form's `values` push-binding on submit/change.
|
|
@@ -2098,6 +2113,7 @@ Events: `change`, `blur`
|
|
|
2098
2113
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
2099
2114
|
| `autoComplete` | no | string | Browser autocomplete hint |
|
|
2100
2115
|
| `defaultValue` | no | string | Initial default value for uncontrolled usage |
|
|
2116
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2101
2117
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2102
2118
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
2103
2119
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
@@ -2150,6 +2166,7 @@ No additional properties.
|
|
|
2150
2166
|
|
|
2151
2167
|
A Form-registered file upload field for use inside a Form component.
|
|
2152
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.
|
|
2153
2170
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
2154
2171
|
Individual values are not bound to state; they flow through the parent Form's `values` push-binding on submit/change.
|
|
2155
2172
|
Use `validations` for Form rule strings.
|
|
@@ -2174,6 +2191,7 @@ Events: `change`, `blur`
|
|
|
2174
2191
|
| `cropperConfig` | no | [FormFileCropperConfig](./types.md#formfilecropperconfig) | Cropper configuration |
|
|
2175
2192
|
| `defaultValue` | no | [FormFileDefaultValue](./types.md#formfiledefaultvalue)[] | Default files to show when no value is provided |
|
|
2176
2193
|
| `enableCropper` | no | boolean | Enable image cropping for selected images |
|
|
2194
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2177
2195
|
| `icon` | no | string | Icon name from Icon.TYPES to show above placeholder |
|
|
2178
2196
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2179
2197
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -2197,6 +2215,7 @@ No additional properties.
|
|
|
2197
2215
|
|
|
2198
2216
|
A Form-registered file upload field for use inside a Form component.
|
|
2199
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.
|
|
2200
2219
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
2201
2220
|
Individual values are not bound to state; they flow through the parent Form's `values` push-binding on submit/change.
|
|
2202
2221
|
Use `validations` for Form rule strings.
|
|
@@ -2223,6 +2242,7 @@ Events: `change`, `blur`
|
|
|
2223
2242
|
| `cropperConfig` | no | [FormFileDropCropperConfig](./types.md#formfiledropcropperconfig) | Cropper configuration |
|
|
2224
2243
|
| `defaultValue` | no | [FormFileDropDefaultValue](./types.md#formfiledropdefaultvalue)[] | Default files to show when no value is provided |
|
|
2225
2244
|
| `enableCropper` | no | boolean | Enable image cropping for selected images |
|
|
2245
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2226
2246
|
| `icon` | no | string | Icon name from Icon.TYPES to show above placeholder |
|
|
2227
2247
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2228
2248
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -2342,6 +2362,7 @@ No additional properties.
|
|
|
2342
2362
|
|
|
2343
2363
|
A Form-registered grouped input layout that combines one main input with optional prefix and suffix inputs.
|
|
2344
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.
|
|
2345
2366
|
Must be placed inside a Form element.
|
|
2346
2367
|
`input`, `prefix`, and `suffix` use the same input configuration shape as standalone InputGroup; their `inputProps` are direct Pebble input props.
|
|
2347
2368
|
For nested Select inputs, use Pebble `list` instead of the json-render Select catalog `options` prop.
|
|
@@ -2363,6 +2384,7 @@ Events: `change`
|
|
|
2363
2384
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
2364
2385
|
| `defaultValue` | no | unknown | Initial value for the main input on mount |
|
|
2365
2386
|
| `hasSeparateFormControls` | no | boolean | When true, prefix and suffix input configurations are rendered as separate Form fields inside the group |
|
|
2387
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2366
2388
|
| `input` | yes | [FormInputGroupInput](./types.md#forminputgroupinput) | Main input configuration with type and inputProps |
|
|
2367
2389
|
| `isDisabled` | no | boolean | Disables all inputs in the group |
|
|
2368
2390
|
| `isReadOnly` | no | boolean | Makes all inputs in the group read-only |
|
|
@@ -2387,6 +2409,7 @@ No additional properties.
|
|
|
2387
2409
|
|
|
2388
2410
|
A Form-registered masked text input for values with a fixed format.
|
|
2389
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.
|
|
2390
2413
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
2391
2414
|
Mask characters: 9 = digit, a = letter, * = any character.
|
|
2392
2415
|
Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
|
|
@@ -2409,6 +2432,7 @@ Events: `change`, `blur`
|
|
|
2409
2432
|
| `defaultValue` | no | string | Initial masked value set in Form on mount |
|
|
2410
2433
|
| `fixedCharsPrefix` | no | string | Fixes characters at the beginning of the value |
|
|
2411
2434
|
| `fixedCharsSuffix` | no | string | Fixes characters at the end of the value |
|
|
2435
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2412
2436
|
| `id` | no | string | Explicit HTML element id |
|
|
2413
2437
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2414
2438
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -2435,6 +2459,7 @@ No additional properties.
|
|
|
2435
2459
|
|
|
2436
2460
|
A Form-registered numeric field for use inside a Form component.
|
|
2437
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.
|
|
2438
2463
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
2439
2464
|
Values flow through the parent Form's `values` push-binding on submit/change.
|
|
2440
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" }`.
|
|
@@ -2455,6 +2480,7 @@ Events: `change`, `blur`, `changeRaw`, `changeCalculationState`
|
|
|
2455
2480
|
| `autoFocus` | no | boolean | Auto-focus on mount |
|
|
2456
2481
|
| `decimalPlaces` | no | number | Number of decimal places. Default: 2 |
|
|
2457
2482
|
| `defaultValue` | no | string \| number | Initial default value for uncontrolled usage |
|
|
2483
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2458
2484
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2459
2485
|
| `isIntegerOnly` | no | boolean | Restrict to integer values only |
|
|
2460
2486
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -2488,6 +2514,7 @@ No additional properties.
|
|
|
2488
2514
|
|
|
2489
2515
|
A Form-registered password field with show/hide toggle, for use inside a Form component.
|
|
2490
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.
|
|
2491
2518
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
2492
2519
|
Includes a built-in show/hide toggle for the password.
|
|
2493
2520
|
Values flow through the parent Form's `values` push-binding on submit/change.
|
|
@@ -2510,6 +2537,7 @@ Events: `change`, `blur`
|
|
|
2510
2537
|
| `autoCorrect` | no | [EmailAutoCorrect](./definitions.md#emailautocorrect) | Auto-correct: off or on |
|
|
2511
2538
|
| `autoFocus` | no | boolean | Auto-focus on mount |
|
|
2512
2539
|
| `defaultValue` | no | string | Initial default value for uncontrolled usage |
|
|
2540
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2513
2541
|
| `inputMode` | no | [EmailInputMode](./definitions.md#emailinputmode) | Virtual keyboard type hint |
|
|
2514
2542
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2515
2543
|
| `isOriginalInputReadOnly` | no | boolean | Sets readonly mode directly on input HTML element |
|
|
@@ -2538,6 +2566,7 @@ No additional properties.
|
|
|
2538
2566
|
|
|
2539
2567
|
A Form-registered percentage field for use inside a Form component.
|
|
2540
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.
|
|
2541
2570
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
2542
2571
|
Values flow through the parent Form's `values` push-binding on submit/change.
|
|
2543
2572
|
Use `lowerLimit` and `upperLimit` to constrain the allowed range.
|
|
@@ -2559,6 +2588,7 @@ Events: `change`, `blur`
|
|
|
2559
2588
|
| `allowNegative` | no | boolean | Whether negative values are allowed. Default: false |
|
|
2560
2589
|
| `decimalPlaces` | no | number | Number of decimal places allowed. Default: 2 |
|
|
2561
2590
|
| `defaultValue` | no | number | Default percentage value when uncontrolled |
|
|
2591
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2562
2592
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2563
2593
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
2564
2594
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
@@ -2581,6 +2611,7 @@ No additional properties.
|
|
|
2581
2611
|
|
|
2582
2612
|
A Form-registered phone number field with region-based formatting, for use inside a Form component.
|
|
2583
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.
|
|
2584
2615
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
2585
2616
|
Stores the formatted phone number string keyed by `name` in the parent Form's values.
|
|
2586
2617
|
Use defaultRegion to set the formatting region (US, IN, CA, etc.). Defaults to US.
|
|
@@ -2605,6 +2636,7 @@ Events: `change`, `blur`, `countryCodeChange`
|
|
|
2605
2636
|
| `countryCodeValue` | no | string | [Deprecated] Use countryCode.value instead. Bound selected country code for the legacy dropdown shape |
|
|
2606
2637
|
| `defaultRegion` | no | string | Default country region code for formatting, e.g. "US", "IN", "CA". Default: US |
|
|
2607
2638
|
| `defaultValue` | no | string | Initial default value for uncontrolled usage |
|
|
2639
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2608
2640
|
| `inputMode` | no | [EmailInputMode](./definitions.md#emailinputmode) | Virtual keyboard type hint |
|
|
2609
2641
|
| `isCountryCodeDisabled` | no | boolean | [Deprecated] Use countryCode.isDisabled instead for the legacy dropdown shape |
|
|
2610
2642
|
| `isCountryCodeReadOnly` | no | boolean | [Deprecated] Use countryCode.isReadOnly instead for the legacy dropdown shape |
|
|
@@ -2631,6 +2663,7 @@ No additional properties.
|
|
|
2631
2663
|
|
|
2632
2664
|
A Form-registered radio group for use inside a Form component.
|
|
2633
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.
|
|
2634
2667
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
2635
2668
|
Stores the selected option's `value` keyed by `name` in the parent Form's values.
|
|
2636
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" }`.
|
|
@@ -2648,6 +2681,7 @@ Events: `change`
|
|
|
2648
2681
|
|---|---:|---|---|
|
|
2649
2682
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
2650
2683
|
| `defaultValue` | no | unknown | Initial value when uncontrolled |
|
|
2684
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2651
2685
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2652
2686
|
| `isHorizontal` | no | boolean | Arrange options in a row |
|
|
2653
2687
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -2663,10 +2697,44 @@ Events: `change`
|
|
|
2663
2697
|
|
|
2664
2698
|
No additional properties.
|
|
2665
2699
|
|
|
2700
|
+
## FormRecordLookup
|
|
2701
|
+
|
|
2702
|
+
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.
|
|
2703
|
+
|
|
2704
|
+
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.
|
|
2705
|
+
|
|
2706
|
+
Catalog key: `FormRecordLookup`
|
|
2707
|
+
Builder: `FormRecordLookup`
|
|
2708
|
+
Props type: `FormRecordLookupProps`
|
|
2709
|
+
Accepts children: no
|
|
2710
|
+
Events: `change`
|
|
2711
|
+
|
|
2712
|
+
### Props
|
|
2713
|
+
|
|
2714
|
+
| Name | Required | Type | Description |
|
|
2715
|
+
|---|---:|---|---|
|
|
2716
|
+
| `name` | yes | string | Non-empty field name used to register the lookup with the parent form. |
|
|
2717
|
+
| `canClear` | no | boolean | Controls whether the value can be cleared. |
|
|
2718
|
+
| `defaultValue` | no | string \| string[] | Initial uncontrolled record id, or record id array when isMulti is true. |
|
|
2719
|
+
| `isDisabled` | no | boolean | Disables searching and selection changes. |
|
|
2720
|
+
| `isMenuDefaultOpen` | no | boolean | Opens the menu when the field mounts. |
|
|
2721
|
+
| `isMulti` | no | boolean | Allows selecting multiple records. |
|
|
2722
|
+
| `isReadOnly` | no | boolean | Displays the value without allowing changes. |
|
|
2723
|
+
| `isRequired` | no | boolean | Marks the field required in its parent form. |
|
|
2724
|
+
| `label` | no | string | Label displayed above the lookup. |
|
|
2725
|
+
| `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. |
|
|
2726
|
+
| `placeholder` | no | string | Search input placeholder. |
|
|
2727
|
+
| `shouldShowSearchIcon` | no | boolean | Controls whether the search icon is shown. |
|
|
2728
|
+
| `tip` | no | string | Supplementary text displayed with the label. |
|
|
2729
|
+
| `value` | no | string \| string[] | Controlled record id, or record id array when isMulti is true. |
|
|
2730
|
+
|
|
2731
|
+
No additional properties.
|
|
2732
|
+
|
|
2666
2733
|
## FormSegmentedControl
|
|
2667
2734
|
|
|
2668
2735
|
A Form-registered segmented control for use inside a Form component.
|
|
2669
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.
|
|
2670
2738
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
2671
2739
|
Single-select stores a string; isMulti stores an array of strings.
|
|
2672
2740
|
Values flow through the parent Form's `values` push-binding on submit/change.
|
|
@@ -2687,6 +2755,7 @@ Events: `change`
|
|
|
2687
2755
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
2688
2756
|
| `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style variant. Default: PRIMARY |
|
|
2689
2757
|
| `defaultValue` | no | string \| string[] | Initial value when uncontrolled |
|
|
2758
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2690
2759
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2691
2760
|
| `isFluid` | no | boolean | Stretches control to fill container width |
|
|
2692
2761
|
| `isMulti` | no | boolean | Allows selecting multiple options |
|
|
@@ -2707,6 +2776,7 @@ No additional properties.
|
|
|
2707
2776
|
|
|
2708
2777
|
A Form-registered dropdown select for use inside a Form component.
|
|
2709
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.
|
|
2710
2780
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
2711
2781
|
Single-select stores the selected value; isMulti stores an array of selected values.
|
|
2712
2782
|
Values flow through the parent Form's `values` push-binding on submit/change.
|
|
@@ -2732,6 +2802,7 @@ Events: `change`, `blur`
|
|
|
2732
2802
|
| `dropdownHeight` | no | number | Sets dropdown menu height in pixels |
|
|
2733
2803
|
| `emptyListPlaceholder` | no | string \| [FormSelectEmptyListPlaceholder](./types.md#formselectemptylistplaceholder) | Placeholder when dropdown list is empty. Can be string or object with state-specific placeholders |
|
|
2734
2804
|
| `fuseOptions` | no | [FormSelectFuseOption](./types.md#formselectfuseoption) | Fuse.js search options for customizing fuzzy search behavior |
|
|
2805
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2735
2806
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2736
2807
|
| `isMenuDefaultOpen` | no | boolean | If true, dropdown menu will be open by default |
|
|
2737
2808
|
| `isMulti` | no | boolean | Allow multiple selections |
|
|
@@ -2760,6 +2831,7 @@ No additional properties.
|
|
|
2760
2831
|
|
|
2761
2832
|
A Form-registered card-based selection group for single or multi-choice choices inside a Form.
|
|
2762
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.
|
|
2763
2835
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
2764
2836
|
Single-select stores one value; `isMulti` stores an array of selected values.
|
|
2765
2837
|
Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
|
|
@@ -2780,6 +2852,7 @@ Events: `change`
|
|
|
2780
2852
|
| `aria-label` | no | string | Accessible label for screen readers |
|
|
2781
2853
|
| `aria-labelledby` | no | string | ID of element that labels this input for screen readers |
|
|
2782
2854
|
| `defaultValue` | no | string \| number \| string \| number[] | Initial selection when uncontrolled |
|
|
2855
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2783
2856
|
| `id` | no | string | Unique DOM id for the input element |
|
|
2784
2857
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2785
2858
|
| `isMulti` | no | boolean | Allow multiple selection. Default: false |
|
|
@@ -2801,6 +2874,7 @@ No additional properties.
|
|
|
2801
2874
|
|
|
2802
2875
|
A Form-registered signature capture input for drawing or typing a signature inside a Form.
|
|
2803
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.
|
|
2804
2878
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
2805
2879
|
Stores a base64 PNG data URL string keyed by `name` in the parent Form values.
|
|
2806
2880
|
Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
|
|
@@ -2821,6 +2895,7 @@ Events: `change`
|
|
|
2821
2895
|
| `aria-label` | no | string | Accessible label for screen readers |
|
|
2822
2896
|
| `aria-labelledby` | no | string | ID of element that labels this input |
|
|
2823
2897
|
| `defaultValue` | no | string | Initial default signature value |
|
|
2898
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2824
2899
|
| `id` | no | string | Unique DOM element ID |
|
|
2825
2900
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2826
2901
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -2841,6 +2916,7 @@ No additional properties.
|
|
|
2841
2916
|
|
|
2842
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.
|
|
2843
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.
|
|
2844
2920
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
2845
2921
|
The Canadian SIN mask (999 999 999) is applied automatically — no need to configure the mask.
|
|
2846
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" }`.
|
|
@@ -2860,6 +2936,7 @@ Events: `change`, `blur`
|
|
|
2860
2936
|
| `defaultValue` | no | string | Initial masked value set in Form on mount |
|
|
2861
2937
|
| `fixedCharsPrefix` | no | string | Fixes characters at the beginning of the value |
|
|
2862
2938
|
| `fixedCharsSuffix` | no | string | Fixes characters at the end of the value |
|
|
2939
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2863
2940
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2864
2941
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
2865
2942
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
@@ -2877,6 +2954,7 @@ No additional properties.
|
|
|
2877
2954
|
|
|
2878
2955
|
A Form-registered slider for use inside a Form component.
|
|
2879
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.
|
|
2880
2958
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
2881
2959
|
Values flow through the parent Form's `values` push-binding on submit/change.
|
|
2882
2960
|
Use `marks` to label specific positions on the slider track.
|
|
@@ -2897,6 +2975,7 @@ Events: `change`
|
|
|
2897
2975
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
2898
2976
|
| `appearance` | no | [FormSliderAppearance](./definitions.md#formsliderappearance) | Sets slider appearance. Default: PRIMARY |
|
|
2899
2977
|
| `defaultValue` | no | number | Initial value when uncontrolled. Default: 0 |
|
|
2978
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2900
2979
|
| `hideTooltip` | no | boolean | Hide the value tooltip. Default: false |
|
|
2901
2980
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2902
2981
|
| `isDotsVisible` | no | boolean | If true renders slider with dots. Default: true |
|
|
@@ -2918,6 +2997,7 @@ No additional properties.
|
|
|
2918
2997
|
|
|
2919
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.
|
|
2920
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.
|
|
2921
3001
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
2922
3002
|
The US SSN mask (999-99-9999) is applied automatically — no need to configure the mask.
|
|
2923
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" }`.
|
|
@@ -2937,6 +3017,7 @@ Events: `change`, `blur`
|
|
|
2937
3017
|
| `defaultValue` | no | string | Initial masked value set in Form on mount |
|
|
2938
3018
|
| `fixedCharsPrefix` | no | string | Fixes characters at the beginning of the value |
|
|
2939
3019
|
| `fixedCharsSuffix` | no | string | Fixes characters at the end of the value |
|
|
3020
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2940
3021
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2941
3022
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
2942
3023
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
@@ -2954,6 +3035,7 @@ No additional properties.
|
|
|
2954
3035
|
|
|
2955
3036
|
A Form-registered survey/rating input for collecting a bounded opinion or score inside a Form.
|
|
2956
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.
|
|
2957
3039
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
2958
3040
|
Single-select stores one value; `isMulti` stores an array of selected values.
|
|
2959
3041
|
Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
|
|
@@ -2972,6 +3054,7 @@ Events: `change`
|
|
|
2972
3054
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
2973
3055
|
| `caption` | no | string | Caption text displayed below the survey |
|
|
2974
3056
|
| `defaultValue` | no | string \| number \| string \| number[] | Initial selected value(s) set on mount |
|
|
3057
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
2975
3058
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2976
3059
|
| `isMulti` | no | boolean | Allow multiple selections. Default: false |
|
|
2977
3060
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -2992,6 +3075,7 @@ No additional properties.
|
|
|
2992
3075
|
|
|
2993
3076
|
A Form-registered toggle switch for use inside a Form component.
|
|
2994
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.
|
|
2995
3079
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
2996
3080
|
Stores a boolean (true/false) value keyed by `name` in the parent Form's values.
|
|
2997
3081
|
Use `defaultValue: true` to pre-toggle the switch on.
|
|
@@ -3013,6 +3097,7 @@ Events: `change`
|
|
|
3013
3097
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
3014
3098
|
| `compact` | no | boolean | Use compact size variant |
|
|
3015
3099
|
| `defaultValue` | no | boolean | Initial toggle state when uncontrolled |
|
|
3100
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
3016
3101
|
| `isDisabled` | no | boolean | Disables the input |
|
|
3017
3102
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
3018
3103
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
@@ -3036,7 +3121,9 @@ Individual values are not bound to state; they flow through the parent Form's `v
|
|
|
3036
3121
|
Use `validations` for Form rule strings: "isEmail", "minLength:5", "maxLength:100", "isNumeric", etc.
|
|
3037
3122
|
Browser/input behavior props such as `minLength`, `autoCapitalize`, `autoCorrect`, `spellCheck`, `inputMode`, `stringPadding`, and `shouldPersistCursorPosition` preserve the underlying Text input API.
|
|
3038
3123
|
Use `validationErrors` to override default error messages per rule.
|
|
3124
|
+
`helperMessage` displays supporting text below the input. Validation errors temporarily replace it, and it returns when validation clears.
|
|
3039
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.
|
|
3040
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" }`.
|
|
3041
3128
|
onChange emits "change"; onBlur emits "blur".
|
|
3042
3129
|
|
|
@@ -3057,6 +3144,7 @@ Events: `change`, `blur`
|
|
|
3057
3144
|
| `autoFocus` | no | boolean | Auto-focus on mount |
|
|
3058
3145
|
| `canClear` | no | boolean | Show clear button |
|
|
3059
3146
|
| `defaultValue` | no | string | Initial default value for uncontrolled usage |
|
|
3147
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
3060
3148
|
| `inputMode` | no | [EmailInputMode](./definitions.md#emailinputmode) | Virtual keyboard type hint |
|
|
3061
3149
|
| `isDisabled` | no | boolean | Disables the input |
|
|
3062
3150
|
| `isOriginalInputReadOnly` | no | boolean | Sets readonly mode directly on input HTML element |
|
|
@@ -3085,6 +3173,7 @@ No additional properties.
|
|
|
3085
3173
|
|
|
3086
3174
|
A Form-registered multi-line textarea for use inside a Form component.
|
|
3087
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.
|
|
3088
3177
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
3089
3178
|
Values flow through the parent Form's `values` push-binding on submit/change.
|
|
3090
3179
|
Set hasCharsLimit with maxLength to show a character counter.
|
|
@@ -3107,6 +3196,7 @@ Events: `change`, `blur`, `focus`
|
|
|
3107
3196
|
| `defaultValue` | no | string | Initial default value for uncontrolled usage |
|
|
3108
3197
|
| `hasCharsLimit` | no | boolean | Show character count indicator. Requires maxLength to be set |
|
|
3109
3198
|
| `height` | no | number | Fixed height in pixels |
|
|
3199
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
3110
3200
|
| `isDisabled` | no | boolean | Disables the input |
|
|
3111
3201
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
3112
3202
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
@@ -3127,6 +3217,7 @@ No additional properties.
|
|
|
3127
3217
|
|
|
3128
3218
|
A Form-registered text field with auto-suggest dropdown for use inside a Form component.
|
|
3129
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.
|
|
3130
3221
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
3131
3222
|
Values flow through the parent Form's `values` push-binding on submit/change.
|
|
3132
3223
|
Pass `list` as the React-style flat suggestion list. Common fields are `label`, `value`, and `isDisabled`; extra serializable item metadata is preserved.
|
|
@@ -3147,6 +3238,7 @@ Events: `change`, `blur`
|
|
|
3147
3238
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
3148
3239
|
| `defaultValue` | no | string | Initial value set in Form on mount |
|
|
3149
3240
|
| `fuseOptions` | no | [FormTextAutoSuggestFuseOption](./types.md#formtextautosuggestfuseoption) | Fuse.js search options for customizing suggestion filtering |
|
|
3241
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
3150
3242
|
| `isDisabled` | no | boolean | Disables the input |
|
|
3151
3243
|
| `isPositionFixed` | no | boolean | Use fixed positioning for dropdown menu. Useful in scrollable containers |
|
|
3152
3244
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -3168,6 +3260,7 @@ No additional properties.
|
|
|
3168
3260
|
|
|
3169
3261
|
A Form-registered time picker field for use inside a Form component.
|
|
3170
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.
|
|
3171
3264
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
3172
3265
|
Accepts ISO 8601 time strings or "HH:MM AM/PM" format as defaultValue.
|
|
3173
3266
|
Use timezone to specify the IANA timezone name for display and value handling.
|
|
@@ -3189,6 +3282,7 @@ Events: `change`, `blur`
|
|
|
3189
3282
|
| `alwaysShowTimezone` | no | boolean | If true, timezone abbreviation will always be shown. Default: false |
|
|
3190
3283
|
| `defaultSelectionStartTime` | no | string | Time to start the selection scroll from when shouldAllowTimeSelection is true (e.g. "08:00 AM") |
|
|
3191
3284
|
| `defaultValue` | no | string | Initial value — ISO 8601 or "HH:MM AM/PM" time string |
|
|
3285
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
3192
3286
|
| `isDateTimeInline` | no | boolean | Make input inline, removes border, padding and width fits input/placeholder content |
|
|
3193
3287
|
| `isDisabled` | no | boolean | Disables the input |
|
|
3194
3288
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -3216,6 +3310,7 @@ No additional properties.
|
|
|
3216
3310
|
|
|
3217
3311
|
A Form-registered timezone selector for choosing an IANA timezone inside a Form.
|
|
3218
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.
|
|
3219
3314
|
Must be placed inside a Form element — registers with Form and does not work standalone.
|
|
3220
3315
|
Stores an IANA timezone identifier string keyed by `name` in the parent Form values.
|
|
3221
3316
|
Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
|
|
@@ -3238,6 +3333,7 @@ Events: `change`, `blur`, `focus`
|
|
|
3238
3333
|
| `displayShortFormat` | no | boolean | Display timezone abbreviation |
|
|
3239
3334
|
| `dropdownHeight` | no | number | Height of the dropdown menu in pixels |
|
|
3240
3335
|
| `emptyListPlaceholder` | no | string | Placeholder text shown when no timezone matches the search |
|
|
3336
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
3241
3337
|
| `isDisabled` | no | boolean | Disables the input |
|
|
3242
3338
|
| `isMenuDefaultOpen` | no | boolean | If true, the dropdown menu will be open by default on mount |
|
|
3243
3339
|
| `isPositionFixed` | no | boolean | Use fixed positioning for dropdown (useful in scrollable containers) |
|
|
@@ -3262,6 +3358,7 @@ No additional properties.
|
|
|
3262
3358
|
|
|
3263
3359
|
A Form-registered tree selection field for use inside a Form component.
|
|
3264
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.
|
|
3265
3362
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
3266
3363
|
Set parent to the value of the parent node to build tree hierarchy; null for root nodes.
|
|
3267
3364
|
Use isMulti to allow selecting multiple nodes.
|
|
@@ -3288,6 +3385,7 @@ Events: `change`
|
|
|
3288
3385
|
| `hasIndependentActions` | no | boolean | In multiSelect, action on an item does not affect selection of parent or child items |
|
|
3289
3386
|
| `hasIndependentChildActions` | no | boolean | Actions on child in multi select do not affect selection of ancestors |
|
|
3290
3387
|
| `hasStaticParentNodes` | no | boolean | Makes parent nodes non-actionable (only manage hierarchy) |
|
|
3388
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
3291
3389
|
| `isDisabled` | no | boolean | Disables the input |
|
|
3292
3390
|
| `isMulti` | no | boolean | Allow multiple selection. Default: false |
|
|
3293
3391
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -3311,6 +3409,7 @@ No additional properties.
|
|
|
3311
3409
|
|
|
3312
3410
|
A Form-registered tree-select dropdown field for use inside a Form component.
|
|
3313
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.
|
|
3314
3413
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
3315
3414
|
Set parent to the value of the parent node to build tree hierarchy; null for root nodes.
|
|
3316
3415
|
Use isMulti to allow selecting multiple values displayed as chips.
|
|
@@ -3338,6 +3437,7 @@ Events: `change`
|
|
|
3338
3437
|
| `hasIndependentActions` | no | boolean | In multiSelect, action on an item does not affect selection of parent or child items |
|
|
3339
3438
|
| `hasIndependentChildActions` | no | boolean | Actions on child in multi select do not affect selection of ancestors |
|
|
3340
3439
|
| `hasStaticParentNodes` | no | boolean | Makes parent nodes non-actionable (only manage hierarchy) |
|
|
3440
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
3341
3441
|
| `isDisabled` | no | boolean | Disables the input |
|
|
3342
3442
|
| `isMenuDefaultOpen` | no | boolean | If true, dropdown menu will be open by default |
|
|
3343
3443
|
| `isMulti` | no | boolean | Allow multiple selection. Default: false |
|
|
@@ -3364,6 +3464,7 @@ No additional properties.
|
|
|
3364
3464
|
|
|
3365
3465
|
A Form-registered work email field for use inside a Form component.
|
|
3366
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.
|
|
3367
3468
|
Must be placed inside a Form element — it registers with Form and does not work standalone.
|
|
3368
3469
|
Use domainList to restrict suggestions to specific email domains.
|
|
3369
3470
|
The field validates email format automatically.
|
|
@@ -3384,6 +3485,7 @@ Events: `change`, `blur`
|
|
|
3384
3485
|
| `autoComplete` | no | string | Browser autocomplete hint |
|
|
3385
3486
|
| `defaultValue` | no | string | Initial default value for uncontrolled usage |
|
|
3386
3487
|
| `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 |
|
|
3488
|
+
| `helperMessage` | no | string | Persistent supporting text below the input. Validation errors temporarily replace it. |
|
|
3387
3489
|
| `isDisabled` | no | boolean | Disables the input |
|
|
3388
3490
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
3389
3491
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
@@ -4875,6 +4977,37 @@ Events: `change`, `beforeChange`, `afterChange`, `blur`
|
|
|
4875
4977
|
|
|
4876
4978
|
No additional properties.
|
|
4877
4979
|
|
|
4980
|
+
## RecordLookup
|
|
4981
|
+
|
|
4982
|
+
Searches and selects a record from a searchable model, such as custom objects, Employee, Department, Team, Work Location, Computer, Job Requisition, or Applicant.
|
|
4983
|
+
|
|
4984
|
+
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.
|
|
4985
|
+
|
|
4986
|
+
Catalog key: `RecordLookup`
|
|
4987
|
+
Builder: `RecordLookup`
|
|
4988
|
+
Props type: `RecordLookupProps`
|
|
4989
|
+
Accepts children: no
|
|
4990
|
+
Events: `change`
|
|
4991
|
+
|
|
4992
|
+
### Props
|
|
4993
|
+
|
|
4994
|
+
| Name | Required | Type | Description |
|
|
4995
|
+
|---|---:|---|---|
|
|
4996
|
+
| `canClear` | no | boolean | Controls whether the value can be cleared. |
|
|
4997
|
+
| `defaultValue` | no | string \| string[] | Initial uncontrolled record id, or record id array when isMulti is true. |
|
|
4998
|
+
| `isDisabled` | no | boolean | Disables searching and selection changes. |
|
|
4999
|
+
| `isMenuDefaultOpen` | no | boolean | Opens the menu when the field mounts. |
|
|
5000
|
+
| `isMulti` | no | boolean | Allows selecting multiple records. |
|
|
5001
|
+
| `isReadOnly` | no | boolean | Displays the value without allowing changes. |
|
|
5002
|
+
| `label` | no | string | Label displayed above the lookup. |
|
|
5003
|
+
| `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. |
|
|
5004
|
+
| `placeholder` | no | string | Search input placeholder. |
|
|
5005
|
+
| `shouldShowSearchIcon` | no | boolean | Controls whether the search icon is shown. |
|
|
5006
|
+
| `tip` | no | string | Supplementary text displayed with the label. |
|
|
5007
|
+
| `value` | no | string \| string[] | Controlled record id, or record id array when isMulti is true. |
|
|
5008
|
+
|
|
5009
|
+
No additional properties.
|
|
5010
|
+
|
|
4878
5011
|
## ReportLoader
|
|
4879
5012
|
|
|
4880
5013
|
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.
|
|
@@ -5949,6 +6082,7 @@ Use prefix/suffix for units or icons - pass Icon.TYPES names like "SEARCH_OUTLIN
|
|
|
5949
6082
|
Use inputMode to hint the virtual keyboard type on mobile devices
|
|
5950
6083
|
Use stringPadding to automatically pad values (e.g., "1" → "001" with {position: "start", maxLength: 3, character: "0"})
|
|
5951
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.
|
|
5952
6086
|
Standalone — does not register with Form; use FormText inside a Form instead.
|
|
5953
6087
|
|
|
5954
6088
|
Catalog key: `TextInput`
|