@rippling/pebble-sdui-web 0.4.2 → 0.6.3
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/action-params.d.ts +0 -5
- package/dist/catalogs/custom-apps/catalog.d.ts +1 -1
- package/dist/catalogs/custom-apps/component-props.d.ts +605 -176
- package/dist/catalogs/custom-apps/index.cjs +3 -3
- package/dist/catalogs/custom-apps/index.cjs.map +1 -1
- package/dist/catalogs/custom-apps/index.d.ts +1 -1
- package/dist/catalogs/custom-apps/index.js +212 -185
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/actions.md +15 -21
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +880 -878
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +655 -149
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +2 -2
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +1055 -104
- package/package.json +1 -1
|
@@ -9,10 +9,10 @@ Placeholder for states like empty, success, error, and loading, featuring animat
|
|
|
9
9
|
|
|
10
10
|
primaryActionTitle and secondaryActionTitle create action buttons. Bind pressPrimary and pressSecondary events to handle clicks. Use animation instead of icon to show a Lottie animation as the card asset. Skipped on action buttons: tip (TipTypes), badge (BadgeProps), onMouseEnter/onMouseLeave (DOM events), onClickWhileDisabled (callback).
|
|
11
11
|
|
|
12
|
-
Catalog key: `ActionCard`
|
|
13
|
-
Builder: `ActionCard`
|
|
14
|
-
Props type: `ActionCardProps`
|
|
15
|
-
Accepts children: no
|
|
12
|
+
Catalog key: `ActionCard`
|
|
13
|
+
Builder: `ActionCard`
|
|
14
|
+
Props type: `ActionCardProps`
|
|
15
|
+
Accepts children: no
|
|
16
16
|
Events: `pressPrimary`, `pressSecondary`
|
|
17
17
|
|
|
18
18
|
### Props
|
|
@@ -27,11 +27,11 @@ Events: `pressPrimary`, `pressSecondary`
|
|
|
27
27
|
| `primaryActionIcon` | no | string | Icon type string for the primary action button |
|
|
28
28
|
| `primaryActionIsDisabled` | no | boolean | Disable the primary action button. Default: false |
|
|
29
29
|
| `primaryActionTitle` | no | string | Label for the primary action button |
|
|
30
|
-
| `primaryActionTo` | no |
|
|
30
|
+
| `primaryActionTo` | no | string \| [ActionCardPrimaryActionTo](./types.md#actioncardprimaryactionto) | Navigation destination for primary action. String URL or { path, openInNewTab? } |
|
|
31
31
|
| `secondaryActionIcon` | no | string | Icon type string for the secondary action button |
|
|
32
32
|
| `secondaryActionIsDisabled` | no | boolean | Disable the secondary action button. Default: false |
|
|
33
33
|
| `secondaryActionTitle` | no | string | Label for the secondary action button |
|
|
34
|
-
| `secondaryActionTo` | no |
|
|
34
|
+
| `secondaryActionTo` | no | string \| [ActionCardSecondaryActionTo](./types.md#actioncardsecondaryactionto) | Navigation destination for secondary action. String URL or { path, openInNewTab? } |
|
|
35
35
|
| `shouldShowAsset` | no | boolean | Show the icon/animation asset. Default: true |
|
|
36
36
|
| `title` | no | string | Card title text |
|
|
37
37
|
|
|
@@ -43,10 +43,10 @@ Branded Rippling AI icon used to indicate AI-powered features or content. Displa
|
|
|
43
43
|
|
|
44
44
|
AiIcon wraps Atoms.AiIcon from Pebble. It renders the Rippling AI star icon with optional accompanying text. Use size to control the icon scale (SMALL, MEDIUM, LARGE). Set showText to false to render only the icon without the "Rippling AI" label.
|
|
45
45
|
|
|
46
|
-
Catalog key: `AiIcon`
|
|
47
|
-
Builder: `AiIcon`
|
|
48
|
-
Props type: `AiIconProps`
|
|
49
|
-
Accepts children: no
|
|
46
|
+
Catalog key: `AiIcon`
|
|
47
|
+
Builder: `AiIcon`
|
|
48
|
+
Props type: `AiIconProps`
|
|
49
|
+
Accepts children: no
|
|
50
50
|
Events: _none_
|
|
51
51
|
|
|
52
52
|
### Props
|
|
@@ -66,10 +66,10 @@ A persistent, high-priority notice that conveys critical information (errors, wa
|
|
|
66
66
|
|
|
67
67
|
primaryActionTitle and secondaryActionTitle create action buttons. Bind pressPrimary and pressSecondary events to handle clicks. Use isDismissible with the dismiss event to handle close actions.
|
|
68
68
|
|
|
69
|
-
Catalog key: `Alert`
|
|
70
|
-
Builder: `Alert`
|
|
71
|
-
Props type: `AlertProps`
|
|
72
|
-
Accepts children: no
|
|
69
|
+
Catalog key: `Alert`
|
|
70
|
+
Builder: `Alert`
|
|
71
|
+
Props type: `AlertProps`
|
|
72
|
+
Accepts children: no
|
|
73
73
|
Events: `pressPrimary`, `pressSecondary`, `dismiss`
|
|
74
74
|
|
|
75
75
|
### Props
|
|
@@ -83,12 +83,12 @@ Events: `pressPrimary`, `pressSecondary`, `dismiss`
|
|
|
83
83
|
| `primaryActionIsDisabled` | no | boolean | Disable the primary action button. Default: false |
|
|
84
84
|
| `primaryActionShouldShowSpinner` | no | boolean | Show spinner on the primary action button. Default: false |
|
|
85
85
|
| `primaryActionTitle` | no | string | Label text for the primary (filled) action button |
|
|
86
|
-
| `primaryActionTo` | no |
|
|
86
|
+
| `primaryActionTo` | no | string \| [AlertPrimaryActionTo](./types.md#alertprimaryactionto) | Navigation destination for primary action. String URL or { path, openInNewTab? } |
|
|
87
87
|
| `secondaryActionIcon` | no | string | Icon type string from Icon.TYPES for the secondary action button |
|
|
88
88
|
| `secondaryActionIsDisabled` | no | boolean | Disable the secondary action button. Default: false |
|
|
89
89
|
| `secondaryActionShouldShowSpinner` | no | boolean | Show spinner on the secondary action button. Default: false |
|
|
90
90
|
| `secondaryActionTitle` | no | string | Label text for the secondary (outlined) action button |
|
|
91
|
-
| `secondaryActionTo` | no |
|
|
91
|
+
| `secondaryActionTo` | no | string \| [AlertSecondaryActionTo](./types.md#alertsecondaryactionto) | Navigation destination for secondary action. String URL or { path, openInNewTab? } |
|
|
92
92
|
| `title` | no | string | Alert title text displayed above the message |
|
|
93
93
|
| `type` | no | [AlertType](./definitions.md#alerttype) | Alert type determining color and icon. Default: INFO |
|
|
94
94
|
|
|
@@ -100,10 +100,10 @@ Renders pre-built Lottie animations from a curated library. Each animation type
|
|
|
100
100
|
|
|
101
101
|
Wrap in a container with explicit height and width to control animation size. Animations play automatically on mount.
|
|
102
102
|
|
|
103
|
-
Catalog key: `Animation`
|
|
104
|
-
Builder: `Animation`
|
|
105
|
-
Props type: `AnimationProps`
|
|
106
|
-
Accepts children: no
|
|
103
|
+
Catalog key: `Animation`
|
|
104
|
+
Builder: `Animation`
|
|
105
|
+
Props type: `AnimationProps`
|
|
106
|
+
Accepts children: no
|
|
107
107
|
Events: _none_
|
|
108
108
|
|
|
109
109
|
### Props
|
|
@@ -120,10 +120,10 @@ A full-screen error state placeholder for API or server failures, displaying an
|
|
|
120
120
|
|
|
121
121
|
ApiError displays a full-screen error state with an animated exclamation mark icon and an error message. Use message to provide a custom error description; omit it to show the default i18n fallback. Use windowCentered to center within a relative-positioned parent, or fixedWindowCentered to center in the browser viewport.
|
|
122
122
|
|
|
123
|
-
Catalog key: `ApiError`
|
|
124
|
-
Builder: `ApiError`
|
|
125
|
-
Props type: `ApiErrorProps`
|
|
126
|
-
Accepts children: no
|
|
123
|
+
Catalog key: `ApiError`
|
|
124
|
+
Builder: `ApiError`
|
|
125
|
+
Props type: `ApiErrorProps`
|
|
126
|
+
Accepts children: no
|
|
127
127
|
Events: _none_
|
|
128
128
|
|
|
129
129
|
### Props
|
|
@@ -142,10 +142,10 @@ A skeleton placeholder shown while app group content is loading. Use when the la
|
|
|
142
142
|
|
|
143
143
|
AppGroupLoader displays a skeleton loading state for app group content. It renders a content loader with a fixed 610x130 viewport.
|
|
144
144
|
|
|
145
|
-
Catalog key: `AppGroupLoader`
|
|
146
|
-
Builder: `AppGroupLoader`
|
|
147
|
-
Props type: `AppGroupLoaderProps`
|
|
148
|
-
Accepts children: no
|
|
145
|
+
Catalog key: `AppGroupLoader`
|
|
146
|
+
Builder: `AppGroupLoader`
|
|
147
|
+
Props type: `AppGroupLoaderProps`
|
|
148
|
+
Accepts children: no
|
|
149
149
|
Events: _none_
|
|
150
150
|
|
|
151
151
|
### Props
|
|
@@ -165,10 +165,10 @@ Options also support rich metadata: secondaryLabel/tertiaryLabel/quaternaryLabel
|
|
|
165
165
|
onMenuToggle emits 'menuToggle' event when dropdown opens/closes.
|
|
166
166
|
Footer onClick emits the custom event name specified in footer.onClick.
|
|
167
167
|
|
|
168
|
-
Catalog key: `AppGroupSelect`
|
|
169
|
-
Builder: `AppGroupSelect`
|
|
170
|
-
Props type: `AppGroupSelectProps`
|
|
171
|
-
Accepts children: no
|
|
168
|
+
Catalog key: `AppGroupSelect`
|
|
169
|
+
Builder: `AppGroupSelect`
|
|
170
|
+
Props type: `AppGroupSelectProps`
|
|
171
|
+
Accepts children: no
|
|
172
172
|
Events: `change`, `blur`, `focus`, `paste`, `menuToggle`
|
|
173
173
|
|
|
174
174
|
### Props
|
|
@@ -185,7 +185,7 @@ Events: `change`, `blur`, `focus`, `paste`, `menuToggle`
|
|
|
185
185
|
| `creatable` | no | boolean | Allow creating new options not in the list |
|
|
186
186
|
| `defaultSearchQuery` | no | string | Initial search input value |
|
|
187
187
|
| `dropdownHeight` | no | number | Sets dropdown menu height in pixels |
|
|
188
|
-
| `emptyListPlaceholder` | no |
|
|
188
|
+
| `emptyListPlaceholder` | no | string \| [AppGroupSelectEmptyListPlaceholder](./types.md#appgroupselectemptylistplaceholder) | Placeholder when dropdown list is empty. Can be string or object with state-specific placeholders |
|
|
189
189
|
| `footer` | no | [AppGroupSelectFooter](./types.md#appgroupselectfooter) | Fixed footer at bottom of dropdown menu |
|
|
190
190
|
| `fuseOptions` | no | [AppGroupSelectFuseOption](./types.md#appgroupselectfuseoption) | Fuse.js search options for customizing fuzzy search behavior |
|
|
191
191
|
| `id` | no | string | HTML id attribute for the select input |
|
|
@@ -196,9 +196,9 @@ Events: `change`, `blur`, `focus`, `paste`, `menuToggle`
|
|
|
196
196
|
| `isRequired` | no | boolean | Marks the field as required |
|
|
197
197
|
| `isSearchable` | no | boolean | Enable type-to-search filtering |
|
|
198
198
|
| `label` | no | string | Label text above the select |
|
|
199
|
-
| `maxHeight` | no |
|
|
199
|
+
| `maxHeight` | no | string \| number | Max height of multi-select container (CSS value) |
|
|
200
200
|
| `maxTruncationLines` | no | number | Max rows of chips visible before "+X" overflow chip appears |
|
|
201
|
-
| `options` | no |
|
|
201
|
+
| `options` | no | [AppGroupSelectOption](./types.md#appgroupselectoption) \| [AppGroupSelectOption](./types.md#appgroupselectoption)[] | Array of options or grouped options. Supports flat list or nested groups with label and list properties |
|
|
202
202
|
| `placeholder` | no | string | Placeholder text when empty |
|
|
203
203
|
| `placement` | no | [AppGroupSelectPlacement](./definitions.md#appgroupselectplacement) | Dropdown position relative to input. Default: bottom-start |
|
|
204
204
|
| `rows` | no | number | Minimum number of rows to show |
|
|
@@ -209,7 +209,7 @@ Events: `change`, `blur`, `focus`, `paste`, `menuToggle`
|
|
|
209
209
|
| `shouldUsePortal` | no | boolean | Render dropdown in a React Portal. Default: false |
|
|
210
210
|
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Select input size variant. Default: M |
|
|
211
211
|
| `validateOn` | no | [AppGroupSelectValidateOn](./definitions.md#appgroupselectvalidateon) | When to run validation checks. Requires checks to be set |
|
|
212
|
-
| `value` | no | unknown | Currently selected value(s) bound to state. Always an array in multi-select mode |
|
|
212
|
+
| `value` | no | unknown \| unknown[] | Currently selected value(s) bound to state. Always an array in multi-select mode |
|
|
213
213
|
|
|
214
214
|
No additional properties.
|
|
215
215
|
|
|
@@ -219,10 +219,10 @@ Application navigation bar with routing support. Displays a horizontal tab bar o
|
|
|
219
219
|
|
|
220
220
|
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.
|
|
221
221
|
|
|
222
|
-
Catalog key: `AppNavBar`
|
|
223
|
-
Builder: `AppNavBar`
|
|
224
|
-
Props type: `AppNavBarProps`
|
|
225
|
-
Accepts children: yes
|
|
222
|
+
Catalog key: `AppNavBar`
|
|
223
|
+
Builder: `AppNavBar`
|
|
224
|
+
Props type: `AppNavBarProps`
|
|
225
|
+
Accepts children: yes
|
|
226
226
|
Events: `navigate`, `action`
|
|
227
227
|
|
|
228
228
|
### Props
|
|
@@ -250,10 +250,10 @@ No additional properties.
|
|
|
250
250
|
|
|
251
251
|
A horizontal rule that visually divides sections of content, with optional centered text (e.g. "OR"). Use for content separation — use Divider for separating individual list items.
|
|
252
252
|
|
|
253
|
-
Catalog key: `AtomsSeparator`
|
|
254
|
-
Builder: `AtomsSeparator`
|
|
255
|
-
Props type: `AtomsSeparatorProps`
|
|
256
|
-
Accepts children: no
|
|
253
|
+
Catalog key: `AtomsSeparator`
|
|
254
|
+
Builder: `AtomsSeparator`
|
|
255
|
+
Props type: `AtomsSeparatorProps`
|
|
256
|
+
Accepts children: no
|
|
257
257
|
Events: _none_
|
|
258
258
|
|
|
259
259
|
### Props
|
|
@@ -271,10 +271,10 @@ A visual representation of an entity, such as a user, organization, or product.
|
|
|
271
271
|
|
|
272
272
|
Type semantics: USER is the default for people (shows image or initials fallback). TEXT shows first+last initials from title. ICON displays a specified icon to represent an entity. NUMBER indicates overflow count in avatar lists. RIPPLING is exclusive to the Rippling brand. Badge and flag are mutually exclusive — use either badgeChar or flagCountryCode, not both. When using flagCountryCode, flagSurfaceColor is required. tip.content accepts a plain string for tooltip text shown on hover.
|
|
273
273
|
|
|
274
|
-
Catalog key: `Avatar`
|
|
275
|
-
Builder: `Avatar`
|
|
276
|
-
Props type: `AvatarProps`
|
|
277
|
-
Accepts children: no
|
|
274
|
+
Catalog key: `Avatar`
|
|
275
|
+
Builder: `Avatar`
|
|
276
|
+
Props type: `AvatarProps`
|
|
277
|
+
Accepts children: no
|
|
278
278
|
Events: `press`
|
|
279
279
|
|
|
280
280
|
### Props
|
|
@@ -290,7 +290,7 @@ Events: `press`
|
|
|
290
290
|
| `caption` | no | string | Secondary text shown below the title |
|
|
291
291
|
| `flagCountryCode` | no | string | ISO country code (e.g. US, IN) to show a flag overlay on the avatar |
|
|
292
292
|
| `flagSurfaceColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Surface color for flag background. Pebble color token. Required with flagCountryCode |
|
|
293
|
-
| `icon` | no |
|
|
293
|
+
| `icon` | no | string \| [AvatarIcon](./types.md#avataricon) | Icon name from Icon.TYPES (e.g. EDIT_OUTLINE) or { type, color?, backgroundColor? } when type is ICON |
|
|
294
294
|
| `image` | no | string | Image URL for the avatar |
|
|
295
295
|
| `imageBackground` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Surface color token behind the avatar image |
|
|
296
296
|
| `isCompact` | no | boolean | Compact mode hides title and caption. Default: false |
|
|
@@ -298,7 +298,7 @@ Events: `press`
|
|
|
298
298
|
| `size` | no | [AvatarSize](./definitions.md#avatarsize) | Avatar size variant. Default: S |
|
|
299
299
|
| `tip` | no | [AvatarTip](./types.md#avatartip) | Tooltip shown on avatar hover. Object with content string and optional title |
|
|
300
300
|
| `title` | no | string | Display name shown below or beside the avatar |
|
|
301
|
-
| `to` | no |
|
|
301
|
+
| `to` | no | string \| [AvatarTo](./types.md#avatarto) | Navigation destination. String URL or { path, openInNewTab? }. Use instead of click event if click is just for navigation |
|
|
302
302
|
| `truncate` | no | boolean | Truncate title and caption with ellipsis. Default: true |
|
|
303
303
|
| `type` | no | [AvatarType](./definitions.md#avatartype) | Avatar content type. Default: USER |
|
|
304
304
|
|
|
@@ -310,10 +310,10 @@ Displays a list of avatars with a configurable maximum limit that automatically
|
|
|
310
310
|
|
|
311
311
|
Shows up to limit avatars with a +N overflow badge. Clicking overflow opens a modal listing all roles.
|
|
312
312
|
|
|
313
|
-
Catalog key: `AvatarList`
|
|
314
|
-
Builder: `AvatarList`
|
|
315
|
-
Props type: `AvatarListProps`
|
|
316
|
-
Accepts children: no
|
|
313
|
+
Catalog key: `AvatarList`
|
|
314
|
+
Builder: `AvatarList`
|
|
315
|
+
Props type: `AvatarListProps`
|
|
316
|
+
Accepts children: no
|
|
317
317
|
Events: _none_
|
|
318
318
|
|
|
319
319
|
### Props
|
|
@@ -336,10 +336,10 @@ A static indicator for displaying notifications, counts, or numerical status inf
|
|
|
336
336
|
|
|
337
337
|
Badge displays small status indicators or notification counts. Use tip to add hover tooltips. The component returns null if text is empty. Badge is a leaf component — it cannot contain children. When repeating multiple badges, use a layout container (e.g. HStack) as the repeat element with Badge elements as children.
|
|
338
338
|
|
|
339
|
-
Catalog key: `Badge`
|
|
340
|
-
Builder: `Badge`
|
|
341
|
-
Props type: `BadgeProps`
|
|
342
|
-
Accepts children: no
|
|
339
|
+
Catalog key: `Badge`
|
|
340
|
+
Builder: `Badge`
|
|
341
|
+
Props type: `BadgeProps`
|
|
342
|
+
Accepts children: no
|
|
343
343
|
Events: _none_
|
|
344
344
|
|
|
345
345
|
### Props
|
|
@@ -385,10 +385,10 @@ Box is a flexible layout container built on CSS flexbox. It provides extensive s
|
|
|
385
385
|
- border: Can be string or object with top/right/bottom/left
|
|
386
386
|
- Number values on dimension props automatically get 'px' suffix
|
|
387
387
|
|
|
388
|
-
Catalog key: `Box`
|
|
389
|
-
Builder: `Box`
|
|
390
|
-
Props type: `BoxProps`
|
|
391
|
-
Accepts children: yes
|
|
388
|
+
Catalog key: `Box`
|
|
389
|
+
Builder: `Box`
|
|
390
|
+
Props type: `BoxProps`
|
|
391
|
+
Accepts children: yes
|
|
392
392
|
Events: _none_
|
|
393
393
|
|
|
394
394
|
### Props
|
|
@@ -398,36 +398,36 @@ Events: _none_
|
|
|
398
398
|
| `align` | no | string | Align items on cross axis. CSS align-items value (e.g., "center", "flex-start") |
|
|
399
399
|
| `alignSelf` | no | string | Align this child on cross axis. CSS align-self value (e.g., "center", "flex-end") |
|
|
400
400
|
| `backgroundColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Background surface color token |
|
|
401
|
-
| `basis` | no |
|
|
402
|
-
| `border` | no |
|
|
401
|
+
| `basis` | no | number \| string | Flex basis value. Number (pixels) or CSS string |
|
|
402
|
+
| `border` | no | string \| [BoxBorder](./types.md#boxborder) \| [BoxBorder](./types.md#boxborder) | Border value. CSS string, strict token parts, or directional border object |
|
|
403
403
|
| `boxSizing` | no | string | CSS box-sizing value. "content-box" or "border-box". Default: content-box |
|
|
404
404
|
| `changeDirectionAbove` | no | number | Breakpoint in pixels at which to reverse flex direction. Uses container queries. Requires container prop for named containers |
|
|
405
405
|
| `child` | no | boolean | Whether this Box is a flex child. Changes display to initial |
|
|
406
406
|
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Text/icon color token |
|
|
407
|
-
| `container` | no |
|
|
407
|
+
| `container` | no | boolean \| string | Container query target. true for unnamed container, string for named container. Used with changeDirectionAbove |
|
|
408
408
|
| `direction` | no | string | Flex direction. CSS flex-direction value (e.g., "row", "column") |
|
|
409
409
|
| `flex` | no | string | CSS flex shorthand (e.g., "1", "0 1 auto") |
|
|
410
|
-
| `gap` | no |
|
|
411
|
-
| `grow` | no |
|
|
412
|
-
| `height` | no |
|
|
410
|
+
| `gap` | no | [BoxGap](./definitions.md#boxgap) \| [BoxGap](./types.md#boxgap) | Gap between flex children. Spacing token or {row, column} spacing-token object |
|
|
411
|
+
| `grow` | no | number \| string | Flex grow factor. Number value |
|
|
412
|
+
| `height` | no | number \| string | Height value. Number (pixels) or CSS string (e.g., "100px", "50%") |
|
|
413
413
|
| `id` | no | string | HTML id attribute |
|
|
414
414
|
| `isInline` | no | boolean | Use inline-flex instead of flex. Default: false |
|
|
415
415
|
| `justify` | no | string | Justify content on main axis. CSS justify-content value (e.g., "center", "space-between") |
|
|
416
|
-
| `margin` | no |
|
|
417
|
-
| `maxHeight` | no |
|
|
418
|
-
| `maxWidth` | no |
|
|
419
|
-
| `minHeight` | no |
|
|
420
|
-
| `minWidth` | no |
|
|
416
|
+
| `margin` | no | [BoxGap](./definitions.md#boxgap) \| [BoxMargin](./types.md#boxmargin) | Margin value. Spacing token or {top, right, bottom, left} spacing-token object |
|
|
417
|
+
| `maxHeight` | no | number \| string | Maximum height value. Number (pixels) or CSS string |
|
|
418
|
+
| `maxWidth` | no | number \| string | Maximum width value. Number (pixels) or CSS string |
|
|
419
|
+
| `minHeight` | no | number \| string | Minimum height value. Number (pixels) or CSS string |
|
|
420
|
+
| `minWidth` | no | number \| string | Minimum width value. Number (pixels) or CSS string |
|
|
421
421
|
| `overflow` | no | string | CSS overflow value (e.g., "hidden", "auto", "scroll") |
|
|
422
|
-
| `padding` | no |
|
|
422
|
+
| `padding` | no | [BoxGap](./definitions.md#boxgap) \| [BoxPadding](./types.md#boxpadding) | Padding value. Spacing token or {top, right, bottom, left} spacing-token object |
|
|
423
423
|
| `position` | no | string | CSS position value (e.g., "relative", "absolute", "fixed") |
|
|
424
|
-
| `radius` | no |
|
|
424
|
+
| `radius` | no | [BoxRadius](./definitions.md#boxradius) \| [BoxRadiu](./types.md#boxradiu) | Border radius. Radius token or {topLeft, topRight, bottomLeft, bottomRight} radius-token object |
|
|
425
425
|
| `reverse` | no | boolean | Reverse the flex direction. Combines with direction prop |
|
|
426
426
|
| `role` | no | string | ARIA role attribute |
|
|
427
|
-
| `shrink` | no |
|
|
428
|
-
| `width` | no |
|
|
427
|
+
| `shrink` | no | number \| string | Flex shrink factor. Number value |
|
|
428
|
+
| `width` | no | number \| string | Width value. Number (pixels) or CSS string (e.g., "200px", "100%") |
|
|
429
429
|
| `wrap` | no | string | Flex wrap behavior. CSS flex-wrap value (e.g., "wrap", "nowrap") |
|
|
430
|
-
| `zIndex` | no |
|
|
430
|
+
| `zIndex` | no | number \| string | Z-index stacking order. Number value |
|
|
431
431
|
|
|
432
432
|
No additional properties.
|
|
433
433
|
|
|
@@ -437,10 +437,10 @@ Displays Rippling brand badges with consistent styling. Badges come in animated
|
|
|
437
437
|
|
|
438
438
|
The type prop determines which badge icon to display. Animated types (e.g. CHECK_MARK, CALENDAR) are Lottie animations that play automatically unless motion="static" is set. Static types (e.g. ROCKET, FIRE) are SVG illustrations. All badges use consistent sizing and Rippling brand styling. Cannot be nested or accept children.
|
|
439
439
|
|
|
440
|
-
Catalog key: `BrandBadge`
|
|
441
|
-
Builder: `BrandBadge`
|
|
442
|
-
Props type: `BrandBadgeProps`
|
|
443
|
-
Accepts children: no
|
|
440
|
+
Catalog key: `BrandBadge`
|
|
441
|
+
Builder: `BrandBadge`
|
|
442
|
+
Props type: `BrandBadgeProps`
|
|
443
|
+
Accepts children: no
|
|
444
444
|
Events: _none_
|
|
445
445
|
|
|
446
446
|
### Props
|
|
@@ -458,10 +458,10 @@ A sequential series of links that mark the nested hierarchy and navigational con
|
|
|
458
458
|
|
|
459
459
|
The select event fires when a breadcrumb item is clicked. Bind active to state to track the selected item. On select, the clicked item value is written to the bound state path.
|
|
460
460
|
|
|
461
|
-
Catalog key: `Breadcrumb`
|
|
462
|
-
Builder: `Breadcrumb`
|
|
463
|
-
Props type: `BreadcrumbProps`
|
|
464
|
-
Accepts children: no
|
|
461
|
+
Catalog key: `Breadcrumb`
|
|
462
|
+
Builder: `Breadcrumb`
|
|
463
|
+
Props type: `BreadcrumbProps`
|
|
464
|
+
Accepts children: no
|
|
465
465
|
Events: `select`
|
|
466
466
|
|
|
467
467
|
### Props
|
|
@@ -513,10 +513,10 @@ An interactive element that allows users to trigger actions or events with a sin
|
|
|
513
513
|
- Icon alignment controls whether icon appears LEFT or RIGHT of label
|
|
514
514
|
- Default alignment is LEFT
|
|
515
515
|
|
|
516
|
-
Catalog key: `Button`
|
|
517
|
-
Builder: `Button`
|
|
518
|
-
Props type: `ButtonProps`
|
|
519
|
-
Accepts children: no
|
|
516
|
+
Catalog key: `Button`
|
|
517
|
+
Builder: `Button`
|
|
518
|
+
Props type: `ButtonProps`
|
|
519
|
+
Accepts children: no
|
|
520
520
|
Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
|
|
521
521
|
|
|
522
522
|
### Props
|
|
@@ -527,13 +527,13 @@ Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
|
|
|
527
527
|
| `aria-controls` | no | string | ID of element controlled by this button |
|
|
528
528
|
| `aria-describedby` | no | string | ID of element that describes this button |
|
|
529
529
|
| `aria-expanded` | no | boolean | Indicates whether controlled element is expanded |
|
|
530
|
-
| `aria-haspopup` | no |
|
|
530
|
+
| `aria-haspopup` | no | boolean \| [ButtonAriaHaspopup](./definitions.md#buttonariahaspopup) | Indicates button triggers a popup element |
|
|
531
531
|
| `aria-label` | no | string | Accessibility label for the button |
|
|
532
532
|
| `aria-labelledby` | no | string | ID of element that labels this button |
|
|
533
|
-
| `aria-pressed` | no |
|
|
533
|
+
| `aria-pressed` | no | boolean \| [ButtonAriaPressed](./definitions.md#buttonariapressed) | Indicates button pressed state (for toggle buttons) |
|
|
534
534
|
| `badge` | no | string | Badge text shown on the button |
|
|
535
535
|
| `fontInherit` | no | boolean | When variant is TEXT, inherit font from parent element. Only works with TEXT variant. Default: false |
|
|
536
|
-
| `icon` | no |
|
|
536
|
+
| `icon` | no | string \| [ButtonIcon](./types.md#buttonicon) | Icon to show in button. Can be icon name string or object with type, color, alignment |
|
|
537
537
|
| `id` | no | string | DOM id selector for the button element |
|
|
538
538
|
| `inverseDisabledColors` | no | boolean | Use inverse color tokens for disabled buttons on dark backgrounds. Default: false |
|
|
539
539
|
| `isDisabled` | no | boolean | Disables the button. Default: false |
|
|
@@ -543,8 +543,8 @@ Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
|
|
|
543
543
|
| `size` | no | [ButtonSize](./definitions.md#buttonsize) | Button size. Default: M |
|
|
544
544
|
| `tabIndex` | no | number | Tab order index for keyboard navigation |
|
|
545
545
|
| `testId` | no | string | Sets data-testid attribute. Default: "test_button" |
|
|
546
|
-
| `tip` | no |
|
|
547
|
-
| `to` | no |
|
|
546
|
+
| `tip` | no | string \| [ButtonTip](./types.md#buttontip) | Tooltip configuration. Can be simple string content or object with appearance/placement |
|
|
547
|
+
| `to` | no | string \| [ButtonTo](./types.md#buttonto) | Navigation destination. When provided, button renders as anchor and handles navigation automatically |
|
|
548
548
|
| `type` | no | [ButtonType](./definitions.md#buttontype) | HTML button type attribute. Default: button |
|
|
549
549
|
| `variant` | no | [ButtonVariant](./definitions.md#buttonvariant) | Button variant type. Default: NORMAL |
|
|
550
550
|
|
|
@@ -556,10 +556,10 @@ Layout container for arranging multiple Button elements horizontally or vertical
|
|
|
556
556
|
|
|
557
557
|
Place Button elements as children. Use placement to control horizontal vs vertical layout and alignment.
|
|
558
558
|
|
|
559
|
-
Catalog key: `ButtonGroup`
|
|
560
|
-
Builder: `ButtonGroup`
|
|
561
|
-
Props type: `ButtonGroupProps`
|
|
562
|
-
Accepts children: yes
|
|
559
|
+
Catalog key: `ButtonGroup`
|
|
560
|
+
Builder: `ButtonGroup`
|
|
561
|
+
Props type: `ButtonGroupProps`
|
|
562
|
+
Accepts children: yes
|
|
563
563
|
Events: _none_
|
|
564
564
|
|
|
565
565
|
### Props
|
|
@@ -567,9 +567,9 @@ Events: _none_
|
|
|
567
567
|
| Name | Required | Type | Description |
|
|
568
568
|
|---|---:|---|---|
|
|
569
569
|
| `alignment` | no | [ButtonGroupAlignment](./definitions.md#buttongroupalignment) | Cross-axis alignment. Default: center |
|
|
570
|
-
| `containerHeight` | no |
|
|
570
|
+
| `containerHeight` | no | string \| number | Height of the button group container |
|
|
571
571
|
| `flexWrap` | no | [ButtonGroupFlexWrap](./definitions.md#buttongroupflexwrap) | Whether buttons wrap to the next line |
|
|
572
|
-
| `gap` | no | [
|
|
572
|
+
| `gap` | no | [BoxGap](./definitions.md#boxgap) | Gap between buttons as a spacing token |
|
|
573
573
|
| `placement` | no | [ButtonGroupPlacement](./definitions.md#buttongroupplacement) | Layout placement of buttons. Default: horizontallyLeft |
|
|
574
574
|
|
|
575
575
|
No additional properties.
|
|
@@ -580,10 +580,10 @@ An inline calendar for selecting single or multiple dates. Displays a monthly vi
|
|
|
580
580
|
|
|
581
581
|
onClick stores an ISO 8601 date string (or array of strings for multi-select) in state. The format prop controls display only and does not affect the stored value. Use minDate/maxDate to restrict selectable range. onClear emits when user clicks clear button (if shown via footer).
|
|
582
582
|
|
|
583
|
-
Catalog key: `Calendar`
|
|
584
|
-
Builder: `Calendar`
|
|
585
|
-
Props type: `CalendarProps`
|
|
586
|
-
Accepts children: no
|
|
583
|
+
Catalog key: `Calendar`
|
|
584
|
+
Builder: `Calendar`
|
|
585
|
+
Props type: `CalendarProps`
|
|
586
|
+
Accepts children: no
|
|
587
587
|
Events: `click`, `clear`
|
|
588
588
|
|
|
589
589
|
### Props
|
|
@@ -596,10 +596,10 @@ Events: `click`, `clear`
|
|
|
596
596
|
| `maxDate` | no | string | Latest selectable date as ISO string |
|
|
597
597
|
| `minDate` | no | string | Earliest selectable date as ISO string |
|
|
598
598
|
| `shouldShowFooter` | no | boolean | Controls footer visibility. Default: true |
|
|
599
|
-
| `shouldShowHeader` | no |
|
|
599
|
+
| `shouldShowHeader` | no | boolean \| [ShouldShowHeader](./types.md#shouldshowheader) | Controls header visibility. Default: true |
|
|
600
600
|
| `shouldShowWeekDayInitials` | no | boolean | If false, hides week day initials. Default: true |
|
|
601
601
|
| `testId` | no | string | Data test id for testing purposes |
|
|
602
|
-
| `value` | no |
|
|
602
|
+
| `value` | no | string \| string[] | Selected date(s) as ISO string(s). Single date or array for multi-select |
|
|
603
603
|
|
|
604
604
|
No additional properties.
|
|
605
605
|
|
|
@@ -609,10 +609,10 @@ Visually groups related information and components into a contained, interactive
|
|
|
609
609
|
|
|
610
610
|
Card emits "click" when clicked, "edit"/"delete" for those actions, "add" for add cards, and "action" when a dropdown action is clicked. The clicked action id is written to the selectedActionId bound state before the "action" event fires. Use "to" prop for navigation. Use "content" prop for simple text or children for complex layouts. IMPORTANT: There is no margin beneath the card title. Always use a VStack with a top padding token as the first child of the Card to create spacing between the title and the content below.
|
|
611
611
|
|
|
612
|
-
Catalog key: `Card`
|
|
613
|
-
Builder: `Card`
|
|
614
|
-
Props type: `CardProps`
|
|
615
|
-
Accepts children: yes
|
|
612
|
+
Catalog key: `Card`
|
|
613
|
+
Builder: `Card`
|
|
614
|
+
Props type: `CardProps`
|
|
615
|
+
Accepts children: yes
|
|
616
616
|
Events: `edit`, `delete`, `add`, `click`, `action`
|
|
617
617
|
|
|
618
618
|
### Props
|
|
@@ -629,7 +629,7 @@ Events: `edit`, `delete`, `add`, `click`, `action`
|
|
|
629
629
|
| `showDelete` | no | boolean | Show delete button. Emits "delete" event when clicked. Default: false |
|
|
630
630
|
| `showEdit` | no | boolean | Show edit button. Emits "edit" event when clicked. Default: false |
|
|
631
631
|
| `title` | no | string | Card header title text |
|
|
632
|
-
| `to` | no |
|
|
632
|
+
| `to` | no | string \| [CardTo](./types.md#cardto) | Route destination. String URL or object with {path, openInNewTab}. Card renders as anchor when provided |
|
|
633
633
|
| `value` | no | unknown | Identifier value for the card, passed to event handlers |
|
|
634
634
|
|
|
635
635
|
No additional properties.
|
|
@@ -644,10 +644,10 @@ A layout container that arranges Card children (Card, LocationCard, LoaderCard)
|
|
|
644
644
|
|
|
645
645
|
**Children:** Should contain Card, LocationCard, or LoaderCard components only.
|
|
646
646
|
|
|
647
|
-
Catalog key: `CardGroup`
|
|
648
|
-
Builder: `CardGroup`
|
|
649
|
-
Props type: `CardGroupProps`
|
|
650
|
-
Accepts children: yes
|
|
647
|
+
Catalog key: `CardGroup`
|
|
648
|
+
Builder: `CardGroup`
|
|
649
|
+
Props type: `CardGroupProps`
|
|
650
|
+
Accepts children: yes
|
|
651
651
|
Events: _none_
|
|
652
652
|
|
|
653
653
|
### Props
|
|
@@ -665,10 +665,10 @@ A step-through image carousel for onboarding flows and guided walkthroughs. Each
|
|
|
665
665
|
|
|
666
666
|
Carousel displays slides with a heading and image. Navigating past the last slide emits the done event. Use for onboarding flows or guided walkthroughs.
|
|
667
667
|
|
|
668
|
-
Catalog key: `Carousel`
|
|
669
|
-
Builder: `Carousel`
|
|
670
|
-
Props type: `CarouselProps`
|
|
671
|
-
Accepts children: no
|
|
668
|
+
Catalog key: `Carousel`
|
|
669
|
+
Builder: `Carousel`
|
|
670
|
+
Props type: `CarouselProps`
|
|
671
|
+
Accepts children: no
|
|
672
672
|
Events: `done`
|
|
673
673
|
|
|
674
674
|
### Props
|
|
@@ -685,10 +685,10 @@ A skeleton placeholder shown while chart or graph content is loading. Use when t
|
|
|
685
685
|
|
|
686
686
|
ChartLoader displays a skeleton loading state for chart content. It renders an animated bar chart skeleton with 4 vertical bars at different heights.
|
|
687
687
|
|
|
688
|
-
Catalog key: `ChartLoader`
|
|
689
|
-
Builder: `ChartLoader`
|
|
690
|
-
Props type: `ChartLoaderProps`
|
|
691
|
-
Accepts children: no
|
|
688
|
+
Catalog key: `ChartLoader`
|
|
689
|
+
Builder: `ChartLoader`
|
|
690
|
+
Props type: `ChartLoaderProps`
|
|
691
|
+
Accepts children: no
|
|
692
692
|
Events: _none_
|
|
693
693
|
|
|
694
694
|
### Props
|
|
@@ -703,10 +703,10 @@ A checkbox that lets users select or unselect an option. Use for toggling a sing
|
|
|
703
703
|
|
|
704
704
|
onChange stores a boolean (true/false) in state. Use isIndeterminate for partial selection (e.g., "select all" when some items are selected). Use theme="REVERSE" to flip checkbox/label alignment. Use variant="LIST" or "BOX" for different visual styles. Standalone — does not register with Form; use FormCheckbox inside a Form instead.
|
|
705
705
|
|
|
706
|
-
Catalog key: `Checkbox`
|
|
707
|
-
Builder: `Checkbox`
|
|
708
|
-
Props type: `CheckboxProps`
|
|
709
|
-
Accepts children: no
|
|
706
|
+
Catalog key: `Checkbox`
|
|
707
|
+
Builder: `Checkbox`
|
|
708
|
+
Props type: `CheckboxProps`
|
|
709
|
+
Accepts children: no
|
|
710
710
|
Events: `change`, `blur`
|
|
711
711
|
|
|
712
712
|
### Props
|
|
@@ -739,10 +739,10 @@ A group of checkboxes that lets users select multiple options from a predefined
|
|
|
739
739
|
|
|
740
740
|
onChange stores an array of selected values in state. Each value matches the value field of a selected option. Options support secondaryLabel for multi-line text, tag for badges (string or {label, appearance}), tip for hover tooltips, and isDisabled for individual checkbox disabling. When isReadOnly=true, displays selected values as chips instead of checkboxes. Use variant=LIST for vertical list, variant=BOX for outlined boxes, variant=GRID for grid layout. Standalone — does not register with Form; use FormCheckboxGroup inside a Form instead.
|
|
741
741
|
|
|
742
|
-
Catalog key: `CheckboxGroup`
|
|
743
|
-
Builder: `CheckboxGroup`
|
|
744
|
-
Props type: `CheckboxGroupProps`
|
|
745
|
-
Accepts children: no
|
|
742
|
+
Catalog key: `CheckboxGroup`
|
|
743
|
+
Builder: `CheckboxGroup`
|
|
744
|
+
Props type: `CheckboxGroupProps`
|
|
745
|
+
Accepts children: no
|
|
746
746
|
Events: `change`, `blur`
|
|
747
747
|
|
|
748
748
|
### Props
|
|
@@ -776,10 +776,10 @@ A flexible multi-select interface with nested lists, allowing users to toggle se
|
|
|
776
776
|
Each list item is an object with: label (string, display text), value (string, unique ID), isChecked (boolean). Optional item fields: isDisabled (boolean), isDefaultOpen (boolean, expand nested items on load), showMoreSize (number, child items shown before "show more"), branches (array of nested items with the same shape), checkListOptions ({ type?: "SWITCH"|"CHECKBOX", shouldHaveNegativeCheckbox?: boolean } to override per-item).
|
|
777
777
|
Bind list to $bindState so checked/unchecked state persists — onChange writes the updated list array back to state automatically.
|
|
778
778
|
|
|
779
|
-
Catalog key: `CheckList`
|
|
780
|
-
Builder: `CheckList`
|
|
781
|
-
Props type: `CheckListProps`
|
|
782
|
-
Accepts children: no
|
|
779
|
+
Catalog key: `CheckList`
|
|
780
|
+
Builder: `CheckList`
|
|
781
|
+
Props type: `CheckListProps`
|
|
782
|
+
Accepts children: no
|
|
783
783
|
Events: `change`
|
|
784
784
|
|
|
785
785
|
### Props
|
|
@@ -819,10 +819,10 @@ A compact, interactive element for representing entities, attributes, filters, o
|
|
|
819
819
|
- Use onClick alone for conditional navigation
|
|
820
820
|
- Both can be combined ('to' for navigation + onClick for analytics)
|
|
821
821
|
|
|
822
|
-
Catalog key: `Chip`
|
|
823
|
-
Builder: `Chip`
|
|
824
|
-
Props type: `ChipProps`
|
|
825
|
-
Accepts children: no
|
|
822
|
+
Catalog key: `Chip`
|
|
823
|
+
Builder: `Chip`
|
|
824
|
+
Props type: `ChipProps`
|
|
825
|
+
Accepts children: no
|
|
826
826
|
Events: `dismiss`, `press`
|
|
827
827
|
|
|
828
828
|
### Props
|
|
@@ -833,8 +833,8 @@ Events: `dismiss`, `press`
|
|
|
833
833
|
| `aria-describedby` | no | string | ID of element that describes this chip |
|
|
834
834
|
| `aria-label` | no | string | Accessibility label for the chip |
|
|
835
835
|
| `aria-labelledby` | no | string | ID of element that labels this chip |
|
|
836
|
-
| `avatar` | no |
|
|
837
|
-
| `icon` | no |
|
|
836
|
+
| `avatar` | no | string \| [ChipAvatar](./types.md#chipavatar) | Avatar to display at the beginning. Can be image URL string or object with image/title/imageProps |
|
|
837
|
+
| `icon` | no | string \| [ChipIcon](./types.md#chipicon) | Icon to display. Can be string name or object with type/color/alignment |
|
|
838
838
|
| `isActive` | no | boolean | If true, applies active/selected styling (used inside SelectableGroup) |
|
|
839
839
|
| `isDisabled` | no | boolean | If true, the chip is visually and functionally disabled |
|
|
840
840
|
| `isDismissible` | no | boolean | Shows close button when true. Default: false |
|
|
@@ -843,7 +843,7 @@ Events: `dismiss`, `press`
|
|
|
843
843
|
| `size` | no | [ChipSize](./definitions.md#chipsize) | Size of the chip (S, M, L, XL). Default: L |
|
|
844
844
|
| `text` | no | string | Text content to display in the chip |
|
|
845
845
|
| `tip` | no | [ChipTip](./types.md#chiptip) | Tooltip configuration. Chip has default overflow tooltip behavior |
|
|
846
|
-
| `to` | no |
|
|
846
|
+
| `to` | no | string \| [ChipTo](./types.md#chipto) | Navigation destination. Renders chip as anchor with router integration. Use for guaranteed navigation |
|
|
847
847
|
|
|
848
848
|
No additional properties.
|
|
849
849
|
|
|
@@ -863,10 +863,10 @@ A layout container for grouping multiple Chip components (tags, filters, attribu
|
|
|
863
863
|
|
|
864
864
|
**Children:** Should contain Chip components.
|
|
865
865
|
|
|
866
|
-
Catalog key: `ChipGroup`
|
|
867
|
-
Builder: `ChipGroup`
|
|
868
|
-
Props type: `ChipGroupProps`
|
|
869
|
-
Accepts children: yes
|
|
866
|
+
Catalog key: `ChipGroup`
|
|
867
|
+
Builder: `ChipGroup`
|
|
868
|
+
Props type: `ChipGroupProps`
|
|
869
|
+
Accepts children: yes
|
|
870
870
|
Events: `overflowChange`
|
|
871
871
|
|
|
872
872
|
### Props
|
|
@@ -874,7 +874,7 @@ Events: `overflowChange`
|
|
|
874
874
|
| Name | Required | Type | Description |
|
|
875
875
|
|---|---:|---|---|
|
|
876
876
|
| `batchSize` | no | number | Number of elements rendered in each incremental step, optimizing performance for large datasets |
|
|
877
|
-
| `gap` | no | [
|
|
877
|
+
| `gap` | no | [BoxGap](./definitions.md#boxgap) | Spacing token for the flex gap between chip items. Default: theme default spacing |
|
|
878
878
|
| `maxLinesToWrap` | no | number | Maximum number of lines to display before showing overflow modal. When set, chips exceeding this limit are hidden with a "+N more" trigger that opens a modal |
|
|
879
879
|
| `overflowModalTitle` | no | string | Title text shown in the overflow modal header when maxLinesToWrap limit is exceeded |
|
|
880
880
|
| `testId` | no | string | Test ID for the chip group container element |
|
|
@@ -887,10 +887,10 @@ Circular graphic element for status or decoration
|
|
|
887
887
|
|
|
888
888
|
Circle renders a solid or hollow colored circle. Use size to control the diameter in pixels and color to set the fill color token. Set isHollow to true to render an outlined circle instead of a filled one.
|
|
889
889
|
|
|
890
|
-
Catalog key: `Circle`
|
|
891
|
-
Builder: `Circle`
|
|
892
|
-
Props type: `CircleProps`
|
|
893
|
-
Accepts children: no
|
|
890
|
+
Catalog key: `Circle`
|
|
891
|
+
Builder: `Circle`
|
|
892
|
+
Props type: `CircleProps`
|
|
893
|
+
Accepts children: no
|
|
894
894
|
Events: _none_
|
|
895
895
|
|
|
896
896
|
### Props
|
|
@@ -909,10 +909,10 @@ A form input for selecting a color from a predefined palette or entering a custo
|
|
|
909
909
|
|
|
910
910
|
onChange stores a hex color string (e.g. "#FF5733"). The picker renders as a button trigger that opens a color palette panel. When allowCustomColors is true, users can also type in a custom hex value.
|
|
911
911
|
|
|
912
|
-
Catalog key: `ColorPicker`
|
|
913
|
-
Builder: `ColorPicker`
|
|
914
|
-
Props type: `ColorPickerProps`
|
|
915
|
-
Accepts children: no
|
|
912
|
+
Catalog key: `ColorPicker`
|
|
913
|
+
Builder: `ColorPicker`
|
|
914
|
+
Props type: `ColorPickerProps`
|
|
915
|
+
Accepts children: no
|
|
916
916
|
Events: `change`, `blur`
|
|
917
917
|
|
|
918
918
|
### Props
|
|
@@ -924,13 +924,13 @@ Events: `change`, `blur`
|
|
|
924
924
|
| `checks` | no | [ColorPickerCheck](./types.md#colorpickercheck)[] | Array of {type, message, args?} validation rule objects. Requires validateOn to be set |
|
|
925
925
|
| `colorPerRow` | no | number | Number of color swatches to display per row |
|
|
926
926
|
| `colors` | no | string[] | Array of hex color strings to show in the palette |
|
|
927
|
-
| `columnGap` | no | [
|
|
927
|
+
| `columnGap` | no | [BoxGap](./definitions.md#boxgap) | Horizontal spacing between color columns as a spacing token |
|
|
928
928
|
| `defaultValue` | no | string | Default hex color value for reset functionality |
|
|
929
929
|
| `isDisabled` | no | boolean | Disables the color picker |
|
|
930
930
|
| `isReadOnly` | no | boolean | Makes the color picker read-only |
|
|
931
931
|
| `isRequired` | no | boolean | Marks the field as required |
|
|
932
932
|
| `label` | no | string | Label text above the input |
|
|
933
|
-
| `rowGap` | no | [
|
|
933
|
+
| `rowGap` | no | [BoxGap](./definitions.md#boxgap) | Vertical spacing between color rows as a spacing token |
|
|
934
934
|
| `showReset` | no | boolean | Show reset link to restore default color. Default: true |
|
|
935
935
|
| `title` | no | string | Title displayed at the top of the color picker panel |
|
|
936
936
|
| `validateOn` | no | [AppGroupSelectValidateOn](./definitions.md#appgroupselectvalidateon) | When to run validation checks. Requires checks to be set |
|
|
@@ -944,10 +944,10 @@ A low-level SVG shimmer placeholder used to indicate loading state. Renders a pl
|
|
|
944
944
|
|
|
945
945
|
ContentLoader renders a generic SVG shimmer effect. For specific shapes (text lines, circles, boxes) prefer the Skeleton component instead. Skipped: baseUrl (SVG internal), uniqueKey (React key management), beforeMask (JSX element — not serializable).
|
|
946
946
|
|
|
947
|
-
Catalog key: `ContentLoader`
|
|
948
|
-
Builder: `ContentLoader`
|
|
949
|
-
Props type: `ContentLoaderProps`
|
|
950
|
-
Accepts children: no
|
|
947
|
+
Catalog key: `ContentLoader`
|
|
948
|
+
Builder: `ContentLoader`
|
|
949
|
+
Props type: `ContentLoaderProps`
|
|
950
|
+
Accepts children: no
|
|
951
951
|
Events: _none_
|
|
952
952
|
|
|
953
953
|
### Props
|
|
@@ -973,10 +973,10 @@ Countdown timer displaying time remaining until a target date
|
|
|
973
973
|
|
|
974
974
|
CountDown renders a live countdown to a future date. The date prop must be an ISO 8601 date-time string (e.g. "2025-12-31T23:59:59Z"). Use isInline to render the countdown inline within surrounding text. Use shouldUseShortString to display abbreviated time labels (d, h, m, s) instead of full words. The countdown updates automatically — every second when less than 2 minutes remain, every 30 seconds otherwise.
|
|
975
975
|
|
|
976
|
-
Catalog key: `CountDown`
|
|
977
|
-
Builder: `CountDown`
|
|
978
|
-
Props type: `CountDownProps`
|
|
979
|
-
Accepts children: no
|
|
976
|
+
Catalog key: `CountDown`
|
|
977
|
+
Builder: `CountDown`
|
|
978
|
+
Props type: `CountDownProps`
|
|
979
|
+
Accepts children: no
|
|
980
980
|
Events: _none_
|
|
981
981
|
|
|
982
982
|
### Props
|
|
@@ -995,10 +995,10 @@ Displays a country by its ISO code, showing flag and/or name. Can show both (def
|
|
|
995
995
|
|
|
996
996
|
Country displays a country flag and name given an ISO country code (e.g. "US", "IN"). Use size to control flag dimensions (S/M/L, default L). Set onlyFlag=true to show only the flag, or shouldShowFlag=false to show only the country name. The icon prop accepts either a string icon name (e.g. "INFO_CIRCLE_OUTLINE") or an object with type, alignment ("RIGHT"), tip, and color for more control.
|
|
997
997
|
|
|
998
|
-
Catalog key: `Country`
|
|
999
|
-
Builder: `Country`
|
|
1000
|
-
Props type: `CountryProps`
|
|
1001
|
-
Accepts children: no
|
|
998
|
+
Catalog key: `Country`
|
|
999
|
+
Builder: `Country`
|
|
1000
|
+
Props type: `CountryProps`
|
|
1001
|
+
Accepts children: no
|
|
1002
1002
|
Events: _none_
|
|
1003
1003
|
|
|
1004
1004
|
### Props
|
|
@@ -1006,7 +1006,7 @@ Events: _none_
|
|
|
1006
1006
|
| Name | Required | Type | Description |
|
|
1007
1007
|
|---|---:|---|---|
|
|
1008
1008
|
| `countryCode` | yes | string | ISO country code (e.g. "US", "IN", "GB"). Used to display the country flag and name. |
|
|
1009
|
-
| `icon` | no |
|
|
1009
|
+
| `icon` | no | string \| [CountryIcon](./types.md#countryicon) | Icon displayed alongside the country. Accepts a string icon name or an object with type, alignment, tip, and color. |
|
|
1010
1010
|
| `onlyFlag` | no | boolean | When true, shows only the flag without rendering the country name. Default: false |
|
|
1011
1011
|
| `shouldShowFlag` | no | boolean | When false, hides the country flag and shows only the country name. Default: true |
|
|
1012
1012
|
| `shouldShowTipOnOverflow` | no | boolean | When false, disables the tooltip that appears when the country name overflows. Default: true |
|
|
@@ -1020,10 +1020,10 @@ Specialized input for entering monetary amounts with currency symbol/code prefix
|
|
|
1020
1020
|
|
|
1021
1021
|
onChange stores a numeric value (number | string) in state. The prefix prop sets the currency symbol/code displayed before the amount; it does not affect the stored value. Use decimalPlaces to control precision. When canSelectCurrencyType is true, a dropdown selector is shown for currency selection. The currencyType prop controls the selected currency code (bind to state for user selection). Currency formatting is determined by the locale prop or user locale setting when shouldLocalize is true. When shouldAllowCalculation is true, users can enter arithmetic expressions (e.g. "100+50") which are evaluated on blur. Standalone — does not register with Form; use FormCurrency inside a Form instead.
|
|
1022
1022
|
|
|
1023
|
-
Catalog key: `Currency`
|
|
1024
|
-
Builder: `Currency`
|
|
1025
|
-
Props type: `CurrencyProps`
|
|
1026
|
-
Accepts children: no
|
|
1023
|
+
Catalog key: `Currency`
|
|
1024
|
+
Builder: `Currency`
|
|
1025
|
+
Props type: `CurrencyProps`
|
|
1026
|
+
Accepts children: no
|
|
1027
1027
|
Events: `change`, `blur`
|
|
1028
1028
|
|
|
1029
1029
|
### Props
|
|
@@ -1042,7 +1042,7 @@ Events: `change`, `blur`
|
|
|
1042
1042
|
| `currencyType` | no | string | Currency code for the selector when canSelectCurrencyType is true (e.g. USD, EUR) |
|
|
1043
1043
|
| `currencyTypeDefaultValue` | no | string | Default currency code for uncontrolled selector. Default: USD |
|
|
1044
1044
|
| `decimalPlaces` | no | number | Number of decimal places allowed. Default: 2 |
|
|
1045
|
-
| `defaultValue` | no |
|
|
1045
|
+
| `defaultValue` | no | string \| number | Initial value for uncontrolled component |
|
|
1046
1046
|
| `isDisabled` | no | boolean | Disables the input |
|
|
1047
1047
|
| `isIntegerOnly` | no | boolean | If true, only integer values will be allowed. Default: false |
|
|
1048
1048
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -1062,7 +1062,7 @@ Events: `change`, `blur`
|
|
|
1062
1062
|
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Input size variant. Default: M |
|
|
1063
1063
|
| `step` | no | number | Value to add/subtract on pressing arrow up/down respectively. Default: 1 |
|
|
1064
1064
|
| `validateOn` | no | [AppGroupSelectValidateOn](./definitions.md#appgroupselectvalidateon) | When to run validation checks. Requires checks to be set |
|
|
1065
|
-
| `value` | no |
|
|
1065
|
+
| `value` | no | string \| number | Current currency value bound to state |
|
|
1066
1066
|
|
|
1067
1067
|
No additional properties.
|
|
1068
1068
|
|
|
@@ -1072,10 +1072,10 @@ A date input that lets users select a single date via calendar or keyboard entry
|
|
|
1072
1072
|
|
|
1073
1073
|
onChange stores an ISO 8601 date string in state. When shouldShowTime is true, the stored ISO string includes time. The format prop is display-only and does not affect the stored value. Defaults to MM/dd/yyyy format and en-US locale. Standalone — does not register with Form; use FormDate inside a Form instead.
|
|
1074
1074
|
|
|
1075
|
-
Catalog key: `Date`
|
|
1076
|
-
Builder: `Date`
|
|
1077
|
-
Props type: `DateProps`
|
|
1078
|
-
Accepts children: no
|
|
1075
|
+
Catalog key: `Date`
|
|
1076
|
+
Builder: `Date`
|
|
1077
|
+
Props type: `DateProps`
|
|
1078
|
+
Accepts children: no
|
|
1079
1079
|
Events: `change`, `blur`
|
|
1080
1080
|
|
|
1081
1081
|
### Props
|
|
@@ -1103,6 +1103,7 @@ Events: `change`, `blur`
|
|
|
1103
1103
|
| `locale` | no | string | Locale for date formatting. Default: en-US |
|
|
1104
1104
|
| `maxDate` | no | string | Latest selectable date as ISO string |
|
|
1105
1105
|
| `minDate` | no | string | Earliest selectable date as ISO string |
|
|
1106
|
+
| `shouldDisplaySeconds` | no | boolean | Display seconds in the time input when shouldShowTime is true |
|
|
1106
1107
|
| `shouldFormatInTimezone` | no | boolean | If true, values will transform according to global timezone. Defaults to true when shouldShowTime is true |
|
|
1107
1108
|
| `shouldLocalize` | no | boolean | If true, display format will be determined from user locale setting. Default: false for explicit format control |
|
|
1108
1109
|
| `shouldShowTime` | no | boolean | Include time selection |
|
|
@@ -1121,10 +1122,10 @@ An always-visible inline calendar for selecting multiple individual dates withou
|
|
|
1121
1122
|
|
|
1122
1123
|
onChange stores an array of ISO 8601 date strings in state. Each date toggle adds or removes an ISO string from the array. The format prop is display-only and does not affect stored values.
|
|
1123
1124
|
|
|
1124
|
-
Catalog key: `DateInlineMulti`
|
|
1125
|
-
Builder: `DateInlineMulti`
|
|
1126
|
-
Props type: `DateInlineMultiProps`
|
|
1127
|
-
Accepts children: no
|
|
1125
|
+
Catalog key: `DateInlineMulti`
|
|
1126
|
+
Builder: `DateInlineMulti`
|
|
1127
|
+
Props type: `DateInlineMultiProps`
|
|
1128
|
+
Accepts children: no
|
|
1128
1129
|
Events: `change`, `blur`
|
|
1129
1130
|
|
|
1130
1131
|
### Props
|
|
@@ -1152,10 +1153,10 @@ A date range picker for selecting a start date and end date pair, such as travel
|
|
|
1152
1153
|
|
|
1153
1154
|
onChange stores an array of two ISO strings [startDate, endDate] in state. When shouldShowTime is true, the stored ISO strings include time. The format prop is display-only for user interface. timezone must be set when shouldShowTime is true for correct time conversion. shouldLocalize controls whether display format is determined from locale (default: true). startDateLabel/endDateLabel customize the field labels. Use aria-label or aria-labelledby for accessibility when label is not provided.
|
|
1154
1155
|
|
|
1155
|
-
Catalog key: `DateRange`
|
|
1156
|
-
Builder: `DateRange`
|
|
1157
|
-
Props type: `DateRangeProps`
|
|
1158
|
-
Accepts children: no
|
|
1156
|
+
Catalog key: `DateRange`
|
|
1157
|
+
Builder: `DateRange`
|
|
1158
|
+
Props type: `DateRangeProps`
|
|
1159
|
+
Accepts children: no
|
|
1159
1160
|
Events: `change`, `blur`
|
|
1160
1161
|
|
|
1161
1162
|
### Props
|
|
@@ -1182,6 +1183,7 @@ Events: `change`, `blur`
|
|
|
1182
1183
|
| `locale` | no | string | Locale for date formatting |
|
|
1183
1184
|
| `maxDate` | no | string | Latest selectable date as ISO string |
|
|
1184
1185
|
| `minDate` | no | string | Earliest selectable date as ISO string |
|
|
1186
|
+
| `shouldDisplaySeconds` | no | boolean | Display seconds in the time input when shouldShowTime is true |
|
|
1185
1187
|
| `shouldFormatInTimezone` | no | boolean | If true, values will transform according to global timezone. Defaults to true when shouldShowTime is true |
|
|
1186
1188
|
| `shouldLocalize` | no | boolean | If true, display format is determined from user locale. Default: true |
|
|
1187
1189
|
| `shouldShowTime` | no | boolean | Include time selection |
|
|
@@ -1200,10 +1202,10 @@ A form input for selecting one or more days of the week (Sunday through Saturday
|
|
|
1200
1202
|
|
|
1201
1203
|
onChange stores a single day string (e.g. "Monday") when isMulti is false, or an array of day strings (e.g. ["Monday", "Wednesday", "Friday"]) when isMulti is true. Valid day values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. Use renderProps to configure individual days - keys are day names, values can have isDisabled (boolean) and tip (object with content string). Standalone — does not register with Form; use FormDaySelector inside a Form instead.
|
|
1202
1204
|
|
|
1203
|
-
Catalog key: `DaySelector`
|
|
1204
|
-
Builder: `DaySelector`
|
|
1205
|
-
Props type: `DaySelectorProps`
|
|
1206
|
-
Accepts children: no
|
|
1205
|
+
Catalog key: `DaySelector`
|
|
1206
|
+
Builder: `DaySelector`
|
|
1207
|
+
Props type: `DaySelectorProps`
|
|
1208
|
+
Accepts children: no
|
|
1207
1209
|
Events: `change`
|
|
1208
1210
|
|
|
1209
1211
|
### Props
|
|
@@ -1212,14 +1214,14 @@ Events: `change`
|
|
|
1212
1214
|
|---|---:|---|---|
|
|
1213
1215
|
| `name` | no | string | Unique identifier for the input |
|
|
1214
1216
|
| `checks` | no | [DaySelectorCheck](./types.md#dayselectorcheck)[] | Array of {type, message, args?} validation rule objects. Requires validateOn to be set |
|
|
1215
|
-
| `defaultValue` | no |
|
|
1217
|
+
| `defaultValue` | no | [DaySelectorDefaultValue](./definitions.md#dayselectordefaultvalue) \| [DaySelectorDefaultValue](./definitions.md#dayselectordefaultvalue)[] | Initial day(s) when uncontrolled |
|
|
1216
1218
|
| `isMulti` | no | boolean | Allow multiple day selection. Default: false |
|
|
1217
1219
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
1218
1220
|
| `isRequired` | no | boolean | Marks the field as required |
|
|
1219
1221
|
| `label` | no | string | Label text above the input |
|
|
1220
1222
|
| `renderProps` | no | [RenderProp](./types.md#renderprop) | Per-day configuration. Keys are day names (Sunday, Monday, etc.). Each can have isDisabled (boolean) and tip (object with content string) |
|
|
1221
1223
|
| `validateOn` | no | [AppGroupSelectValidateOn](./definitions.md#appgroupselectvalidateon) | When to run validation checks. Requires checks to be set |
|
|
1222
|
-
| `value` | no |
|
|
1224
|
+
| `value` | no | [DaySelectorDefaultValue](./definitions.md#dayselectordefaultvalue) \| [DaySelectorDefaultValue](./definitions.md#dayselectordefaultvalue)[] | Selected day(s). Single string when isMulti is false, array when true |
|
|
1223
1225
|
|
|
1224
1226
|
No additional properties.
|
|
1225
1227
|
|
|
@@ -1229,10 +1231,10 @@ A horizontal stacked bar that visualizes proportional distribution of values acr
|
|
|
1229
1231
|
|
|
1230
1232
|
Each segment has a value and segmentColor. segmentColor must be a Pebble chart color token, or a semantic color token for status-related visualizations. The bar width is proportional to value/totalValue. If totalValue is omitted it is the sum of all segment values. Common chart tokens: chartColorSeries1Chart1 through chartColorSeries1Chart6 for generic categories. Use semantic status colors such as success, danger/error, warning, or neutral tokens for status-related visualizations.
|
|
1231
1233
|
|
|
1232
|
-
Catalog key: `DistributionBar`
|
|
1233
|
-
Builder: `DistributionBar`
|
|
1234
|
-
Props type: `DistributionBarProps`
|
|
1235
|
-
Accepts children: no
|
|
1234
|
+
Catalog key: `DistributionBar`
|
|
1235
|
+
Builder: `DistributionBar`
|
|
1236
|
+
Props type: `DistributionBarProps`
|
|
1237
|
+
Accepts children: no
|
|
1236
1238
|
Events: _none_
|
|
1237
1239
|
|
|
1238
1240
|
### Props
|
|
@@ -1249,17 +1251,17 @@ No additional properties.
|
|
|
1249
1251
|
|
|
1250
1252
|
Horizontal line to visually separate content sections
|
|
1251
1253
|
|
|
1252
|
-
Catalog key: `Divider`
|
|
1253
|
-
Builder: `Divider`
|
|
1254
|
-
Props type: `DividerProps`
|
|
1255
|
-
Accepts children: no
|
|
1254
|
+
Catalog key: `Divider`
|
|
1255
|
+
Builder: `Divider`
|
|
1256
|
+
Props type: `DividerProps`
|
|
1257
|
+
Accepts children: no
|
|
1256
1258
|
Events: _none_
|
|
1257
1259
|
|
|
1258
1260
|
### Props
|
|
1259
1261
|
|
|
1260
1262
|
| Name | Required | Type | Description |
|
|
1261
1263
|
|---|---:|---|---|
|
|
1262
|
-
| `spacing` | no | [
|
|
1264
|
+
| `spacing` | no | [BoxGap](./definitions.md#boxgap) | Vertical margin spacing token above and below the divider |
|
|
1263
1265
|
| `text` | no | string | Optional text displayed in the center of the divider line |
|
|
1264
1266
|
| `theme` | no | [DividerTheme](./definitions.md#dividertheme) | Line styles |
|
|
1265
1267
|
|
|
@@ -1271,10 +1273,10 @@ A reorderable drag-and-drop list for dynamically rearranging items. Supports ver
|
|
|
1271
1273
|
|
|
1272
1274
|
The list prop should be bound to state. When items are reordered or removed, the updated list array is written back to state. The update event fires after reorder; the remove event fires after an item is removed. Each item in the list must have a unique id field. The labelKey prop specifies which field to use as the display label for the default chip renderer.
|
|
1273
1275
|
|
|
1274
|
-
Catalog key: `DraggableList`
|
|
1275
|
-
Builder: `DraggableList`
|
|
1276
|
-
Props type: `DraggableListProps`
|
|
1277
|
-
Accepts children: no
|
|
1276
|
+
Catalog key: `DraggableList`
|
|
1277
|
+
Builder: `DraggableList`
|
|
1278
|
+
Props type: `DraggableListProps`
|
|
1279
|
+
Accepts children: no
|
|
1278
1280
|
Events: `update`, `remove`, `dragStart`, `dragEnd`
|
|
1279
1281
|
|
|
1280
1282
|
### Props
|
|
@@ -1300,10 +1302,10 @@ A sliding panel that appears from the edge of the screen, allowing users to acce
|
|
|
1300
1302
|
|
|
1301
1303
|
isVisible should be bound to state. Use $bindState with a dedicated boolean flag for simple open/close, or use $state to derive visibility from another value (e.g. a non-null selected item becomes falsy when cleared). The close event fires on cancel button click, ESC key, and backdrop click. Handle it with a setState action — if closing should also clear related state, bind isVisible to that state with $state so one action achieves both. Place drawer content as children.
|
|
1302
1304
|
|
|
1303
|
-
Catalog key: `Drawer`
|
|
1304
|
-
Builder: `Drawer`
|
|
1305
|
-
Props type: `DrawerProps`
|
|
1306
|
-
Accepts children: yes
|
|
1305
|
+
Catalog key: `Drawer`
|
|
1306
|
+
Builder: `Drawer`
|
|
1307
|
+
Props type: `DrawerProps`
|
|
1308
|
+
Accepts children: yes
|
|
1307
1309
|
Events: `close`
|
|
1308
1310
|
|
|
1309
1311
|
### Props
|
|
@@ -1313,14 +1315,14 @@ Events: `close`
|
|
|
1313
1315
|
| `caption` | no | string | Subtext below the title in the drawer header |
|
|
1314
1316
|
| `isCompact` | no | boolean | Renders drawer in compact view |
|
|
1315
1317
|
| `isVisible` | no | boolean | Whether the drawer is visible. Bind to state to control open/close |
|
|
1316
|
-
| `maxWidth` | no |
|
|
1318
|
+
| `maxWidth` | no | string \| number | Maximum width of the drawer. Default: 80vw |
|
|
1317
1319
|
| `shouldAttachToRoot` | no | boolean | Renders drawer in a portal at document root. Default: true |
|
|
1318
1320
|
| `shouldCloseOnBackdropClick` | no | boolean | Close drawer when clicking the backdrop. Default: true |
|
|
1319
1321
|
| `shouldCloseOnEscape` | no | boolean | Close drawer on ESC key press |
|
|
1320
1322
|
| `shouldNotAnimate` | no | boolean | Disables open/close animations. Default: false |
|
|
1321
1323
|
| `theme` | no | [DrawerTheme](./definitions.md#drawertheme) | Visual style theme for the drawer |
|
|
1322
1324
|
| `title` | no | string | Title text displayed in the drawer header |
|
|
1323
|
-
| `width` | no |
|
|
1325
|
+
| `width` | no | string \| number | Width of the drawer. Default: 80vw |
|
|
1324
1326
|
|
|
1325
1327
|
No additional properties.
|
|
1326
1328
|
|
|
@@ -1330,10 +1332,10 @@ A popover menu that displays a list of actions or selectable options. Use for 3
|
|
|
1330
1332
|
|
|
1331
1333
|
Bind value to state to track the selected option. The change event fires when the user selects an item. The selected item value (string) is written to state. triggerLabel renders a Button as the dropdown trigger.
|
|
1332
1334
|
|
|
1333
|
-
Catalog key: `Dropdown`
|
|
1334
|
-
Builder: `Dropdown`
|
|
1335
|
-
Props type: `DropdownProps`
|
|
1336
|
-
Accepts children: no
|
|
1335
|
+
Catalog key: `Dropdown`
|
|
1336
|
+
Builder: `Dropdown`
|
|
1337
|
+
Props type: `DropdownProps`
|
|
1338
|
+
Accepts children: no
|
|
1337
1339
|
Events: `change`
|
|
1338
1340
|
|
|
1339
1341
|
### Props
|
|
@@ -1367,10 +1369,10 @@ Use inputMode="email" to hint the email keyboard type on mobile devices
|
|
|
1367
1369
|
Supports basic ARIA attributes (aria-label, aria-labelledby, aria-describedby) for accessibility
|
|
1368
1370
|
Standalone — does not register with Form; use FormEmail inside a Form instead.
|
|
1369
1371
|
|
|
1370
|
-
Catalog key: `Email`
|
|
1371
|
-
Builder: `Email`
|
|
1372
|
-
Props type: `EmailProps`
|
|
1373
|
-
Accepts children: no
|
|
1372
|
+
Catalog key: `Email`
|
|
1373
|
+
Builder: `Email`
|
|
1374
|
+
Props type: `EmailProps`
|
|
1375
|
+
Accepts children: no
|
|
1374
1376
|
Events: `change`, `blur`, `focus`, `click`, `keydown`, `keyup`, `paste`, `mouseenter`, `mouseleave`
|
|
1375
1377
|
|
|
1376
1378
|
### Props
|
|
@@ -1420,10 +1422,10 @@ An emoji picker that lets users browse and select emojis by category or search.
|
|
|
1420
1422
|
|
|
1421
1423
|
onChange emits an object with emoji data: { id, name, native, shortcodes, keywords, unified }. The native property contains the actual emoji character to render. Use inline={true} to render directly in the layout; use inline={false} with a trigger for popover mode. Categories can be filtered with the categories prop.
|
|
1422
1424
|
|
|
1423
|
-
Catalog key: `EmojiPicker`
|
|
1424
|
-
Builder: `EmojiPicker`
|
|
1425
|
-
Props type: `EmojiPickerProps`
|
|
1426
|
-
Accepts children: no
|
|
1425
|
+
Catalog key: `EmojiPicker`
|
|
1426
|
+
Builder: `EmojiPicker`
|
|
1427
|
+
Props type: `EmojiPickerProps`
|
|
1428
|
+
Accepts children: no
|
|
1427
1429
|
Events: `change`
|
|
1428
1430
|
|
|
1429
1431
|
### Props
|
|
@@ -1459,10 +1461,10 @@ Theme guide — common variants:
|
|
|
1459
1461
|
- SURFACE_BACKGROUND: uses surface-level background color
|
|
1460
1462
|
Compound themes combine modifiers (e.g. REVERSED_TRANSPARENT_LIST = reversed + transparent + list style).
|
|
1461
1463
|
|
|
1462
|
-
Catalog key: `ExpansionPanel`
|
|
1463
|
-
Builder: `ExpansionPanel`
|
|
1464
|
-
Props type: `ExpansionPanelProps`
|
|
1465
|
-
Accepts children: yes
|
|
1464
|
+
Catalog key: `ExpansionPanel`
|
|
1465
|
+
Builder: `ExpansionPanel`
|
|
1466
|
+
Props type: `ExpansionPanelProps`
|
|
1467
|
+
Accepts children: yes
|
|
1466
1468
|
Events: `toggle`
|
|
1467
1469
|
|
|
1468
1470
|
### Props
|
|
@@ -1489,10 +1491,10 @@ A container that coordinates multiple ExpansionPanel children, optionally enforc
|
|
|
1489
1491
|
|
|
1490
1492
|
Place ExpansionPanel elements as children. When isSingleOpen is true, expanding one panel automatically collapses others in the group.
|
|
1491
1493
|
|
|
1492
|
-
Catalog key: `ExpansionPanelGroup`
|
|
1493
|
-
Builder: `ExpansionPanelGroup`
|
|
1494
|
-
Props type: `ExpansionPanelGroupProps`
|
|
1495
|
-
Accepts children: yes
|
|
1494
|
+
Catalog key: `ExpansionPanelGroup`
|
|
1495
|
+
Builder: `ExpansionPanelGroup`
|
|
1496
|
+
Props type: `ExpansionPanelGroupProps`
|
|
1497
|
+
Accepts children: yes
|
|
1496
1498
|
Events: _none_
|
|
1497
1499
|
|
|
1498
1500
|
### Props
|
|
@@ -1509,17 +1511,17 @@ A layout wrapper that provides consistent structure around form inputs, includin
|
|
|
1509
1511
|
|
|
1510
1512
|
Field is a layout wrapper for form inputs. Place the actual input component as a child. helperMessage can be a plain string or an object { message, status } where status "ERROR" shows the message as an error.
|
|
1511
1513
|
|
|
1512
|
-
Catalog key: `Field`
|
|
1513
|
-
Builder: `Field`
|
|
1514
|
-
Props type: `FieldProps`
|
|
1515
|
-
Accepts children: yes
|
|
1514
|
+
Catalog key: `Field`
|
|
1515
|
+
Builder: `Field`
|
|
1516
|
+
Props type: `FieldProps`
|
|
1517
|
+
Accepts children: yes
|
|
1516
1518
|
Events: _none_
|
|
1517
1519
|
|
|
1518
1520
|
### Props
|
|
1519
1521
|
|
|
1520
1522
|
| Name | Required | Type | Description |
|
|
1521
1523
|
|---|---:|---|---|
|
|
1522
|
-
| `helperMessage` | no |
|
|
1524
|
+
| `helperMessage` | no | string \| [HelperMessage](./types.md#helpermessage) | Helper text below the field, or object with message and status |
|
|
1523
1525
|
| `isHiddenInput` | no | boolean | Hides the input portion of the field |
|
|
1524
1526
|
| `isInline` | no | boolean | Renders label and input on the same line |
|
|
1525
1527
|
| `isReadOnly` | no | boolean | Renders the field in read-only mode |
|
|
@@ -1536,10 +1538,10 @@ A compact file upload input for selecting one or more files via browse or drag-a
|
|
|
1536
1538
|
|
|
1537
1539
|
supportTypes accepts file extensions like [".pdf", ".jpg"]. Use Input.File.SUPPORTED_TYPES presets like IMAGES, DOCUMENTS, etc. for common groups. The change event fires when files are selected or removed.
|
|
1538
1540
|
|
|
1539
|
-
Catalog key: `File`
|
|
1540
|
-
Builder: `File`
|
|
1541
|
-
Props type: `FileProps`
|
|
1542
|
-
Accepts children: no
|
|
1541
|
+
Catalog key: `File`
|
|
1542
|
+
Builder: `File`
|
|
1543
|
+
Props type: `FileProps`
|
|
1544
|
+
Accepts children: no
|
|
1543
1545
|
Events: `change`, `delete`
|
|
1544
1546
|
|
|
1545
1547
|
### Props
|
|
@@ -1567,10 +1569,10 @@ A file upload input that allows users to drag and drop files into a drop zone or
|
|
|
1567
1569
|
|
|
1568
1570
|
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. When multiple is false, only one file is stored.
|
|
1569
1571
|
|
|
1570
|
-
Catalog key: `FileDrop`
|
|
1571
|
-
Builder: `FileDrop`
|
|
1572
|
-
Props type: `FileDropProps`
|
|
1573
|
-
Accepts children: no
|
|
1572
|
+
Catalog key: `FileDrop`
|
|
1573
|
+
Builder: `FileDrop`
|
|
1574
|
+
Props type: `FileDropProps`
|
|
1575
|
+
Accepts children: no
|
|
1574
1576
|
Events: `change`, `blur`
|
|
1575
1577
|
|
|
1576
1578
|
### Props
|
|
@@ -1626,10 +1628,10 @@ A floating action button (FAB) that highlights the primary action on a screen, s
|
|
|
1626
1628
|
**Spinner behavior:**
|
|
1627
1629
|
- When shouldShowSpinner is true, spinner replaces icon regardless of icon prop
|
|
1628
1630
|
|
|
1629
|
-
Catalog key: `FloatingButton`
|
|
1630
|
-
Builder: `FloatingButton`
|
|
1631
|
-
Props type: `FloatingButtonProps`
|
|
1632
|
-
Accepts children: no
|
|
1631
|
+
Catalog key: `FloatingButton`
|
|
1632
|
+
Builder: `FloatingButton`
|
|
1633
|
+
Props type: `FloatingButtonProps`
|
|
1634
|
+
Accepts children: no
|
|
1633
1635
|
Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
|
|
1634
1636
|
|
|
1635
1637
|
### Props
|
|
@@ -1639,11 +1641,11 @@ Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
|
|
|
1639
1641
|
| `aria-controls` | no | string | ID of element controlled by the button |
|
|
1640
1642
|
| `aria-describedby` | no | string | ID of element that describes the button |
|
|
1641
1643
|
| `aria-expanded` | no | boolean | Indicates expanded state (for toggles) |
|
|
1642
|
-
| `aria-haspopup` | no |
|
|
1644
|
+
| `aria-haspopup` | no | boolean \| string | Indicates the button opens a popup/menu |
|
|
1643
1645
|
| `aria-label` | no | string | Accessible label for the button. Required if aria-labelledby is not provided. |
|
|
1644
1646
|
| `aria-labelledby` | no | string | ID of element that labels the button. Required if aria-label is not provided. |
|
|
1645
|
-
| `aria-pressed` | no |
|
|
1646
|
-
| `icon` | yes |
|
|
1647
|
+
| `aria-pressed` | no | boolean \| "mixed" | Indicates pressed state (for toggle buttons) |
|
|
1648
|
+
| `icon` | yes | string \| [FloatingButtonIcon](./types.md#floatingbuttonicon) | Icon to display. Can be icon name string or object with type and color |
|
|
1647
1649
|
| `id` | no | string | DOM id selector for the button element |
|
|
1648
1650
|
| `inverseDisabledColors` | no | boolean | Uses inverse color tokens for disabled state. Useful for dark backgrounds. Default: false |
|
|
1649
1651
|
| `isDisabled` | no | boolean | If true, button is disabled. Default: false |
|
|
@@ -1652,8 +1654,8 @@ Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
|
|
|
1652
1654
|
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Size of the button (XS, S, M, L). Default: M |
|
|
1653
1655
|
| `tabIndex` | no | number | Tab order for keyboard navigation |
|
|
1654
1656
|
| `testId` | no | string | Sets data-testid attribute. Default: "button" |
|
|
1655
|
-
| `tip` | no |
|
|
1656
|
-
| `to` | no |
|
|
1657
|
+
| `tip` | no | string \| [FloatingButtonTip](./types.md#floatingbuttontip) | Tooltip text or tooltip configuration object |
|
|
1658
|
+
| `to` | no | string \| [FloatingButtonTo](./types.md#floatingbuttonto) | Navigation destination. When provided, button renders as anchor and handles navigation automatically |
|
|
1657
1659
|
| `type` | no | [FloatingButtonType](./definitions.md#floatingbuttontype) | HTML button type attribute (button, submit, reset). Default: button |
|
|
1658
1660
|
|
|
1659
1661
|
No additional properties.
|
|
@@ -1674,10 +1676,10 @@ Two binding surfaces (independent — use either, both, or neither):
|
|
|
1674
1676
|
|
|
1675
1677
|
External `validationErrors` merge with input-reported errors; clear an error by writing a falsy value to that key.
|
|
1676
1678
|
|
|
1677
|
-
Catalog key: `Form`
|
|
1678
|
-
Builder: `Form`
|
|
1679
|
-
Props type: `FormProps`
|
|
1680
|
-
Accepts children: yes
|
|
1679
|
+
Catalog key: `Form`
|
|
1680
|
+
Builder: `Form`
|
|
1681
|
+
Props type: `FormProps`
|
|
1682
|
+
Accepts children: yes
|
|
1681
1683
|
Events: `change`, `submit`, `valid`, `invalid`, `cancel`, `edit`
|
|
1682
1684
|
|
|
1683
1685
|
### Props
|
|
@@ -1706,7 +1708,7 @@ Events: `change`, `submit`, `valid`, `invalid`, `cancel`, `edit`
|
|
|
1706
1708
|
| `title` | no | string | Form title shown in header |
|
|
1707
1709
|
| `validationErrors` | no | [FormValidationError](./types.md#formvalidationerror) | External validation errors keyed by input name |
|
|
1708
1710
|
| `values` | no | [FormValue](./types.md#formvalue) | Form values model. Written to state on change/submit (read-only — push-only) |
|
|
1709
|
-
| `width` | no |
|
|
1711
|
+
| `width` | no | number \| string | Custom form container width (applies only to settings forms) |
|
|
1710
1712
|
|
|
1711
1713
|
No additional properties.
|
|
1712
1714
|
|
|
@@ -1720,10 +1722,10 @@ Use `defaultValue: true` to pre-check the box.
|
|
|
1720
1722
|
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" }`.
|
|
1721
1723
|
onChange emits "change".
|
|
1722
1724
|
|
|
1723
|
-
Catalog key: `FormCheckbox`
|
|
1724
|
-
Builder: `FormCheckbox`
|
|
1725
|
-
Props type: `FormCheckboxProps`
|
|
1726
|
-
Accepts children: no
|
|
1725
|
+
Catalog key: `FormCheckbox`
|
|
1726
|
+
Builder: `FormCheckbox`
|
|
1727
|
+
Props type: `FormCheckboxProps`
|
|
1728
|
+
Accepts children: no
|
|
1727
1729
|
Events: `change`
|
|
1728
1730
|
|
|
1729
1731
|
### Props
|
|
@@ -1756,10 +1758,10 @@ Uses Form.Input.Checkbox.Group internally — the Form-aware variant of Checkbox
|
|
|
1756
1758
|
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" }`.
|
|
1757
1759
|
onChange emits "change".
|
|
1758
1760
|
|
|
1759
|
-
Catalog key: `FormCheckboxGroup`
|
|
1760
|
-
Builder: `FormCheckboxGroup`
|
|
1761
|
-
Props type: `FormCheckboxGroupProps`
|
|
1762
|
-
Accepts children: no
|
|
1761
|
+
Catalog key: `FormCheckboxGroup`
|
|
1762
|
+
Builder: `FormCheckboxGroup`
|
|
1763
|
+
Props type: `FormCheckboxGroupProps`
|
|
1764
|
+
Accepts children: no
|
|
1763
1765
|
Events: `change`
|
|
1764
1766
|
|
|
1765
1767
|
### Props
|
|
@@ -1790,10 +1792,10 @@ Maps to Pebble `Form.Content`.
|
|
|
1790
1792
|
Use inside `Form` when adding explanatory text, helper content, or custom UI that should align with the form field column.
|
|
1791
1793
|
`isFluid` overrides the parent Form fluid layout for this content block.
|
|
1792
1794
|
|
|
1793
|
-
Catalog key: `FormContent`
|
|
1794
|
-
Builder: `FormContent`
|
|
1795
|
-
Props type: `FormContentProps`
|
|
1796
|
-
Accepts children: yes
|
|
1795
|
+
Catalog key: `FormContent`
|
|
1796
|
+
Builder: `FormContent`
|
|
1797
|
+
Props type: `FormContentProps`
|
|
1798
|
+
Accepts children: yes
|
|
1797
1799
|
Events: _none_
|
|
1798
1800
|
|
|
1799
1801
|
### Props
|
|
@@ -1816,10 +1818,10 @@ Set `allowNegative: false` to restrict to non-negative values.
|
|
|
1816
1818
|
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" }`.
|
|
1817
1819
|
onChange emits "change"; onBlur emits "blur".
|
|
1818
1820
|
|
|
1819
|
-
Catalog key: `FormCurrency`
|
|
1820
|
-
Builder: `FormCurrency`
|
|
1821
|
-
Props type: `FormCurrencyProps`
|
|
1822
|
-
Accepts children: no
|
|
1821
|
+
Catalog key: `FormCurrency`
|
|
1822
|
+
Builder: `FormCurrency`
|
|
1823
|
+
Props type: `FormCurrencyProps`
|
|
1824
|
+
Accepts children: no
|
|
1823
1825
|
Events: `change`, `blur`
|
|
1824
1826
|
|
|
1825
1827
|
### Props
|
|
@@ -1851,10 +1853,10 @@ Always supply defaultValue as a yyyy-MM-dd string regardless of the display form
|
|
|
1851
1853
|
Bind `value` with `{ $bindState: "/path" }` to initialize the date picker from state and keep state in sync. Reads initial value from state (controlled); access current date in on.change actions via `{ $state: "/path" }`.
|
|
1852
1854
|
onChange emits "change".
|
|
1853
1855
|
|
|
1854
|
-
Catalog key: `FormDate`
|
|
1855
|
-
Builder: `FormDate`
|
|
1856
|
-
Props type: `FormDateProps`
|
|
1857
|
-
Accepts children: no
|
|
1856
|
+
Catalog key: `FormDate`
|
|
1857
|
+
Builder: `FormDate`
|
|
1858
|
+
Props type: `FormDateProps`
|
|
1859
|
+
Accepts children: no
|
|
1858
1860
|
Events: `change`
|
|
1859
1861
|
|
|
1860
1862
|
### Props
|
|
@@ -1891,10 +1893,10 @@ Stores an array of two date strings [startDate, endDate] keyed by `name` in the
|
|
|
1891
1893
|
Bind `value` with `{ $bindState: "/path" }` to initialize the range picker from state and keep state in sync.
|
|
1892
1894
|
onChange emits "change".
|
|
1893
1895
|
|
|
1894
|
-
Catalog key: `FormDateRange`
|
|
1895
|
-
Builder: `FormDateRange`
|
|
1896
|
-
Props type: `FormDateRangeProps`
|
|
1897
|
-
Accepts children: no
|
|
1896
|
+
Catalog key: `FormDateRange`
|
|
1897
|
+
Builder: `FormDateRange`
|
|
1898
|
+
Props type: `FormDateRangeProps`
|
|
1899
|
+
Accepts children: no
|
|
1898
1900
|
Events: `change`
|
|
1899
1901
|
|
|
1900
1902
|
### Props
|
|
@@ -1943,10 +1945,10 @@ Values flow through the parent Form's `values` push-binding on submit/change.
|
|
|
1943
1945
|
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" }`.
|
|
1944
1946
|
onChange emits "change". DaySelector has no onBlur event.
|
|
1945
1947
|
|
|
1946
|
-
Catalog key: `FormDaySelector`
|
|
1947
|
-
Builder: `FormDaySelector`
|
|
1948
|
-
Props type: `FormDaySelectorProps`
|
|
1949
|
-
Accepts children: no
|
|
1948
|
+
Catalog key: `FormDaySelector`
|
|
1949
|
+
Builder: `FormDaySelector`
|
|
1950
|
+
Props type: `FormDaySelectorProps`
|
|
1951
|
+
Accepts children: no
|
|
1950
1952
|
Events: `change`
|
|
1951
1953
|
|
|
1952
1954
|
### Props
|
|
@@ -1954,7 +1956,7 @@ Events: `change`
|
|
|
1954
1956
|
| Name | Required | Type | Description |
|
|
1955
1957
|
|---|---:|---|---|
|
|
1956
1958
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
1957
|
-
| `defaultValue` | no |
|
|
1959
|
+
| `defaultValue` | no | [DaySelectorDefaultValue](./definitions.md#dayselectordefaultvalue) \| [DaySelectorDefaultValue](./definitions.md#dayselectordefaultvalue)[] | Initial day(s) when uncontrolled |
|
|
1958
1960
|
| `isDisabled` | no | boolean | Disables the input |
|
|
1959
1961
|
| `isMulti` | no | boolean | Allow multiple day selection. Default: false |
|
|
1960
1962
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -1976,10 +1978,10 @@ Values flow through the parent Form's `values` push-binding on submit/change.
|
|
|
1976
1978
|
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" }`.
|
|
1977
1979
|
onChange emits "change"; onBlur emits "blur".
|
|
1978
1980
|
|
|
1979
|
-
Catalog key: `FormEmail`
|
|
1980
|
-
Builder: `FormEmail`
|
|
1981
|
-
Props type: `FormEmailProps`
|
|
1982
|
-
Accepts children: no
|
|
1981
|
+
Catalog key: `FormEmail`
|
|
1982
|
+
Builder: `FormEmail`
|
|
1983
|
+
Props type: `FormEmailProps`
|
|
1984
|
+
Accepts children: no
|
|
1983
1985
|
Events: `change`, `blur`
|
|
1984
1986
|
|
|
1985
1987
|
### Props
|
|
@@ -2014,10 +2016,10 @@ Bind `value` with `{ $bindState: "/path" }` to initialize the input from state a
|
|
|
2014
2016
|
onChange emits "change"; onBlur emits "blur".
|
|
2015
2017
|
supportTypes expects file extensions with dot prefix, e.g. [".pdf", ".png", ".jpg"]. Do NOT use MIME types.
|
|
2016
2018
|
|
|
2017
|
-
Catalog key: `FormFile`
|
|
2018
|
-
Builder: `FormFile`
|
|
2019
|
-
Props type: `FormFileProps`
|
|
2020
|
-
Accepts children: no
|
|
2019
|
+
Catalog key: `FormFile`
|
|
2020
|
+
Builder: `FormFile`
|
|
2021
|
+
Props type: `FormFileProps`
|
|
2022
|
+
Accepts children: no
|
|
2021
2023
|
Events: `change`, `blur`
|
|
2022
2024
|
|
|
2023
2025
|
### Props
|
|
@@ -2059,10 +2061,10 @@ Bind `value` with `{ $bindState: "/path" }` to initialize the input from state a
|
|
|
2059
2061
|
onChange emits "change"; onBlur emits "blur".
|
|
2060
2062
|
supportTypes expects file extensions with dot prefix, e.g. [".pdf", ".png", ".jpg"]. Do NOT use MIME types.
|
|
2061
2063
|
|
|
2062
|
-
Catalog key: `FormFileDrop`
|
|
2063
|
-
Builder: `FormFileDrop`
|
|
2064
|
-
Props type: `FormFileDropProps`
|
|
2065
|
-
Accepts children: no
|
|
2064
|
+
Catalog key: `FormFileDrop`
|
|
2065
|
+
Builder: `FormFileDrop`
|
|
2066
|
+
Props type: `FormFileDropProps`
|
|
2067
|
+
Accepts children: no
|
|
2066
2068
|
Events: `change`, `blur`
|
|
2067
2069
|
|
|
2068
2070
|
### Props
|
|
@@ -2101,10 +2103,10 @@ Maps to Pebble `Form.Group`.
|
|
|
2101
2103
|
Use inside `Form` to divide long forms into titled subsections.
|
|
2102
2104
|
Requires children; Pebble `Form.Group` renders nothing when empty.
|
|
2103
2105
|
|
|
2104
|
-
Catalog key: `FormGroup`
|
|
2105
|
-
Builder: `FormGroup`
|
|
2106
|
-
Props type: `FormGroupProps`
|
|
2107
|
-
Accepts children: yes
|
|
2106
|
+
Catalog key: `FormGroup`
|
|
2107
|
+
Builder: `FormGroup`
|
|
2108
|
+
Props type: `FormGroupProps`
|
|
2109
|
+
Accepts children: yes
|
|
2108
2110
|
Events: _none_
|
|
2109
2111
|
|
|
2110
2112
|
### Props
|
|
@@ -2125,10 +2127,10 @@ Maps to deprecated Pebble `Form.GroupHeader`.
|
|
|
2125
2127
|
Prefer `FormGroup` unless preserving legacy layout semantics is required.
|
|
2126
2128
|
Renders nothing when both `title` and `caption` are omitted.
|
|
2127
2129
|
|
|
2128
|
-
Catalog key: `FormGroupHeader`
|
|
2129
|
-
Builder: `FormGroupHeader`
|
|
2130
|
-
Props type: `FormGroupHeaderProps`
|
|
2131
|
-
Accepts children: no
|
|
2130
|
+
Catalog key: `FormGroupHeader`
|
|
2131
|
+
Builder: `FormGroupHeader`
|
|
2132
|
+
Props type: `FormGroupHeaderProps`
|
|
2133
|
+
Accepts children: no
|
|
2132
2134
|
Events: _none_
|
|
2133
2135
|
|
|
2134
2136
|
### Props
|
|
@@ -2147,10 +2149,10 @@ A Form-registered hidden field for use inside a Form. Renders no UI — use to i
|
|
|
2147
2149
|
|
|
2148
2150
|
Renders nothing — registers a hidden Form field. Use to inject computed values into the Form submit payload.
|
|
2149
2151
|
|
|
2150
|
-
Catalog key: `FormHidden`
|
|
2151
|
-
Builder: `FormHidden`
|
|
2152
|
-
Props type: `FormHiddenProps`
|
|
2153
|
-
Accepts children: no
|
|
2152
|
+
Catalog key: `FormHidden`
|
|
2153
|
+
Builder: `FormHidden`
|
|
2154
|
+
Props type: `FormHiddenProps`
|
|
2155
|
+
Accepts children: no
|
|
2154
2156
|
Events: _none_
|
|
2155
2157
|
|
|
2156
2158
|
### Props
|
|
@@ -2171,10 +2173,10 @@ Use inside non-settings Forms to place related fields in one row.
|
|
|
2171
2173
|
When `customChildWidths` is provided, the number of widths must equal the number of valid child elements and sum to 100%.
|
|
2172
2174
|
In inline-label/settings forms, Pebble renders children without the inline-group grid layout.
|
|
2173
2175
|
|
|
2174
|
-
Catalog key: `FormInlineGroup`
|
|
2175
|
-
Builder: `FormInlineGroup`
|
|
2176
|
-
Props type: `FormInlineGroupProps`
|
|
2177
|
-
Accepts children: yes
|
|
2176
|
+
Catalog key: `FormInlineGroup`
|
|
2177
|
+
Builder: `FormInlineGroup`
|
|
2178
|
+
Props type: `FormInlineGroupProps`
|
|
2179
|
+
Accepts children: yes
|
|
2178
2180
|
Events: _none_
|
|
2179
2181
|
|
|
2180
2182
|
### Props
|
|
@@ -2199,10 +2201,10 @@ The wrapper injects Form value handlers and defaults `input.inputProps.name` fro
|
|
|
2199
2201
|
Set `hasSeparateFormControls` to true when prefix/suffix configs should register their own form values.
|
|
2200
2202
|
onChange emits "change" for changes from the main input.
|
|
2201
2203
|
|
|
2202
|
-
Catalog key: `FormInputGroup`
|
|
2203
|
-
Builder: `FormInputGroup`
|
|
2204
|
-
Props type: `FormInputGroupProps`
|
|
2205
|
-
Accepts children: no
|
|
2204
|
+
Catalog key: `FormInputGroup`
|
|
2205
|
+
Builder: `FormInputGroup`
|
|
2206
|
+
Props type: `FormInputGroupProps`
|
|
2207
|
+
Accepts children: no
|
|
2206
2208
|
Events: `change`
|
|
2207
2209
|
|
|
2208
2210
|
### Props
|
|
@@ -2217,14 +2219,14 @@ Events: `change`
|
|
|
2217
2219
|
| `isReadOnly` | no | boolean | Makes all inputs in the group read-only |
|
|
2218
2220
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
2219
2221
|
| `label` | no | string | Label text shown by the Form field wrapper |
|
|
2220
|
-
| `prefix` | no |
|
|
2222
|
+
| `prefix` | no | [FormInputGroupPrefix](./types.md#forminputgroupprefix) \| [FormInputGroupPrefix](./types.md#forminputgroupprefix)[] | Prefix input configuration(s) prepended to the main input |
|
|
2221
2223
|
| `prefixMaxWidthPercent` | no | number | Max width percentage for the prefix container |
|
|
2222
|
-
| `prefixMinWidth` | no |
|
|
2224
|
+
| `prefixMinWidth` | no | number \| string | Minimum width for the prefix container |
|
|
2223
2225
|
| `shouldHideAddons` | no | boolean | Hides prefix/suffix without destroying them |
|
|
2224
2226
|
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Size of all inputs in the group. Default: M |
|
|
2225
|
-
| `suffix` | no |
|
|
2227
|
+
| `suffix` | no | [FormInputGroupSuffix](./types.md#forminputgroupsuffix) \| [FormInputGroupSuffix](./types.md#forminputgroupsuffix)[] | Suffix input configuration(s) appended to the main input |
|
|
2226
2228
|
| `suffixMaxWidthPercent` | no | number | Max width percentage for the suffix container |
|
|
2227
|
-
| `suffixMinWidth` | no |
|
|
2229
|
+
| `suffixMinWidth` | no | number \| string | Minimum width for the suffix container |
|
|
2228
2230
|
| `tip` | no | string | Tooltip text shown alongside the field label |
|
|
2229
2231
|
| `validationErrors` | no | [FormInputGroupValidationError](./types.md#forminputgroupvalidationerror) | Map of rule name to error message |
|
|
2230
2232
|
| `validations` | no | string | Comma-separated Form rule string example: "isEmail,minLength:5" |
|
|
@@ -2241,10 +2243,10 @@ Mask characters: 9 = digit, a = letter, * = any character.
|
|
|
2241
2243
|
Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
|
|
2242
2244
|
onChange emits "change"; onBlur emits "blur".
|
|
2243
2245
|
|
|
2244
|
-
Catalog key: `FormMasker`
|
|
2245
|
-
Builder: `FormMasker`
|
|
2246
|
-
Props type: `FormMaskerProps`
|
|
2247
|
-
Accepts children: no
|
|
2246
|
+
Catalog key: `FormMasker`
|
|
2247
|
+
Builder: `FormMasker`
|
|
2248
|
+
Props type: `FormMaskerProps`
|
|
2249
|
+
Accepts children: no
|
|
2248
2250
|
Events: `change`, `blur`
|
|
2249
2251
|
|
|
2250
2252
|
### Props
|
|
@@ -2264,7 +2266,7 @@ Events: `change`, `blur`
|
|
|
2264
2266
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
2265
2267
|
| `isSensitive` | no | boolean | Marks input as sensitive for privacy/security |
|
|
2266
2268
|
| `label` | no | string | Label text above the input |
|
|
2267
|
-
| `mask` | yes |
|
|
2269
|
+
| `mask` | yes | string \| string[] | Mask pattern. Use 9 for digit, a for letter, * for any character. Can be string ("999-999-9999") or array of patterns (["99.9a-999", "99.99/99-9"]) for multi-mask support |
|
|
2268
2270
|
| `maxLength` | no | number | Maximum character length |
|
|
2269
2271
|
| `maxWidth` | no | string | Maximum width CSS value |
|
|
2270
2272
|
| `minLength` | no | number | Minimum character length |
|
|
@@ -2289,10 +2291,10 @@ Values flow through the parent Form's `values` push-binding on submit/change.
|
|
|
2289
2291
|
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" }`.
|
|
2290
2292
|
onChange emits "change"; onBlur emits "blur".
|
|
2291
2293
|
|
|
2292
|
-
Catalog key: `FormNumber`
|
|
2293
|
-
Builder: `FormNumber`
|
|
2294
|
-
Props type: `FormNumberProps`
|
|
2295
|
-
Accepts children: no
|
|
2294
|
+
Catalog key: `FormNumber`
|
|
2295
|
+
Builder: `FormNumber`
|
|
2296
|
+
Props type: `FormNumberProps`
|
|
2297
|
+
Accepts children: no
|
|
2296
2298
|
Events: `change`, `blur`
|
|
2297
2299
|
|
|
2298
2300
|
### Props
|
|
@@ -2301,7 +2303,7 @@ Events: `change`, `blur`
|
|
|
2301
2303
|
|---|---:|---|---|
|
|
2302
2304
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
2303
2305
|
| `decimalPlaces` | no | number | Number of decimal places. Default: 2 |
|
|
2304
|
-
| `defaultValue` | no |
|
|
2306
|
+
| `defaultValue` | no | string \| number | Initial default value for uncontrolled usage |
|
|
2305
2307
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2306
2308
|
| `isIntegerOnly` | no | boolean | Restrict to integer values only |
|
|
2307
2309
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -2318,7 +2320,7 @@ Events: `change`, `blur`
|
|
|
2318
2320
|
| `tip` | no | string | Tooltip text shown alongside the field label |
|
|
2319
2321
|
| `validationErrors` | no | [FormNumberValidationError](./types.md#formnumbervalidationerror) | Map of rule name to error message |
|
|
2320
2322
|
| `validations` | no | string | Comma-separated Form rule string example: "isEmail,minLength:5" |
|
|
2321
|
-
| `value` | no |
|
|
2323
|
+
| `value` | no | string \| number | Current value bound to state |
|
|
2322
2324
|
|
|
2323
2325
|
No additional properties.
|
|
2324
2326
|
|
|
@@ -2332,10 +2334,10 @@ Values flow through the parent Form's `values` push-binding on submit/change.
|
|
|
2332
2334
|
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" }`.
|
|
2333
2335
|
onChange emits "change"; onBlur emits "blur".
|
|
2334
2336
|
|
|
2335
|
-
Catalog key: `FormPassword`
|
|
2336
|
-
Builder: `FormPassword`
|
|
2337
|
-
Props type: `FormPasswordProps`
|
|
2338
|
-
Accepts children: no
|
|
2337
|
+
Catalog key: `FormPassword`
|
|
2338
|
+
Builder: `FormPassword`
|
|
2339
|
+
Props type: `FormPasswordProps`
|
|
2340
|
+
Accepts children: no
|
|
2339
2341
|
Events: `change`, `blur`
|
|
2340
2342
|
|
|
2341
2343
|
### Props
|
|
@@ -2369,10 +2371,10 @@ Set `allowNegative: true` to permit negative percentages.
|
|
|
2369
2371
|
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" }`.
|
|
2370
2372
|
onChange emits "change"; onBlur emits "blur".
|
|
2371
2373
|
|
|
2372
|
-
Catalog key: `FormPercentage`
|
|
2373
|
-
Builder: `FormPercentage`
|
|
2374
|
-
Props type: `FormPercentageProps`
|
|
2375
|
-
Accepts children: no
|
|
2374
|
+
Catalog key: `FormPercentage`
|
|
2375
|
+
Builder: `FormPercentage`
|
|
2376
|
+
Props type: `FormPercentageProps`
|
|
2377
|
+
Accepts children: no
|
|
2376
2378
|
Events: `change`, `blur`
|
|
2377
2379
|
|
|
2378
2380
|
### Props
|
|
@@ -2394,7 +2396,7 @@ Events: `change`, `blur`
|
|
|
2394
2396
|
| `upperLimit` | no | number | Maximum allowed percentage value. Default: 100 |
|
|
2395
2397
|
| `validationErrors` | no | [FormPercentageValidationError](./types.md#formpercentagevalidationerror) | Map of rule name to error message |
|
|
2396
2398
|
| `validations` | no | string | Comma-separated Form rule string example: "isEmail,minLength:5" |
|
|
2397
|
-
| `value` | no |
|
|
2399
|
+
| `value` | no | string \| number | Current value bound to state |
|
|
2398
2400
|
|
|
2399
2401
|
No additional properties.
|
|
2400
2402
|
|
|
@@ -2408,10 +2410,10 @@ Use defaultRegion to set the formatting region (US, IN, CA, etc.). Defaults to U
|
|
|
2408
2410
|
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" }`.
|
|
2409
2411
|
onChange emits "change"; onBlur emits "blur".
|
|
2410
2412
|
|
|
2411
|
-
Catalog key: `FormPhone`
|
|
2412
|
-
Builder: `FormPhone`
|
|
2413
|
-
Props type: `FormPhoneProps`
|
|
2414
|
-
Accepts children: no
|
|
2413
|
+
Catalog key: `FormPhone`
|
|
2414
|
+
Builder: `FormPhone`
|
|
2415
|
+
Props type: `FormPhoneProps`
|
|
2416
|
+
Accepts children: no
|
|
2415
2417
|
Events: `change`, `blur`
|
|
2416
2418
|
|
|
2417
2419
|
### Props
|
|
@@ -2445,10 +2447,10 @@ Stores the selected option's `value` keyed by `name` in the parent Form's values
|
|
|
2445
2447
|
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" }`.
|
|
2446
2448
|
onChange emits "change".
|
|
2447
2449
|
|
|
2448
|
-
Catalog key: `FormRadio`
|
|
2449
|
-
Builder: `FormRadio`
|
|
2450
|
-
Props type: `FormRadioProps`
|
|
2451
|
-
Accepts children: no
|
|
2450
|
+
Catalog key: `FormRadio`
|
|
2451
|
+
Builder: `FormRadio`
|
|
2452
|
+
Props type: `FormRadioProps`
|
|
2453
|
+
Accepts children: no
|
|
2452
2454
|
Events: `change`
|
|
2453
2455
|
|
|
2454
2456
|
### Props
|
|
@@ -2483,10 +2485,10 @@ Use `appearance` to set the visual style: PRIMARY, POSITIVE, NEGATIVE, or NEUTRA
|
|
|
2483
2485
|
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" }`.
|
|
2484
2486
|
onChange emits "change". SegmentedControl has no onBlur event.
|
|
2485
2487
|
|
|
2486
|
-
Catalog key: `FormSegmentedControl`
|
|
2487
|
-
Builder: `FormSegmentedControl`
|
|
2488
|
-
Props type: `FormSegmentedControlProps`
|
|
2489
|
-
Accepts children: no
|
|
2488
|
+
Catalog key: `FormSegmentedControl`
|
|
2489
|
+
Builder: `FormSegmentedControl`
|
|
2490
|
+
Props type: `FormSegmentedControlProps`
|
|
2491
|
+
Accepts children: no
|
|
2490
2492
|
Events: `change`
|
|
2491
2493
|
|
|
2492
2494
|
### Props
|
|
@@ -2495,7 +2497,7 @@ Events: `change`
|
|
|
2495
2497
|
|---|---:|---|---|
|
|
2496
2498
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
2497
2499
|
| `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style variant. Default: PRIMARY |
|
|
2498
|
-
| `defaultValue` | no |
|
|
2500
|
+
| `defaultValue` | no | string \| string[] | Initial value when uncontrolled |
|
|
2499
2501
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2500
2502
|
| `isFluid` | no | boolean | Stretches control to fill container width |
|
|
2501
2503
|
| `isMulti` | no | boolean | Allows selecting multiple options |
|
|
@@ -2521,10 +2523,10 @@ Values flow through the parent Form's `values` push-binding on submit/change.
|
|
|
2521
2523
|
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" }`.
|
|
2522
2524
|
onChange emits "change"; onBlur emits "blur".
|
|
2523
2525
|
|
|
2524
|
-
Catalog key: `FormSelect`
|
|
2525
|
-
Builder: `FormSelect`
|
|
2526
|
-
Props type: `FormSelectProps`
|
|
2527
|
-
Accepts children: no
|
|
2526
|
+
Catalog key: `FormSelect`
|
|
2527
|
+
Builder: `FormSelect`
|
|
2528
|
+
Props type: `FormSelectProps`
|
|
2529
|
+
Accepts children: no
|
|
2528
2530
|
Events: `change`, `blur`
|
|
2529
2531
|
|
|
2530
2532
|
### Props
|
|
@@ -2540,7 +2542,7 @@ Events: `change`, `blur`
|
|
|
2540
2542
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
2541
2543
|
| `isSearchable` | no | boolean | Enable type-to-search filtering |
|
|
2542
2544
|
| `label` | no | string | Label text above the select |
|
|
2543
|
-
| `options` | no |
|
|
2545
|
+
| `options` | no | [FormSelectOption](./types.md#formselectoption)[] \| [FormSelectOption](./types.md#formselectoption)[] | Flat array of {label, value} options, or nested array of {label, list} groups for grouped/submenu options |
|
|
2544
2546
|
| `placeholder` | no | string | Placeholder text when empty |
|
|
2545
2547
|
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Select input size variant. Default: M |
|
|
2546
2548
|
| `tip` | no | string | Tooltip text shown alongside the field label |
|
|
@@ -2559,10 +2561,10 @@ Single-select stores one value; `isMulti` stores an array of selected values.
|
|
|
2559
2561
|
Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
|
|
2560
2562
|
onChange emits "change".
|
|
2561
2563
|
|
|
2562
|
-
Catalog key: `FormSelectableGroup`
|
|
2563
|
-
Builder: `FormSelectableGroup`
|
|
2564
|
-
Props type: `FormSelectableGroupProps`
|
|
2565
|
-
Accepts children: no
|
|
2564
|
+
Catalog key: `FormSelectableGroup`
|
|
2565
|
+
Builder: `FormSelectableGroup`
|
|
2566
|
+
Props type: `FormSelectableGroupProps`
|
|
2567
|
+
Accepts children: no
|
|
2566
2568
|
Events: `change`
|
|
2567
2569
|
|
|
2568
2570
|
### Props
|
|
@@ -2573,7 +2575,7 @@ Events: `change`
|
|
|
2573
2575
|
| `aria-describedby` | no | string | ID of element that describes this input for screen readers |
|
|
2574
2576
|
| `aria-label` | no | string | Accessible label for screen readers |
|
|
2575
2577
|
| `aria-labelledby` | no | string | ID of element that labels this input for screen readers |
|
|
2576
|
-
| `defaultValue` | no |
|
|
2578
|
+
| `defaultValue` | no | string \| number \| string \| number[] | Initial selection when uncontrolled |
|
|
2577
2579
|
| `id` | no | string | Unique DOM id for the input element |
|
|
2578
2580
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2579
2581
|
| `isMulti` | no | boolean | Allow multiple selection. Default: false |
|
|
@@ -2586,7 +2588,7 @@ Events: `change`
|
|
|
2586
2588
|
| `tip` | no | string | Tooltip text shown alongside the field label |
|
|
2587
2589
|
| `validationErrors` | no | [FormSelectableGroupValidationError](./types.md#formselectablegroupvalidationerror) | Map of rule name to error message |
|
|
2588
2590
|
| `validations` | no | string | Comma-separated Form rule string example: "isEmail,minLength:5" |
|
|
2589
|
-
| `value` | no |
|
|
2591
|
+
| `value` | no | string \| number \| string \| number[] | Current value bound to state |
|
|
2590
2592
|
| `valueIdentifier` | no | string | Key name to extract unique value from each list item. Default: "value" |
|
|
2591
2593
|
|
|
2592
2594
|
No additional properties.
|
|
@@ -2600,10 +2602,10 @@ Stores a base64 PNG data URL string keyed by `name` in the parent Form values.
|
|
|
2600
2602
|
Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
|
|
2601
2603
|
onChange emits "change".
|
|
2602
2604
|
|
|
2603
|
-
Catalog key: `FormSignature`
|
|
2604
|
-
Builder: `FormSignature`
|
|
2605
|
-
Props type: `FormSignatureProps`
|
|
2606
|
-
Accepts children: no
|
|
2605
|
+
Catalog key: `FormSignature`
|
|
2606
|
+
Builder: `FormSignature`
|
|
2607
|
+
Props type: `FormSignatureProps`
|
|
2608
|
+
Accepts children: no
|
|
2607
2609
|
Events: `change`
|
|
2608
2610
|
|
|
2609
2611
|
### Props
|
|
@@ -2640,10 +2642,10 @@ The Canadian SIN mask (999 999 999) is applied automatically — no need to conf
|
|
|
2640
2642
|
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" }`.
|
|
2641
2643
|
onChange emits "change"; onBlur emits "blur".
|
|
2642
2644
|
|
|
2643
|
-
Catalog key: `FormSin`
|
|
2644
|
-
Builder: `FormSin`
|
|
2645
|
-
Props type: `FormSinProps`
|
|
2646
|
-
Accepts children: no
|
|
2645
|
+
Catalog key: `FormSin`
|
|
2646
|
+
Builder: `FormSin`
|
|
2647
|
+
Props type: `FormSinProps`
|
|
2648
|
+
Accepts children: no
|
|
2647
2649
|
Events: `change`, `blur`
|
|
2648
2650
|
|
|
2649
2651
|
### Props
|
|
@@ -2678,10 +2680,10 @@ Use `appearance` to set the visual style: PRIMARY, ERROR, SUCCESS, or WARNING.
|
|
|
2678
2680
|
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" }`.
|
|
2679
2681
|
onChange emits "change". Slider has no onBlur event.
|
|
2680
2682
|
|
|
2681
|
-
Catalog key: `FormSlider`
|
|
2682
|
-
Builder: `FormSlider`
|
|
2683
|
-
Props type: `FormSliderProps`
|
|
2684
|
-
Accepts children: no
|
|
2683
|
+
Catalog key: `FormSlider`
|
|
2684
|
+
Builder: `FormSlider`
|
|
2685
|
+
Props type: `FormSliderProps`
|
|
2686
|
+
Accepts children: no
|
|
2685
2687
|
Events: `change`
|
|
2686
2688
|
|
|
2687
2689
|
### Props
|
|
@@ -2717,10 +2719,10 @@ The US SSN mask (999-99-9999) is applied automatically — no need to configure
|
|
|
2717
2719
|
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" }`.
|
|
2718
2720
|
onChange emits "change"; onBlur emits "blur".
|
|
2719
2721
|
|
|
2720
|
-
Catalog key: `FormSsn`
|
|
2721
|
-
Builder: `FormSsn`
|
|
2722
|
-
Props type: `FormSsnProps`
|
|
2723
|
-
Accepts children: no
|
|
2722
|
+
Catalog key: `FormSsn`
|
|
2723
|
+
Builder: `FormSsn`
|
|
2724
|
+
Props type: `FormSsnProps`
|
|
2725
|
+
Accepts children: no
|
|
2724
2726
|
Events: `change`, `blur`
|
|
2725
2727
|
|
|
2726
2728
|
### Props
|
|
@@ -2753,10 +2755,10 @@ Single-select stores one value; `isMulti` stores an array of selected values.
|
|
|
2753
2755
|
Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
|
|
2754
2756
|
onChange emits "change".
|
|
2755
2757
|
|
|
2756
|
-
Catalog key: `FormSurvey`
|
|
2757
|
-
Builder: `FormSurvey`
|
|
2758
|
-
Props type: `FormSurveyProps`
|
|
2759
|
-
Accepts children: no
|
|
2758
|
+
Catalog key: `FormSurvey`
|
|
2759
|
+
Builder: `FormSurvey`
|
|
2760
|
+
Props type: `FormSurveyProps`
|
|
2761
|
+
Accepts children: no
|
|
2760
2762
|
Events: `change`
|
|
2761
2763
|
|
|
2762
2764
|
### Props
|
|
@@ -2765,7 +2767,7 @@ Events: `change`
|
|
|
2765
2767
|
|---|---:|---|---|
|
|
2766
2768
|
| `name` | yes | string | Field name — drives the Form value key inside the parent Form |
|
|
2767
2769
|
| `caption` | no | string | Caption text displayed below the survey |
|
|
2768
|
-
| `defaultValue` | no |
|
|
2770
|
+
| `defaultValue` | no | string \| number \| string \| number[] | Initial selected value(s) set on mount |
|
|
2769
2771
|
| `isDisabled` | no | boolean | Disables the input |
|
|
2770
2772
|
| `isMulti` | no | boolean | Allow multiple selections. Default: false |
|
|
2771
2773
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -2778,7 +2780,7 @@ Events: `change`
|
|
|
2778
2780
|
| `tip` | no | string | Tooltip text shown alongside the field label |
|
|
2779
2781
|
| `validationErrors` | no | [FormSurveyValidationError](./types.md#formsurveyvalidationerror) | Map of rule name to error message |
|
|
2780
2782
|
| `validations` | no | string | Comma-separated Form rule string example: "isEmail,minLength:5" |
|
|
2781
|
-
| `value` | no |
|
|
2783
|
+
| `value` | no | string \| number \| string \| number[] | Current value bound to state |
|
|
2782
2784
|
|
|
2783
2785
|
No additional properties.
|
|
2784
2786
|
|
|
@@ -2793,10 +2795,10 @@ Use `onLabel` and `offLabel` to customize state text.
|
|
|
2793
2795
|
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" }`.
|
|
2794
2796
|
onChange emits "change". Switch has no onBlur event.
|
|
2795
2797
|
|
|
2796
|
-
Catalog key: `FormSwitch`
|
|
2797
|
-
Builder: `FormSwitch`
|
|
2798
|
-
Props type: `FormSwitchProps`
|
|
2799
|
-
Accepts children: no
|
|
2798
|
+
Catalog key: `FormSwitch`
|
|
2799
|
+
Builder: `FormSwitch`
|
|
2800
|
+
Props type: `FormSwitchProps`
|
|
2801
|
+
Accepts children: no
|
|
2800
2802
|
Events: `change`
|
|
2801
2803
|
|
|
2802
2804
|
### Props
|
|
@@ -2831,10 +2833,10 @@ Use `validationErrors` to override default error messages per rule.
|
|
|
2831
2833
|
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" }`.
|
|
2832
2834
|
onChange emits "change"; onBlur emits "blur".
|
|
2833
2835
|
|
|
2834
|
-
Catalog key: `FormText`
|
|
2835
|
-
Builder: `FormText`
|
|
2836
|
-
Props type: `FormTextProps`
|
|
2837
|
-
Accepts children: no
|
|
2836
|
+
Catalog key: `FormText`
|
|
2837
|
+
Builder: `FormText`
|
|
2838
|
+
Props type: `FormTextProps`
|
|
2839
|
+
Accepts children: no
|
|
2838
2840
|
Events: `change`, `blur`
|
|
2839
2841
|
|
|
2840
2842
|
### Props
|
|
@@ -2873,10 +2875,10 @@ Set hasCharsLimit with maxLength to show a character counter.
|
|
|
2873
2875
|
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" }`.
|
|
2874
2876
|
onChange emits "change"; onBlur emits "blur".
|
|
2875
2877
|
|
|
2876
|
-
Catalog key: `FormTextarea`
|
|
2877
|
-
Builder: `FormTextarea`
|
|
2878
|
-
Props type: `FormTextareaProps`
|
|
2879
|
-
Accepts children: no
|
|
2878
|
+
Catalog key: `FormTextarea`
|
|
2879
|
+
Builder: `FormTextarea`
|
|
2880
|
+
Props type: `FormTextareaProps`
|
|
2881
|
+
Accepts children: no
|
|
2880
2882
|
Events: `change`, `blur`
|
|
2881
2883
|
|
|
2882
2884
|
### Props
|
|
@@ -2914,10 +2916,10 @@ Use `shouldShowMenuOnFocus: true` to open the dropdown immediately on focus.
|
|
|
2914
2916
|
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" }`.
|
|
2915
2917
|
onChange emits "change"; onBlur emits "blur".
|
|
2916
2918
|
|
|
2917
|
-
Catalog key: `FormTextAutoSuggest`
|
|
2918
|
-
Builder: `FormTextAutoSuggest`
|
|
2919
|
-
Props type: `FormTextAutoSuggestProps`
|
|
2920
|
-
Accepts children: no
|
|
2919
|
+
Catalog key: `FormTextAutoSuggest`
|
|
2920
|
+
Builder: `FormTextAutoSuggest`
|
|
2921
|
+
Props type: `FormTextAutoSuggestProps`
|
|
2922
|
+
Accepts children: no
|
|
2921
2923
|
Events: `change`, `blur`
|
|
2922
2924
|
|
|
2923
2925
|
### Props
|
|
@@ -2953,10 +2955,10 @@ Set shouldAllowTimeSelection to true to show a time picker dropdown.
|
|
|
2953
2955
|
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" }`.
|
|
2954
2956
|
onChange emits "change"; onBlur emits "blur".
|
|
2955
2957
|
|
|
2956
|
-
Catalog key: `FormTime`
|
|
2957
|
-
Builder: `FormTime`
|
|
2958
|
-
Props type: `FormTimeProps`
|
|
2959
|
-
Accepts children: no
|
|
2958
|
+
Catalog key: `FormTime`
|
|
2959
|
+
Builder: `FormTime`
|
|
2960
|
+
Props type: `FormTimeProps`
|
|
2961
|
+
Accepts children: no
|
|
2960
2962
|
Events: `change`, `blur`
|
|
2961
2963
|
|
|
2962
2964
|
### Props
|
|
@@ -2990,10 +2992,10 @@ Stores an IANA timezone identifier string keyed by `name` in the parent Form val
|
|
|
2990
2992
|
Bind `value` with `{ $bindState: "/path" }` to initialize the input from state and keep state in sync.
|
|
2991
2993
|
onChange emits "change"; onBlur emits "blur"; onFocus emits "focus".
|
|
2992
2994
|
|
|
2993
|
-
Catalog key: `FormTimezone`
|
|
2994
|
-
Builder: `FormTimezone`
|
|
2995
|
-
Props type: `FormTimezoneProps`
|
|
2996
|
-
Accepts children: no
|
|
2995
|
+
Catalog key: `FormTimezone`
|
|
2996
|
+
Builder: `FormTimezone`
|
|
2997
|
+
Props type: `FormTimezoneProps`
|
|
2998
|
+
Accepts children: no
|
|
2997
2999
|
Events: `change`, `blur`, `focus`
|
|
2998
3000
|
|
|
2999
3001
|
### Props
|
|
@@ -3038,10 +3040,10 @@ Use isSearchable to enable filtering of tree nodes.
|
|
|
3038
3040
|
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" }`.
|
|
3039
3041
|
onChange emits "change".
|
|
3040
3042
|
|
|
3041
|
-
Catalog key: `FormTree`
|
|
3042
|
-
Builder: `FormTree`
|
|
3043
|
-
Props type: `FormTreeProps`
|
|
3044
|
-
Accepts children: no
|
|
3043
|
+
Catalog key: `FormTree`
|
|
3044
|
+
Builder: `FormTree`
|
|
3045
|
+
Props type: `FormTreeProps`
|
|
3046
|
+
Accepts children: no
|
|
3045
3047
|
Events: `change`
|
|
3046
3048
|
|
|
3047
3049
|
### Props
|
|
@@ -3087,10 +3089,10 @@ Use shouldShowSelectionPath to display the full ancestor path in chips for multi
|
|
|
3087
3089
|
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" }`.
|
|
3088
3090
|
onChange emits "change".
|
|
3089
3091
|
|
|
3090
|
-
Catalog key: `FormTreeSelect`
|
|
3091
|
-
Builder: `FormTreeSelect`
|
|
3092
|
-
Props type: `FormTreeSelectProps`
|
|
3093
|
-
Accepts children: no
|
|
3092
|
+
Catalog key: `FormTreeSelect`
|
|
3093
|
+
Builder: `FormTreeSelect`
|
|
3094
|
+
Props type: `FormTreeSelectProps`
|
|
3095
|
+
Accepts children: no
|
|
3094
3096
|
Events: `change`
|
|
3095
3097
|
|
|
3096
3098
|
### Props
|
|
@@ -3115,7 +3117,7 @@ Events: `change`
|
|
|
3115
3117
|
| `isRequired` | no | boolean | Marks field required and blocks form submit when empty |
|
|
3116
3118
|
| `label` | no | string | Label text above the input |
|
|
3117
3119
|
| `list` | yes | [FormTreeSelectList](./types.md#formtreeselectlist)[] | Flat array of tree items with parent references. Root items have parent: null, children reference parent value |
|
|
3118
|
-
| `maxHeight` | no |
|
|
3120
|
+
| `maxHeight` | no | string \| number | Max height of tags container (CSS value) |
|
|
3119
3121
|
| `placeholder` | no | string | Placeholder text when no selection |
|
|
3120
3122
|
| `placement` | no | [FormTreeSelectPlacement](./definitions.md#formtreeselectplacement) | Dropdown position. Default: bottom-end |
|
|
3121
3123
|
| `shouldExpandNodeOnSelection` | no | boolean | Auto expands a node to show its children once selected. Default: false |
|
|
@@ -3139,10 +3141,10 @@ The field validates email format automatically.
|
|
|
3139
3141
|
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" }`.
|
|
3140
3142
|
onChange emits "change"; onBlur emits "blur".
|
|
3141
3143
|
|
|
3142
|
-
Catalog key: `FormWorkEmail`
|
|
3143
|
-
Builder: `FormWorkEmail`
|
|
3144
|
-
Props type: `FormWorkEmailProps`
|
|
3145
|
-
Accepts children: no
|
|
3144
|
+
Catalog key: `FormWorkEmail`
|
|
3145
|
+
Builder: `FormWorkEmail`
|
|
3146
|
+
Props type: `FormWorkEmailProps`
|
|
3147
|
+
Accepts children: no
|
|
3146
3148
|
Events: `change`, `blur`
|
|
3147
3149
|
|
|
3148
3150
|
### Props
|
|
@@ -3188,10 +3190,10 @@ Grid displays data in a key-value grid layout with automatic responsive column s
|
|
|
3188
3190
|
- Both cell labels and actions support tooltips
|
|
3189
3191
|
- Tips can be simple strings or objects with appearance, placement, and size options
|
|
3190
3192
|
|
|
3191
|
-
Catalog key: `Grid`
|
|
3192
|
-
Builder: `Grid`
|
|
3193
|
-
Props type: `GridProps`
|
|
3194
|
-
Accepts children: no
|
|
3193
|
+
Catalog key: `Grid`
|
|
3194
|
+
Builder: `Grid`
|
|
3195
|
+
Props type: `GridProps`
|
|
3196
|
+
Accepts children: no
|
|
3195
3197
|
Events: `actionClick`
|
|
3196
3198
|
|
|
3197
3199
|
### Props
|
|
@@ -3200,7 +3202,7 @@ Events: `actionClick`
|
|
|
3200
3202
|
|---|---:|---|---|
|
|
3201
3203
|
| `actionClickedId` | no | string | Stores the id of the clicked action. Bind to state path to access in actionClick event handler |
|
|
3202
3204
|
| `actions` | no | [GridAction](./types.md#gridaction)[] | Array of action buttons displayed at the bottom of the grid. Each action emits actionClick event with id in state |
|
|
3203
|
-
| `list` | yes |
|
|
3205
|
+
| `list` | yes | [GridList](./types.md#gridlist) \| [GridList](./types.md#gridlist)[] | Array of cells to display in the grid. Each cell has a label and renderer with props |
|
|
3204
3206
|
| `theme` | no | [GridTheme](./definitions.md#gridtheme) | Visual theme variant. NO_CARD removes card styling, TRANSPARENT uses transparent theme, NO_PADDING removes padding. Default: card with padding |
|
|
3205
3207
|
|
|
3206
3208
|
No additional properties.
|
|
@@ -3209,10 +3211,10 @@ No additional properties.
|
|
|
3209
3211
|
|
|
3210
3212
|
A semantic heading element (h1–h6) for page titles and section headers that establishes document hierarchy. Use for structural headings only — for body text or paragraphs use Paragraph, and for a title paired with a subtitle use TitleCaption.
|
|
3211
3213
|
|
|
3212
|
-
Catalog key: `Heading`
|
|
3213
|
-
Builder: `Heading`
|
|
3214
|
-
Props type: `HeadingProps`
|
|
3215
|
-
Accepts children: no
|
|
3214
|
+
Catalog key: `Heading`
|
|
3215
|
+
Builder: `Heading`
|
|
3216
|
+
Props type: `HeadingProps`
|
|
3217
|
+
Accepts children: no
|
|
3216
3218
|
Events: _none_
|
|
3217
3219
|
|
|
3218
3220
|
### Props
|
|
@@ -3223,7 +3225,7 @@ Events: _none_
|
|
|
3223
3225
|
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token resolved via the current theme. |
|
|
3224
3226
|
| `decoration` | no | string | Text decoration CSS value (e.g. "underline", "line-through") |
|
|
3225
3227
|
| `inline` | no | boolean | Display as inline element instead of block |
|
|
3226
|
-
| `level` | no |
|
|
3228
|
+
| `level` | no | 1 \| 2 \| 3 \| 4 \| 5 \| 6 | Heading level (h1=1, h2=2, h3=3, h4=4, h5=5, h6=6) |
|
|
3227
3229
|
| `lineClamp` | no | number | Max visible lines before truncation with ellipsis |
|
|
3228
3230
|
| `maxWidth` | no | string | Maximum width CSS value for the text element |
|
|
3229
3231
|
| `mono` | no | boolean | Apply monospace font family |
|
|
@@ -3238,10 +3240,10 @@ A hidden form input for passing fixed or derived values through form submission
|
|
|
3238
3240
|
|
|
3239
3241
|
Hidden renders a native input[type="hidden"]. It is invisible and ignored by assistive technologies. Use it to include IDs, tokens, or computed values in form submissions. Standalone — does not register with Form; use FormHidden inside a Form instead.
|
|
3240
3242
|
|
|
3241
|
-
Catalog key: `Hidden`
|
|
3242
|
-
Builder: `Hidden`
|
|
3243
|
-
Props type: `HiddenProps`
|
|
3244
|
-
Accepts children: no
|
|
3243
|
+
Catalog key: `Hidden`
|
|
3244
|
+
Builder: `Hidden`
|
|
3245
|
+
Props type: `HiddenProps`
|
|
3246
|
+
Accepts children: no
|
|
3245
3247
|
Events: _none_
|
|
3246
3248
|
|
|
3247
3249
|
### Props
|
|
@@ -3258,10 +3260,10 @@ No additional properties.
|
|
|
3258
3260
|
|
|
3259
3261
|
Horizontal stack layout that arranges children side-by-side in a row with token-based spacing. Use for placing elements next to each other horizontally — e.g. side-by-side form fields, button groups, or inline icon-and-text pairs. Prefer VStack for vertical stacking and Box for complex layouts needing custom dimensions, borders, or backgrounds.
|
|
3260
3262
|
|
|
3261
|
-
Catalog key: `HStack`
|
|
3262
|
-
Builder: `HStack`
|
|
3263
|
-
Props type: `HStackProps`
|
|
3264
|
-
Accepts children: yes
|
|
3263
|
+
Catalog key: `HStack`
|
|
3264
|
+
Builder: `HStack`
|
|
3265
|
+
Props type: `HStackProps`
|
|
3266
|
+
Accepts children: yes
|
|
3265
3267
|
Events: _none_
|
|
3266
3268
|
|
|
3267
3269
|
### Props
|
|
@@ -3271,23 +3273,23 @@ Events: _none_
|
|
|
3271
3273
|
| `align` | no | [HStackAlign](./definitions.md#hstackalign) | Cross-axis alignment |
|
|
3272
3274
|
| `alignSelf` | no | [HStackAlignSelf](./definitions.md#hstackalignself) | Align self override when inside a flex parent |
|
|
3273
3275
|
| `backgroundColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Background surface color token |
|
|
3274
|
-
| `basis` | no |
|
|
3276
|
+
| `basis` | no | number \| string | Flex basis value |
|
|
3275
3277
|
| `boxSizing` | no | [HStackBoxSizing](./definitions.md#hstackboxsizing) | Box sizing model |
|
|
3276
3278
|
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Text/icon color token |
|
|
3277
|
-
| `gap` | no | [
|
|
3279
|
+
| `gap` | no | [BoxGap](./definitions.md#boxgap) | Spacing token for gap between children |
|
|
3278
3280
|
| `grow` | no | number | Flex grow factor |
|
|
3279
|
-
| `height` | no |
|
|
3281
|
+
| `height` | no | number \| string | Height in pixels (number) or CSS string |
|
|
3280
3282
|
| `justify` | no | [HStackJustify](./definitions.md#hstackjustify) | Main-axis alignment |
|
|
3281
|
-
| `margin` | no |
|
|
3282
|
-
| `maxHeight` | no |
|
|
3283
|
-
| `maxWidth` | no |
|
|
3284
|
-
| `minHeight` | no |
|
|
3285
|
-
| `minWidth` | no |
|
|
3283
|
+
| `margin` | no | [BoxGap](./definitions.md#boxgap) \| [HStackMargin](./types.md#hstackmargin) | Margin as a spacing token or directional spacing-token object {top, right, bottom, left} |
|
|
3284
|
+
| `maxHeight` | no | number \| string | Max height in pixels or CSS string |
|
|
3285
|
+
| `maxWidth` | no | number \| string | Max width in pixels or CSS string |
|
|
3286
|
+
| `minHeight` | no | number \| string | Min height in pixels or CSS string |
|
|
3287
|
+
| `minWidth` | no | number \| string | Min width in pixels or CSS string |
|
|
3286
3288
|
| `overflow` | no | [HStackOverflow](./definitions.md#hstackoverflow) | Overflow behavior |
|
|
3287
|
-
| `padding` | no |
|
|
3288
|
-
| `radius` | no | [
|
|
3289
|
+
| `padding` | no | [BoxGap](./definitions.md#boxgap) \| [HStackPadding](./types.md#hstackpadding) | Padding as a spacing token or directional spacing-token object {top, right, bottom, left} |
|
|
3290
|
+
| `radius` | no | [BoxRadius](./definitions.md#boxradius) | Border radius token |
|
|
3289
3291
|
| `shrink` | no | number | Flex shrink factor |
|
|
3290
|
-
| `width` | no |
|
|
3292
|
+
| `width` | no | number \| string | Width in pixels (number) or CSS string |
|
|
3291
3293
|
| `wrap` | no | [ButtonGroupFlexWrap](./definitions.md#buttongroupflexwrap) | Flex wrap behavior |
|
|
3292
3294
|
|
|
3293
3295
|
No additional properties.
|
|
@@ -3298,10 +3300,10 @@ A standalone icon element from the Pebble icon set. Use for decorative or intera
|
|
|
3298
3300
|
|
|
3299
3301
|
Icon type values are uppercase strings matching Icon.TYPES constants (e.g. ADD, ARROW_DOWN, CHECK, CHEVRON_DOWN, CLOSE, COPY_OUTLINE, DELETE, DOWNLOAD, EDIT_OUTLINE, SEARCH, USER_OUTLINE). When press event is bound, ariaLabel is required for accessibility. Tip can be a simple string or an object with content, placement (e.g. TOP, BOTTOM, LEFT, RIGHT), and appearance (LIGHT or DARK). Interactive icons (with onClick) automatically show a backdrop on hover with 4px padding for better hit area. The isFocused and showCursor props should only be used with interactive icons to provide visual feedback. Skipped: backdropColor (internal/non-functional), fontFamily (internal), className (CSS override), shouldPreventFocus (internal), onMouseDown/onMouseUp (DOM events), testId (testing only).
|
|
3300
3302
|
|
|
3301
|
-
Catalog key: `Icon`
|
|
3302
|
-
Builder: `Icon`
|
|
3303
|
-
Props type: `IconProps`
|
|
3304
|
-
Accepts children: no
|
|
3303
|
+
Catalog key: `Icon`
|
|
3304
|
+
Builder: `Icon`
|
|
3305
|
+
Props type: `IconProps`
|
|
3306
|
+
Accepts children: no
|
|
3305
3307
|
Events: `press`
|
|
3306
3308
|
|
|
3307
3309
|
### Props
|
|
@@ -3319,7 +3321,7 @@ Events: `press`
|
|
|
3319
3321
|
| `isFocused` | no | boolean | Show icon backdrop when focused. Use only with interactive icons (onClick). Default: false |
|
|
3320
3322
|
| `showCursor` | no | boolean | Show pointer cursor and backdrop on hover. Use only with interactive icons (onClick). Default: false |
|
|
3321
3323
|
| `size` | no | [IconSize](./definitions.md#iconsize) | Icon size token |
|
|
3322
|
-
| `tip` | no |
|
|
3324
|
+
| `tip` | no | string \| [IconTip](./types.md#icontip) | Tooltip. String for simple text, or object for advanced options |
|
|
3323
3325
|
| `type` | yes | string | Icon type string from Icon.TYPES (e.g. ADD, CHECK, CLOSE, EDIT_OUTLINE) |
|
|
3324
3326
|
|
|
3325
3327
|
No additional properties.
|
|
@@ -3347,10 +3349,10 @@ An icon-only button for repeated, common, or persistent actions when screen real
|
|
|
3347
3349
|
**Spinner behavior:**
|
|
3348
3350
|
- When shouldShowSpinner is true, spinner replaces icon regardless of icon prop
|
|
3349
3351
|
|
|
3350
|
-
Catalog key: `IconButton`
|
|
3351
|
-
Builder: `IconButton`
|
|
3352
|
-
Props type: `IconButtonProps`
|
|
3353
|
-
Accepts children: no
|
|
3352
|
+
Catalog key: `IconButton`
|
|
3353
|
+
Builder: `IconButton`
|
|
3354
|
+
Props type: `IconButtonProps`
|
|
3355
|
+
Accepts children: no
|
|
3354
3356
|
Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
|
|
3355
3357
|
|
|
3356
3358
|
### Props
|
|
@@ -3361,11 +3363,11 @@ Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
|
|
|
3361
3363
|
| `aria-controls` | no | string | ID of element controlled by the button |
|
|
3362
3364
|
| `aria-describedby` | no | string | ID of element that describes the button |
|
|
3363
3365
|
| `aria-expanded` | no | boolean | Indicates expanded state (for toggles) |
|
|
3364
|
-
| `aria-haspopup` | no |
|
|
3366
|
+
| `aria-haspopup` | no | boolean \| string | Indicates the button opens a popup/menu |
|
|
3365
3367
|
| `aria-label` | no | string | Accessible label for the button. Required if aria-labelledby is not provided. |
|
|
3366
3368
|
| `aria-labelledby` | no | string | ID of element that labels the button. Required if aria-label is not provided. |
|
|
3367
|
-
| `aria-pressed` | no |
|
|
3368
|
-
| `icon` | yes |
|
|
3369
|
+
| `aria-pressed` | no | boolean \| "mixed" | Indicates pressed state (for toggle buttons) |
|
|
3370
|
+
| `icon` | yes | string \| [IconButtonIcon](./types.md#iconbuttonicon) | Icon to display. Can be icon name string or object with type and color |
|
|
3369
3371
|
| `id` | no | string | DOM id selector for the button element |
|
|
3370
3372
|
| `isDisabled` | no | boolean | If true, button is disabled. Default: false |
|
|
3371
3373
|
| `shouldPreventFocus` | no | boolean | If true, the button will not be focusable (tabIndex -1). Default: false |
|
|
@@ -3373,8 +3375,8 @@ Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
|
|
|
3373
3375
|
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Size of the button (XS, S, M, L). Default: M |
|
|
3374
3376
|
| `tabIndex` | no | number | Tab order for keyboard navigation |
|
|
3375
3377
|
| `testId` | no | string | Sets data-testid attribute. Default: "icon-button" |
|
|
3376
|
-
| `tip` | no |
|
|
3377
|
-
| `to` | no |
|
|
3378
|
+
| `tip` | no | string \| [IconButtonTip](./types.md#iconbuttontip) | Tooltip text or tooltip configuration object |
|
|
3379
|
+
| `to` | no | string \| [IconButtonTo](./types.md#iconbuttonto) | Navigation destination. When provided, button renders as anchor and handles navigation automatically |
|
|
3378
3380
|
| `type` | no | [FloatingButtonType](./definitions.md#floatingbuttontype) | HTML button type attribute (button, submit, reset). Default: button |
|
|
3379
3381
|
|
|
3380
3382
|
No additional properties.
|
|
@@ -3385,10 +3387,10 @@ Displays an image with optional theme-aware light/dark sources, lazy loading, an
|
|
|
3385
3387
|
|
|
3386
3388
|
Events: "press" fires on click, "load" fires when image loads, "error" fires on load error. For theme-aware images, provide src as {light: "url1", dark: "url2"}.
|
|
3387
3389
|
|
|
3388
|
-
Catalog key: `Image`
|
|
3389
|
-
Builder: `Image`
|
|
3390
|
-
Props type: `ImageProps`
|
|
3391
|
-
Accepts children: no
|
|
3390
|
+
Catalog key: `Image`
|
|
3391
|
+
Builder: `Image`
|
|
3392
|
+
Props type: `ImageProps`
|
|
3393
|
+
Accepts children: no
|
|
3392
3394
|
Events: `press`, `load`, `error`
|
|
3393
3395
|
|
|
3394
3396
|
### Props
|
|
@@ -3397,12 +3399,12 @@ Events: `press`, `load`, `error`
|
|
|
3397
3399
|
|---|---:|---|---|
|
|
3398
3400
|
| `alt` | yes | string | Alt text for accessibility. Required for screen readers |
|
|
3399
3401
|
| `assetFilter` | no | boolean | Apply dark mode filter for dark themes. Default: false |
|
|
3400
|
-
| `borderRadius` | no | [
|
|
3401
|
-
| `height` | no |
|
|
3402
|
+
| `borderRadius` | no | [BoxRadius](./definitions.md#boxradius) | Border radius token, e.g. "shapeCornerMd" |
|
|
3403
|
+
| `height` | no | number \| string | Image height in px or CSS string |
|
|
3402
3404
|
| `loading` | no | [ImageLoading](./definitions.md#imageloading) | Loading strategy. Default: eager |
|
|
3403
|
-
| `src` | yes |
|
|
3405
|
+
| `src` | yes | string \| [Src](./types.md#src) | Image URL or theme-aware source object with light/dark variants |
|
|
3404
3406
|
| `theme` | no | [ImageTheme](./definitions.md#imagetheme) | Image theme. COVER for cover positioning |
|
|
3405
|
-
| `width` | no |
|
|
3407
|
+
| `width` | no | number \| string | Image width in px or CSS string |
|
|
3406
3408
|
|
|
3407
3409
|
No additional properties.
|
|
3408
3410
|
|
|
@@ -3410,10 +3412,10 @@ No additional properties.
|
|
|
3410
3412
|
|
|
3411
3413
|
Displays an image thumbnail that expands into a full-size overlay with zoom when clicked. Use for previewing images such as uploaded documents, photos, or screenshots where users need to inspect detail.
|
|
3412
3414
|
|
|
3413
|
-
Catalog key: `ImageViewer`
|
|
3414
|
-
Builder: `ImageViewer`
|
|
3415
|
-
Props type: `ImageViewerProps`
|
|
3416
|
-
Accepts children: no
|
|
3415
|
+
Catalog key: `ImageViewer`
|
|
3416
|
+
Builder: `ImageViewer`
|
|
3417
|
+
Props type: `ImageViewerProps`
|
|
3418
|
+
Accepts children: no
|
|
3417
3419
|
Events: _none_
|
|
3418
3420
|
|
|
3419
3421
|
### Props
|
|
@@ -3432,10 +3434,10 @@ Combines multiple input fields (e.g. a Select prefix with a Text input) into a s
|
|
|
3432
3434
|
|
|
3433
3435
|
Each input configuration requires a type (matching INPUT_TYPES) and inputProps object. The inputProps are passed directly to the underlying Pebble input component, so Select configs use `list` rather than the json-render Select catalog `options` prop. Common pattern: Select prefix + Text input for currency/phone fields.
|
|
3434
3436
|
|
|
3435
|
-
Catalog key: `InputGroup`
|
|
3436
|
-
Builder: `InputGroup`
|
|
3437
|
-
Props type: `InputGroupProps`
|
|
3438
|
-
Accepts children: no
|
|
3437
|
+
Catalog key: `InputGroup`
|
|
3438
|
+
Builder: `InputGroup`
|
|
3439
|
+
Props type: `InputGroupProps`
|
|
3440
|
+
Accepts children: no
|
|
3439
3441
|
Events: _none_
|
|
3440
3442
|
|
|
3441
3443
|
### Props
|
|
@@ -3446,14 +3448,14 @@ Events: _none_
|
|
|
3446
3448
|
| `isDisabled` | no | boolean | Disables all inputs in the group |
|
|
3447
3449
|
| `isInvalid` | no | boolean | Shows error styling on the group |
|
|
3448
3450
|
| `isReadOnly` | no | boolean | Makes all inputs in the group read-only |
|
|
3449
|
-
| `prefix` | no |
|
|
3451
|
+
| `prefix` | no | [InputGroupPrefix](./types.md#inputgroupprefix) \| [InputGroupPrefix](./types.md#inputgroupprefix)[] | Prefix input configuration(s) prepended to the main input |
|
|
3450
3452
|
| `prefixMaxWidthPercent` | no | number | Max width percentage for the prefix container |
|
|
3451
|
-
| `prefixMinWidth` | no |
|
|
3453
|
+
| `prefixMinWidth` | no | number \| string | Minimum width for the prefix container |
|
|
3452
3454
|
| `shouldHideAddons` | no | boolean | Hides prefix/suffix without destroying them |
|
|
3453
3455
|
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Size of all inputs in the group. Default: M |
|
|
3454
|
-
| `suffix` | no |
|
|
3456
|
+
| `suffix` | no | [InputGroupSuffix](./types.md#inputgroupsuffix) \| [InputGroupSuffix](./types.md#inputgroupsuffix)[] | Suffix input configuration(s) appended to the main input |
|
|
3455
3457
|
| `suffixMaxWidthPercent` | no | number | Max width percentage for the suffix container |
|
|
3456
|
-
| `suffixMinWidth` | no |
|
|
3458
|
+
| `suffixMinWidth` | no | number \| string | Minimum width for the suffix container |
|
|
3457
3459
|
|
|
3458
3460
|
No additional properties.
|
|
3459
3461
|
|
|
@@ -3463,10 +3465,10 @@ A compact prev/next control for stepping through items one at a time, displaying
|
|
|
3463
3465
|
|
|
3464
3466
|
ItemNavigator displays "X of Y items" with previous/next buttons. Bind currentItemIndex to state. The next event fires when the next button is clicked, and the previous event fires when the previous button is clicked. Both events update currentItemIndex in state automatically (incrementing or decrementing by 1). Previous is auto-disabled at index 0; next is auto-disabled at totalItems-1.
|
|
3465
3467
|
|
|
3466
|
-
Catalog key: `ItemNavigator`
|
|
3467
|
-
Builder: `ItemNavigator`
|
|
3468
|
-
Props type: `ItemNavigatorProps`
|
|
3469
|
-
Accepts children: no
|
|
3468
|
+
Catalog key: `ItemNavigator`
|
|
3469
|
+
Builder: `ItemNavigator`
|
|
3470
|
+
Props type: `ItemNavigatorProps`
|
|
3471
|
+
Accepts children: no
|
|
3470
3472
|
Events: `next`, `previous`
|
|
3471
3473
|
|
|
3472
3474
|
### Props
|
|
@@ -3497,10 +3499,10 @@ Tip props:
|
|
|
3497
3499
|
- Can be simple string (tooltip text) or object with appearance, placement, delays, and other options
|
|
3498
3500
|
- Tooltip automatically shown on overflow with default content matching label text
|
|
3499
3501
|
|
|
3500
|
-
Catalog key: `Label`
|
|
3501
|
-
Builder: `Label`
|
|
3502
|
-
Props type: `LabelProps`
|
|
3503
|
-
Accepts children: no
|
|
3502
|
+
Catalog key: `Label`
|
|
3503
|
+
Builder: `Label`
|
|
3504
|
+
Props type: `LabelProps`
|
|
3505
|
+
Accepts children: no
|
|
3504
3506
|
Events: _none_
|
|
3505
3507
|
|
|
3506
3508
|
### Props
|
|
@@ -3508,12 +3510,12 @@ Events: _none_
|
|
|
3508
3510
|
| Name | Required | Type | Description |
|
|
3509
3511
|
|---|---:|---|---|
|
|
3510
3512
|
| `appearance` | no | [LabelAppearance](./definitions.md#labelappearance) | Color scheme of the label. Default: NEUTRAL |
|
|
3511
|
-
| `leftIcon` | no |
|
|
3513
|
+
| `leftIcon` | no | string \| [LabelLeftIcon](./types.md#labellefticon) | Icon displayed on the left side of the label |
|
|
3512
3514
|
| `maxWidth` | no | string | Maximum width CSS value for truncation |
|
|
3513
|
-
| `rightIcon` | no |
|
|
3515
|
+
| `rightIcon` | no | string \| [LabelRightIcon](./types.md#labelrighticon) | Icon displayed on the right side of the label |
|
|
3514
3516
|
| `size` | no | [LabelSize](./definitions.md#labelsize) | Size of the label. Default: LARGE |
|
|
3515
3517
|
| `text` | yes | string | Text content of the label |
|
|
3516
|
-
| `tip` | no |
|
|
3518
|
+
| `tip` | no | string \| [LabelTip](./types.md#labeltip) | Tooltip shown on hover. Can be simple string or object with appearance, placement, and other options |
|
|
3517
3519
|
|
|
3518
3520
|
No additional properties.
|
|
3519
3521
|
|
|
@@ -3535,10 +3537,10 @@ LabelGroup is a container for displaying multiple Label components together. It
|
|
|
3535
3537
|
- Labels automatically wrap to fill available width
|
|
3536
3538
|
- Maintains consistent spacing between labels
|
|
3537
3539
|
|
|
3538
|
-
Catalog key: `LabelGroup`
|
|
3539
|
-
Builder: `LabelGroup`
|
|
3540
|
-
Props type: `LabelGroupProps`
|
|
3541
|
-
Accepts children: yes
|
|
3540
|
+
Catalog key: `LabelGroup`
|
|
3541
|
+
Builder: `LabelGroup`
|
|
3542
|
+
Props type: `LabelGroupProps`
|
|
3543
|
+
Accepts children: yes
|
|
3542
3544
|
Events: _none_
|
|
3543
3545
|
|
|
3544
3546
|
### Props
|
|
@@ -3556,10 +3558,10 @@ A flex-based container for arranging child elements with control over direction,
|
|
|
3556
3558
|
|
|
3557
3559
|
Layout is a flex-based Box container for page structure. Use direction to set the main axis. Use HStack/VStack for simpler horizontal/vertical layouts. Supports shorthand and object-based padding, margin, border, and radius. Use Pebble spacing tokens for gap and padding values.
|
|
3558
3560
|
|
|
3559
|
-
Catalog key: `Layout`
|
|
3560
|
-
Builder: `Layout`
|
|
3561
|
-
Props type: `LayoutProps`
|
|
3562
|
-
Accepts children: yes
|
|
3561
|
+
Catalog key: `Layout`
|
|
3562
|
+
Builder: `Layout`
|
|
3563
|
+
Props type: `LayoutProps`
|
|
3564
|
+
Accepts children: yes
|
|
3563
3565
|
Events: _none_
|
|
3564
3566
|
|
|
3565
3567
|
### Props
|
|
@@ -3569,31 +3571,31 @@ Events: _none_
|
|
|
3569
3571
|
| `align` | no | string | CSS align-items value for flex children alignment |
|
|
3570
3572
|
| `alignSelf` | no | string | CSS align-self value to override parent align |
|
|
3571
3573
|
| `backgroundColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Background surface color token |
|
|
3572
|
-
| `basis` | no |
|
|
3573
|
-
| `border` | no |
|
|
3574
|
+
| `basis` | no | number \| string | CSS flex-basis value |
|
|
3575
|
+
| `border` | no | string \| [LayoutBorder](./types.md#layoutborder) \| [LayoutBorder](./types.md#layoutborder) | Border. CSS string, strict token parts, or directional border object |
|
|
3574
3576
|
| `boxSizing` | no | [HStackBoxSizing](./definitions.md#hstackboxsizing) | CSS box-sizing model |
|
|
3575
3577
|
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Text/icon color token |
|
|
3576
3578
|
| `direction` | no | [LayoutDirection](./definitions.md#layoutdirection) | Flex direction. Default: row |
|
|
3577
|
-
| `flex` | no |
|
|
3578
|
-
| `gap` | no |
|
|
3579
|
+
| `flex` | no | number \| string | CSS flex shorthand |
|
|
3580
|
+
| `gap` | no | [BoxGap](./definitions.md#boxgap) \| [LayoutGap](./types.md#layoutgap) | Gap between children. Spacing token or {row, column} spacing-token object |
|
|
3579
3581
|
| `grow` | no | number | CSS flex-grow value |
|
|
3580
|
-
| `height` | no |
|
|
3582
|
+
| `height` | no | number \| string | Element height. Number (px) or CSS string |
|
|
3581
3583
|
| `id` | no | string | HTML id attribute |
|
|
3582
3584
|
| `isInline` | no | boolean | Use inline-flex display instead of flex |
|
|
3583
3585
|
| `justify` | no | string | CSS justify-content value for flex main-axis alignment |
|
|
3584
|
-
| `margin` | no |
|
|
3585
|
-
| `maxHeight` | no |
|
|
3586
|
-
| `maxWidth` | no |
|
|
3587
|
-
| `minHeight` | no |
|
|
3588
|
-
| `minWidth` | no |
|
|
3586
|
+
| `margin` | no | [BoxGap](./definitions.md#boxgap) \| [LayoutMargin](./types.md#layoutmargin) | Margin. Spacing token or {left, right, top, bottom} spacing-token object |
|
|
3587
|
+
| `maxHeight` | no | number \| string | Maximum height. Number (px) or CSS string |
|
|
3588
|
+
| `maxWidth` | no | number \| string | Maximum width. Number (px) or CSS string |
|
|
3589
|
+
| `minHeight` | no | number \| string | Minimum height. Number (px) or CSS string |
|
|
3590
|
+
| `minWidth` | no | number \| string | Minimum width. Number (px) or CSS string |
|
|
3589
3591
|
| `overflow` | no | string | CSS overflow behavior |
|
|
3590
|
-
| `padding` | no |
|
|
3592
|
+
| `padding` | no | [BoxGap](./definitions.md#boxgap) \| [LayoutPadding](./types.md#layoutpadding) | Padding. Spacing token or {left, right, top, bottom} spacing-token object |
|
|
3591
3593
|
| `position` | no | string | CSS position value |
|
|
3592
|
-
| `radius` | no |
|
|
3594
|
+
| `radius` | no | [BoxRadius](./definitions.md#boxradius) \| [LayoutRadiu](./types.md#layoutradiu) | Border radius. Radius token or directional corner radius token object |
|
|
3593
3595
|
| `reverse` | no | boolean | Reverse the flex direction |
|
|
3594
3596
|
| `role` | no | string | ARIA role for the container element |
|
|
3595
3597
|
| `shrink` | no | number | CSS flex-shrink value |
|
|
3596
|
-
| `width` | no |
|
|
3598
|
+
| `width` | no | number \| string | Element width. Number (px) or CSS string |
|
|
3597
3599
|
| `wrap` | no | string | CSS flex-wrap value |
|
|
3598
3600
|
| `zIndex` | no | number | CSS z-index stacking order |
|
|
3599
3601
|
|
|
@@ -3605,10 +3607,10 @@ A standard card container for creating card-based page layouts with configurable
|
|
|
3605
3607
|
|
|
3606
3608
|
LayoutCard is a layout wrapper component providing consistent card styling with configurable padding. Use SELECTABLE theme for selection interfaces. Emits "press" event when clicked (requires onClick binding).
|
|
3607
3609
|
|
|
3608
|
-
Catalog key: `LayoutCard`
|
|
3609
|
-
Builder: `LayoutCard`
|
|
3610
|
-
Props type: `LayoutCardProps`
|
|
3611
|
-
Accepts children: yes
|
|
3610
|
+
Catalog key: `LayoutCard`
|
|
3611
|
+
Builder: `LayoutCard`
|
|
3612
|
+
Props type: `LayoutCardProps`
|
|
3613
|
+
Accepts children: yes
|
|
3612
3614
|
Events: `press`
|
|
3613
3615
|
|
|
3614
3616
|
### Props
|
|
@@ -3626,10 +3628,10 @@ A clickable text hyperlink for navigating to URLs or downloading files. Use for
|
|
|
3626
3628
|
|
|
3627
3629
|
Use href="#" with a "press" event handler for links that trigger actions instead of navigating. The "press" event fires on every click; when href is "#" or empty, default navigation is automatically prevented. Set target="_blank" to open in a new tab — rel is auto-set to "noopener noreferrer" in that case. Use the download prop (boolean or custom filename string) to prompt a file download instead of navigation.
|
|
3628
3630
|
|
|
3629
|
-
Catalog key: `Link`
|
|
3630
|
-
Builder: `Link`
|
|
3631
|
-
Props type: `LinkProps`
|
|
3632
|
-
Accepts children: no
|
|
3631
|
+
Catalog key: `Link`
|
|
3632
|
+
Builder: `Link`
|
|
3633
|
+
Props type: `LinkProps`
|
|
3634
|
+
Accepts children: no
|
|
3633
3635
|
Events: `press`
|
|
3634
3636
|
|
|
3635
3637
|
### Props
|
|
@@ -3637,13 +3639,13 @@ Events: `press`
|
|
|
3637
3639
|
| Name | Required | Type | Description |
|
|
3638
3640
|
|---|---:|---|---|
|
|
3639
3641
|
| `aria-controls` | no | string | ID of element controlled by this link |
|
|
3640
|
-
| `aria-current` | no |
|
|
3641
|
-
| `aria-haspopup` | no |
|
|
3642
|
+
| `aria-current` | no | boolean \| [LinkAriaCurrent](./definitions.md#linkariacurrent) | Indicates current item within a set of items |
|
|
3643
|
+
| `aria-haspopup` | no | boolean \| [ButtonAriaHaspopup](./definitions.md#buttonariahaspopup) | Indicates element triggers a popup or menu |
|
|
3642
3644
|
| `aria-hidden` | no | boolean | Hide element from accessibility tree |
|
|
3643
3645
|
| `aria-label` | no | string | Accessibility label for the link |
|
|
3644
3646
|
| `aria-labelledby` | no | string | ID of element that labels this link |
|
|
3645
3647
|
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Pebble text/icon color token |
|
|
3646
|
-
| `download` | no |
|
|
3648
|
+
| `download` | no | string \| boolean | Prompts download of the linked URL. Boolean true uses default filename, string sets custom filename |
|
|
3647
3649
|
| `href` | yes | string | URL to navigate to |
|
|
3648
3650
|
| `rel` | no | string | Relationship between current document and linked URL. Auto-set to "noopener noreferrer" when target is _blank |
|
|
3649
3651
|
| `target` | no | [LinkTarget](./definitions.md#linktarget) | Link target (_blank or _self). Default: _self |
|
|
@@ -3658,10 +3660,10 @@ A structured list entry for displaying related entities vertically, with a title
|
|
|
3658
3660
|
|
|
3659
3661
|
Skipped: leftRenderer/rightRenderer (ReactNode — not serializable in JSON spec), dropdownActions (complex DropdownProps object with nested callbacks).
|
|
3660
3662
|
|
|
3661
|
-
Catalog key: `ListItem`
|
|
3662
|
-
Builder: `ListItem`
|
|
3663
|
-
Props type: `ListItemProps`
|
|
3664
|
-
Accepts children: no
|
|
3663
|
+
Catalog key: `ListItem`
|
|
3664
|
+
Builder: `ListItem`
|
|
3665
|
+
Props type: `ListItemProps`
|
|
3666
|
+
Accepts children: no
|
|
3665
3667
|
Events: `press`
|
|
3666
3668
|
|
|
3667
3669
|
### Props
|
|
@@ -3680,10 +3682,10 @@ A skeleton placeholder shaped like a card, shown while card content is loading.
|
|
|
3680
3682
|
|
|
3681
3683
|
LoaderCard displays a skeleton loading state for cards. Use within Card.Group context for proper sizing. The isGridView prop adds margin for grid-based layouts.
|
|
3682
3684
|
|
|
3683
|
-
Catalog key: `LoaderCard`
|
|
3684
|
-
Builder: `LoaderCard`
|
|
3685
|
-
Props type: `LoaderCardProps`
|
|
3686
|
-
Accepts children: no
|
|
3685
|
+
Catalog key: `LoaderCard`
|
|
3686
|
+
Builder: `LoaderCard`
|
|
3687
|
+
Props type: `LoaderCardProps`
|
|
3688
|
+
Accepts children: no
|
|
3687
3689
|
Events: _none_
|
|
3688
3690
|
|
|
3689
3691
|
### Props
|
|
@@ -3700,10 +3702,10 @@ A specialized card for displaying a physical location with its nickname and form
|
|
|
3700
3702
|
|
|
3701
3703
|
LocationCard displays location information with nickname and formatted address. Emits "click" when clicked, "edit"/"delete" for those actions, and "action" when a dropdown action is clicked. The clicked action id is written to the selectedActionId bound state before the "action" event fires. Use "to" prop for navigation to map or location details.
|
|
3702
3704
|
|
|
3703
|
-
Catalog key: `LocationCard`
|
|
3704
|
-
Builder: `LocationCard`
|
|
3705
|
-
Props type: `LocationCardProps`
|
|
3706
|
-
Accepts children: no
|
|
3705
|
+
Catalog key: `LocationCard`
|
|
3706
|
+
Builder: `LocationCard`
|
|
3707
|
+
Props type: `LocationCardProps`
|
|
3708
|
+
Accepts children: no
|
|
3707
3709
|
Events: `edit`, `delete`, `click`, `action`
|
|
3708
3710
|
|
|
3709
3711
|
### Props
|
|
@@ -3716,7 +3718,7 @@ Events: `edit`, `delete`, `click`, `action`
|
|
|
3716
3718
|
| `selectedActionId` | no | string | Bound state path for the selected action id. Written before "action" event fires |
|
|
3717
3719
|
| `showDelete` | no | boolean | Show delete button. Emits "delete" event when clicked. Default: false |
|
|
3718
3720
|
| `showEdit` | no | boolean | Show edit button. Emits "edit" event when clicked. Default: false |
|
|
3719
|
-
| `to` | no |
|
|
3721
|
+
| `to` | no | string \| [LocationCardTo](./types.md#locationcardto) | Route destination for navigation. String URL or object with {path, openInNewTab}. Card renders as anchor when provided |
|
|
3720
3722
|
|
|
3721
3723
|
No additional properties.
|
|
3722
3724
|
|
|
@@ -3726,10 +3728,10 @@ Plays Lottie animations (JSON-based vector animations). Use for animated illustr
|
|
|
3726
3728
|
|
|
3727
3729
|
Either path or animationData must be provided. Use path for external JSON files; use animationData for inline animation objects. The renderer prop controls how the animation is rendered: svg (default, best quality), canvas (better performance for complex animations), or html (rarely used). Loop can be true (infinite), false (play once), or a number (play N times).
|
|
3728
3730
|
|
|
3729
|
-
Catalog key: `LottiePlayer`
|
|
3730
|
-
Builder: `LottiePlayer`
|
|
3731
|
-
Props type: `LottiePlayerProps`
|
|
3732
|
-
Accepts children: no
|
|
3731
|
+
Catalog key: `LottiePlayer`
|
|
3732
|
+
Builder: `LottiePlayer`
|
|
3733
|
+
Props type: `LottiePlayerProps`
|
|
3734
|
+
Accepts children: no
|
|
3733
3735
|
Events: _none_
|
|
3734
3736
|
|
|
3735
3737
|
### Props
|
|
@@ -3739,7 +3741,7 @@ Events: _none_
|
|
|
3739
3741
|
| `animationData` | no | [AnimationData](./types.md#animationdata) | Lottie animation JSON object. Required if path not provided |
|
|
3740
3742
|
| `autoplay` | no | boolean | Start playing automatically on load. Default: true |
|
|
3741
3743
|
| `height` | no | string | Height of the animation container |
|
|
3742
|
-
| `loop` | no |
|
|
3744
|
+
| `loop` | no | boolean \| number | Loop animation. true for infinite, false for once, or number for specific count |
|
|
3743
3745
|
| `path` | no | string | URL or relative path to the Lottie JSON animation file. Required if animationData not provided |
|
|
3744
3746
|
| `renderer` | no | [LottiePlayerRenderer](./definitions.md#lottieplayerrenderer) | Rendering method for the animation. Default: svg |
|
|
3745
3747
|
| `testId` | no | string | Data test id for testing purposes |
|
|
@@ -3753,10 +3755,10 @@ A text input that enforces a specific format pattern using mask characters (e.g.
|
|
|
3753
3755
|
|
|
3754
3756
|
onChange stores a string in state. By default it stores the masked value (with mask characters). Set shouldUnmaskValue to true to store only the raw input characters. Mask characters: 9 = digit, a = letter, * = any character. For multi-mask support (e.g., phone numbers with different formats), pass mask as an array of pattern strings.
|
|
3755
3757
|
|
|
3756
|
-
Catalog key: `Masker`
|
|
3757
|
-
Builder: `Masker`
|
|
3758
|
-
Props type: `MaskerProps`
|
|
3759
|
-
Accepts children: no
|
|
3758
|
+
Catalog key: `Masker`
|
|
3759
|
+
Builder: `Masker`
|
|
3760
|
+
Props type: `MaskerProps`
|
|
3761
|
+
Accepts children: no
|
|
3760
3762
|
Events: `change`, `blur`
|
|
3761
3763
|
|
|
3762
3764
|
### Props
|
|
@@ -3776,7 +3778,7 @@ Events: `change`, `blur`
|
|
|
3776
3778
|
| `isRequired` | no | boolean | Marks the field as required |
|
|
3777
3779
|
| `isSensitive` | no | boolean | Marks input as sensitive for privacy/security |
|
|
3778
3780
|
| `label` | no | string | Label text above the input |
|
|
3779
|
-
| `mask` | yes |
|
|
3781
|
+
| `mask` | yes | string \| string[] | Mask pattern. Use 9 for digit, a for letter, * for any character. Can be string ("999-999-9999") or array of patterns (["99.9a-999", "99.99/99-9"]) for multi-mask support |
|
|
3780
3782
|
| `maxLength` | no | number | Maximum character length |
|
|
3781
3783
|
| `maxWidth` | no | string | Maximum width CSS value |
|
|
3782
3784
|
| `minLength` | no | number | Minimum character length |
|
|
@@ -3796,10 +3798,10 @@ A dropdown menu list that displays selectable actions or options. Use for contex
|
|
|
3796
3798
|
|
|
3797
3799
|
The select event fires when a menu item is clicked. The clicked item value (string) is written to the bound selectedValues state. Use selectedValues to show which items are selected. Items support multiple label fields (label, secondaryLabel, tertiaryLabel, quaternaryLabel, rightLabel, description) - the component automatically renders the appropriate template based on which fields are provided.
|
|
3798
3800
|
|
|
3799
|
-
Catalog key: `MenuList`
|
|
3800
|
-
Builder: `MenuList`
|
|
3801
|
-
Props type: `MenuListProps`
|
|
3802
|
-
Accepts children: no
|
|
3801
|
+
Catalog key: `MenuList`
|
|
3802
|
+
Builder: `MenuList`
|
|
3803
|
+
Props type: `MenuListProps`
|
|
3804
|
+
Accepts children: no
|
|
3803
3805
|
Events: `select`
|
|
3804
3806
|
|
|
3805
3807
|
### Props
|
|
@@ -3814,7 +3816,7 @@ Events: `select`
|
|
|
3814
3816
|
| `minWidth` | no | number | Minimum width in px |
|
|
3815
3817
|
| `searchable` | no | boolean | Enable search within the menu list |
|
|
3816
3818
|
| `selectedValues` | no | string[] | Array of selected item values for highlighting |
|
|
3817
|
-
| `width` | no |
|
|
3819
|
+
| `width` | no | number \| "auto" | Width of the menu list in px or "auto". Default: 192 |
|
|
3818
3820
|
|
|
3819
3821
|
No additional properties.
|
|
3820
3822
|
|
|
@@ -3824,10 +3826,10 @@ An interactive overlay that demands user attention and input, isolating specific
|
|
|
3824
3826
|
|
|
3825
3827
|
Place ModalFooter component as the last child for action buttons. On close event, update isOpen binding to false to dismiss the modal.
|
|
3826
3828
|
|
|
3827
|
-
Catalog key: `Modal`
|
|
3828
|
-
Builder: `Modal`
|
|
3829
|
-
Props type: `ModalProps`
|
|
3830
|
-
Accepts children: yes
|
|
3829
|
+
Catalog key: `Modal`
|
|
3830
|
+
Builder: `Modal`
|
|
3831
|
+
Props type: `ModalProps`
|
|
3832
|
+
Accepts children: yes
|
|
3831
3833
|
Events: `close`
|
|
3832
3834
|
|
|
3833
3835
|
### Props
|
|
@@ -3854,10 +3856,10 @@ A button placed inside a Modal that dismisses the dialog when clicked. Used as t
|
|
|
3854
3856
|
|
|
3855
3857
|
Must be placed inside a Modal element. Gets its close handler automatically from Modal context — no event wiring needed. When clicked, it dismisses the parent Modal (triggering the Modal close event).
|
|
3856
3858
|
|
|
3857
|
-
Catalog key: `ModalCloseButton`
|
|
3858
|
-
Builder: `ModalCloseButton`
|
|
3859
|
-
Props type: `ModalCloseButtonProps`
|
|
3860
|
-
Accepts children: no
|
|
3859
|
+
Catalog key: `ModalCloseButton`
|
|
3860
|
+
Builder: `ModalCloseButton`
|
|
3861
|
+
Props type: `ModalCloseButtonProps`
|
|
3862
|
+
Accepts children: no
|
|
3861
3863
|
Events: _none_
|
|
3862
3864
|
|
|
3863
3865
|
### Props
|
|
@@ -3877,17 +3879,17 @@ Footer section of a Modal that holds primary action buttons for task completion
|
|
|
3877
3879
|
|
|
3878
3880
|
Place action buttons inside ModalFooter. Use placement="space-between" to align buttons on opposite sides.
|
|
3879
3881
|
|
|
3880
|
-
Catalog key: `ModalFooter`
|
|
3881
|
-
Builder: `ModalFooter`
|
|
3882
|
-
Props type: `ModalFooterProps`
|
|
3883
|
-
Accepts children: yes
|
|
3882
|
+
Catalog key: `ModalFooter`
|
|
3883
|
+
Builder: `ModalFooter`
|
|
3884
|
+
Props type: `ModalFooterProps`
|
|
3885
|
+
Accepts children: yes
|
|
3884
3886
|
Events: _none_
|
|
3885
3887
|
|
|
3886
3888
|
### Props
|
|
3887
3889
|
|
|
3888
3890
|
| Name | Required | Type | Description |
|
|
3889
3891
|
|---|---:|---|---|
|
|
3890
|
-
| `bottomSpacing` | no | [
|
|
3892
|
+
| `bottomSpacing` | no | [BoxGap](./definitions.md#boxgap) | Custom bottom spacing token. Default: modal footer height |
|
|
3891
3893
|
| `placement` | no | [ModalFooterPlacement](./definitions.md#modalfooterplacement) | Button alignment: right-aligned or space-between. Default: right |
|
|
3892
3894
|
| `shouldBeSticky` | no | boolean | If true, the footer will be sticky at the bottom of the modal |
|
|
3893
3895
|
| `shouldHaveStickyOffset` | no | boolean | If true, adds offset for sticky positioning. Default: true |
|
|
@@ -3900,10 +3902,10 @@ A hierarchical nested list for displaying complex data structures like categorie
|
|
|
3900
3902
|
|
|
3901
3903
|
Items use {label, value?, branches?} format where branches creates nested levels. Each item renders its label as text. Leaf items (no branches) are clickable and update selectedValue in state. The select event fires when a leaf item is clicked. The toggle event fires when any branch is expanded/collapsed.
|
|
3902
3904
|
|
|
3903
|
-
Catalog key: `NestedList`
|
|
3904
|
-
Builder: `NestedList`
|
|
3905
|
-
Props type: `NestedListProps`
|
|
3906
|
-
Accepts children: no
|
|
3905
|
+
Catalog key: `NestedList`
|
|
3906
|
+
Builder: `NestedList`
|
|
3907
|
+
Props type: `NestedListProps`
|
|
3908
|
+
Accepts children: no
|
|
3907
3909
|
Events: `toggle`, `select`
|
|
3908
3910
|
|
|
3909
3911
|
### Props
|
|
@@ -3927,10 +3929,10 @@ A general-purpose numeric input for entering whole or decimal numbers. Supports
|
|
|
3927
3929
|
|
|
3928
3930
|
onChange stores a number in state when the input is valid, or an empty string when cleared. isIntegerOnly and decimalPlaces are mutually exclusive — use one or the other. min/max constrain the allowed range; step controls increment size. When shouldAllowCalculation is true, onChangeRaw emits the raw arithmetic expression string to the changeRaw event, and onChangeCalculationState emits the calculated value (or raw string if invalid) to the changeCalculationState event. Standalone — does not register with Form; use FormNumber inside a Form instead.
|
|
3929
3931
|
|
|
3930
|
-
Catalog key: `Number`
|
|
3931
|
-
Builder: `Number`
|
|
3932
|
-
Props type: `NumberProps`
|
|
3933
|
-
Accepts children: no
|
|
3932
|
+
Catalog key: `Number`
|
|
3933
|
+
Builder: `Number`
|
|
3934
|
+
Props type: `NumberProps`
|
|
3935
|
+
Accepts children: no
|
|
3934
3936
|
Events: `change`, `blur`, `changeRaw`, `changeCalculationState`
|
|
3935
3937
|
|
|
3936
3938
|
### Props
|
|
@@ -3942,7 +3944,7 @@ Events: `change`, `blur`, `changeRaw`, `changeCalculationState`
|
|
|
3942
3944
|
| `autoFocus` | no | boolean | Auto-focus on mount |
|
|
3943
3945
|
| `checks` | no | [NumberCheck](./types.md#numbercheck)[] | Array of {type, message, args?} validation rule objects. Requires validateOn to be set |
|
|
3944
3946
|
| `decimalPlaces` | no | number | Number of decimal places. Default: 2 |
|
|
3945
|
-
| `defaultValue` | no |
|
|
3947
|
+
| `defaultValue` | no | string \| number | Initial default value for uncontrolled usage |
|
|
3946
3948
|
| `isDisabled` | no | boolean | Disables the input |
|
|
3947
3949
|
| `isIntegerOnly` | no | boolean | Restrict to integer values only |
|
|
3948
3950
|
| `isReadOnly` | no | boolean | Makes the input read-only |
|
|
@@ -3966,7 +3968,7 @@ Events: `change`, `blur`, `changeRaw`, `changeCalculationState`
|
|
|
3966
3968
|
| `suffix` | no | string | Text suffix inside the input |
|
|
3967
3969
|
| `theme` | no | [NumberTheme](./definitions.md#numbertheme) | Predefined visual theme |
|
|
3968
3970
|
| `validateOn` | no | [AppGroupSelectValidateOn](./definitions.md#appgroupselectvalidateon) | When to run validation checks. Requires checks to be set |
|
|
3969
|
-
| `value` | no |
|
|
3971
|
+
| `value` | no | string \| number | Current numeric value bound to state |
|
|
3970
3972
|
|
|
3971
3973
|
No additional properties.
|
|
3972
3974
|
|
|
@@ -3976,10 +3978,10 @@ Full-featured object list page with list view management. Supports multiple list
|
|
|
3976
3978
|
|
|
3977
3979
|
Wraps ObjectListPage which provides list view selector, manage views, add/delete records, CSV export, and RQL filtering.
|
|
3978
3980
|
|
|
3979
|
-
Catalog key: `ObjectListView`
|
|
3980
|
-
Builder: `ObjectListView`
|
|
3981
|
-
Props type: `ObjectListViewProps`
|
|
3982
|
-
Accepts children: no
|
|
3981
|
+
Catalog key: `ObjectListView`
|
|
3982
|
+
Builder: `ObjectListView`
|
|
3983
|
+
Props type: `ObjectListViewProps`
|
|
3984
|
+
Accepts children: no
|
|
3983
3985
|
Events: _none_
|
|
3984
3986
|
|
|
3985
3987
|
### Props
|
|
@@ -3997,10 +3999,10 @@ A modular component that presents a high-level overview of an entity (person, or
|
|
|
3997
3999
|
|
|
3998
4000
|
ObjectUI is a convenience wrapper that combines ObjectUITemplate, ObjectUIHeader, and ObjectUIContent. For more flexibility (such as adding ObjectUIStats between header and content), use the individual sub-components: ObjectUITemplate, ObjectUIHeader, ObjectUIStats, and ObjectUIContent. Complex actions (buttons, dropdowns) are not supported — use Button components in a separate layout for actions.
|
|
3999
4001
|
|
|
4000
|
-
Catalog key: `ObjectUI`
|
|
4001
|
-
Builder: `ObjectUI`
|
|
4002
|
-
Props type: `ObjectUIProps`
|
|
4003
|
-
Accepts children: yes
|
|
4002
|
+
Catalog key: `ObjectUI`
|
|
4003
|
+
Builder: `ObjectUI`
|
|
4004
|
+
Props type: `ObjectUIProps`
|
|
4005
|
+
Accepts children: yes
|
|
4004
4006
|
Events: _none_
|
|
4005
4007
|
|
|
4006
4008
|
### Props
|
|
@@ -4019,10 +4021,10 @@ The main body content area of an ObjectUI entity detail page. Place below Object
|
|
|
4019
4021
|
|
|
4020
4022
|
ObjectUIContent wraps the main content area of an ObjectUI layout. Place content components, forms, or other layouts as children. Use within ObjectUITemplate after ObjectUIHeader and/or ObjectUIStats.
|
|
4021
4023
|
|
|
4022
|
-
Catalog key: `ObjectUIContent`
|
|
4023
|
-
Builder: `ObjectUIContent`
|
|
4024
|
-
Props type: `ObjectUIContentProps`
|
|
4025
|
-
Accepts children: yes
|
|
4024
|
+
Catalog key: `ObjectUIContent`
|
|
4025
|
+
Builder: `ObjectUIContent`
|
|
4026
|
+
Props type: `ObjectUIContentProps`
|
|
4027
|
+
Accepts children: yes
|
|
4026
4028
|
Events: _none_
|
|
4027
4029
|
|
|
4028
4030
|
### Props
|
|
@@ -4037,10 +4039,10 @@ Header section of an entity overview (person, organization, device) displaying a
|
|
|
4037
4039
|
|
|
4038
4040
|
ObjectUIHeader renders the header section of an ObjectUI layout with an avatar, title, and caption. Use within ObjectUITemplate. Complex actions (buttons, dropdowns) are not supported — use separate Button components for actions.
|
|
4039
4041
|
|
|
4040
|
-
Catalog key: `ObjectUIHeader`
|
|
4041
|
-
Builder: `ObjectUIHeader`
|
|
4042
|
-
Props type: `ObjectUIHeaderProps`
|
|
4043
|
-
Accepts children: no
|
|
4042
|
+
Catalog key: `ObjectUIHeader`
|
|
4043
|
+
Builder: `ObjectUIHeader`
|
|
4044
|
+
Props type: `ObjectUIHeaderProps`
|
|
4045
|
+
Accepts children: no
|
|
4044
4046
|
Events: _none_
|
|
4045
4047
|
|
|
4046
4048
|
### Props
|
|
@@ -4077,10 +4079,10 @@ ObjectUIStats displays key metrics in a grid layout within an ObjectUI page. Use
|
|
|
4077
4079
|
- Both cell labels and actions support tooltips
|
|
4078
4080
|
- Tips can be simple strings or objects with appearance, placement, and size options
|
|
4079
4081
|
|
|
4080
|
-
Catalog key: `ObjectUIStats`
|
|
4081
|
-
Builder: `ObjectUIStats`
|
|
4082
|
-
Props type: `ObjectUIStatsProps`
|
|
4083
|
-
Accepts children: no
|
|
4082
|
+
Catalog key: `ObjectUIStats`
|
|
4083
|
+
Builder: `ObjectUIStats`
|
|
4084
|
+
Props type: `ObjectUIStatsProps`
|
|
4085
|
+
Accepts children: no
|
|
4084
4086
|
Events: `actionClick`
|
|
4085
4087
|
|
|
4086
4088
|
### Props
|
|
@@ -4089,7 +4091,7 @@ Events: `actionClick`
|
|
|
4089
4091
|
|---|---:|---|---|
|
|
4090
4092
|
| `actionClickedId` | no | string | Stores the id of the clicked action. Bind to state path to access in actionClick event handler |
|
|
4091
4093
|
| `actions` | no | [ObjectUIStatsAction](./types.md#objectuistatsaction)[] | Array of action buttons displayed at the bottom of the grid. Each action emits actionClick event with id in state |
|
|
4092
|
-
| `list` | yes |
|
|
4094
|
+
| `list` | yes | [ObjectUIStatsList](./types.md#objectuistatslist) \| [ObjectUIStatsList](./types.md#objectuistatslist)[] | Array of cells to display in the stats grid. Each cell has a label and renderer with props |
|
|
4093
4095
|
|
|
4094
4096
|
No additional properties.
|
|
4095
4097
|
|
|
@@ -4099,10 +4101,10 @@ The root container for an ObjectUI entity detail page that presents a high-level
|
|
|
4099
4101
|
|
|
4100
4102
|
ObjectUITemplate is the root container for ObjectUI layouts. Place ObjectUIHeader, ObjectUIStats, and ObjectUIContent as children. Typically used to wrap an entire object detail page layout.
|
|
4101
4103
|
|
|
4102
|
-
Catalog key: `ObjectUITemplate`
|
|
4103
|
-
Builder: `ObjectUITemplate`
|
|
4104
|
-
Props type: `ObjectUITemplateProps`
|
|
4105
|
-
Accepts children: yes
|
|
4104
|
+
Catalog key: `ObjectUITemplate`
|
|
4105
|
+
Builder: `ObjectUITemplate`
|
|
4106
|
+
Props type: `ObjectUITemplateProps`
|
|
4107
|
+
Accepts children: yes
|
|
4106
4108
|
Events: _none_
|
|
4107
4109
|
|
|
4108
4110
|
### Props
|
|
@@ -4117,10 +4119,10 @@ Branded header for an application or module page, displaying the app logo, title
|
|
|
4117
4119
|
|
|
4118
4120
|
PageAppLogo renders an app-level logo header with title, optional subtitle, and logo image. Use supportLink to add a help documentation link next to the title. The supportLink prop accepts a URL string only; the object variant with onClick is not supported.
|
|
4119
4121
|
|
|
4120
|
-
Catalog key: `PageAppLogo`
|
|
4121
|
-
Builder: `PageAppLogo`
|
|
4122
|
-
Props type: `PageAppLogoProps`
|
|
4123
|
-
Accepts children: no
|
|
4122
|
+
Catalog key: `PageAppLogo`
|
|
4123
|
+
Builder: `PageAppLogo`
|
|
4124
|
+
Props type: `PageAppLogoProps`
|
|
4125
|
+
Accepts children: no
|
|
4124
4126
|
Events: _none_
|
|
4125
4127
|
|
|
4126
4128
|
### Props
|
|
@@ -4144,10 +4146,10 @@ The standard wrapper for a page's main body area. Controls maximum content width
|
|
|
4144
4146
|
|
|
4145
4147
|
Page wraps content in a page-level container with configurable width and alignment. Use size to constrain content width. Use FLUID for full-width layouts. Renders as Page.Content from Pebble.
|
|
4146
4148
|
|
|
4147
|
-
Catalog key: `PageContent`
|
|
4148
|
-
Builder: `PageContent`
|
|
4149
|
-
Props type: `PageContentProps`
|
|
4150
|
-
Accepts children: yes
|
|
4149
|
+
Catalog key: `PageContent`
|
|
4150
|
+
Builder: `PageContent`
|
|
4151
|
+
Props type: `PageContentProps`
|
|
4152
|
+
Accepts children: yes
|
|
4151
4153
|
Events: _none_
|
|
4152
4154
|
|
|
4153
4155
|
### Props
|
|
@@ -4166,17 +4168,17 @@ A persistent footer bar at the bottom of a page, typically used for primary navi
|
|
|
4166
4168
|
|
|
4167
4169
|
PageFooter renders a page-level footer area. When a continue event handler is wired, it renders a built-in continue button (use continueBtnLabel to customize text). When children are provided instead, they are rendered as custom footer content. Use shouldBeSticky to fix the footer at the bottom of the viewport.
|
|
4168
4170
|
|
|
4169
|
-
Catalog key: `PageFooter`
|
|
4170
|
-
Builder: `PageFooter`
|
|
4171
|
-
Props type: `PageFooterProps`
|
|
4172
|
-
Accepts children: yes
|
|
4171
|
+
Catalog key: `PageFooter`
|
|
4172
|
+
Builder: `PageFooter`
|
|
4173
|
+
Props type: `PageFooterProps`
|
|
4174
|
+
Accepts children: yes
|
|
4173
4175
|
Events: `continue`
|
|
4174
4176
|
|
|
4175
4177
|
### Props
|
|
4176
4178
|
|
|
4177
4179
|
| Name | Required | Type | Description |
|
|
4178
4180
|
|---|---:|---|---|
|
|
4179
|
-
| `bottomSpacing` | no | [
|
|
4181
|
+
| `bottomSpacing` | no | [BoxGap](./definitions.md#boxgap) | Bottom padding spacing token |
|
|
4180
4182
|
| `continueBtnLabel` | no | string | Label for the continue button. Default: "Continue" |
|
|
4181
4183
|
| `isContinueDisabled` | no | boolean | If true, the continue button is disabled. Default: false |
|
|
4182
4184
|
| `shouldBeSticky` | no | boolean | If true, footer is sticky at the bottom. Default: false |
|
|
@@ -4191,10 +4193,10 @@ A top-of-page header displaying a title and optional caption, used inside a page
|
|
|
4191
4193
|
|
|
4192
4194
|
PageHeader renders a page-level header with title and caption text. Use size to match the PageContent width. Use shouldBeLeftAligned to align the header to the left instead of center. Add action buttons via the actions prop — each action emits an "action" event on click with its ID written to actionClickedId state. When actions are present, the header is automatically underlined unless shouldBeUnderlined is set to false.
|
|
4193
4195
|
|
|
4194
|
-
Catalog key: `PageHeader`
|
|
4195
|
-
Builder: `PageHeader`
|
|
4196
|
-
Props type: `PageHeaderProps`
|
|
4197
|
-
Accepts children: no
|
|
4196
|
+
Catalog key: `PageHeader`
|
|
4197
|
+
Builder: `PageHeader`
|
|
4198
|
+
Props type: `PageHeaderProps`
|
|
4199
|
+
Accepts children: no
|
|
4198
4200
|
Events: `action`
|
|
4199
4201
|
|
|
4200
4202
|
### Props
|
|
@@ -4219,10 +4221,10 @@ A navigation control that breaks large content into smaller pages, commonly used
|
|
|
4219
4221
|
|
|
4220
4222
|
Bind forcePage to state for controlled pagination. The change event fires when the user clicks a page. The selected page number (0-indexed) is written to the bound forcePage state.
|
|
4221
4223
|
|
|
4222
|
-
Catalog key: `Paginate`
|
|
4223
|
-
Builder: `Paginate`
|
|
4224
|
-
Props type: `PaginateProps`
|
|
4225
|
-
Accepts children: no
|
|
4224
|
+
Catalog key: `Paginate`
|
|
4225
|
+
Builder: `Paginate`
|
|
4226
|
+
Props type: `PaginateProps`
|
|
4227
|
+
Accepts children: no
|
|
4226
4228
|
Events: `change`
|
|
4227
4229
|
|
|
4228
4230
|
### Props
|
|
@@ -4245,10 +4247,10 @@ A paginated list that divides items across pages with built-in navigation contro
|
|
|
4245
4247
|
|
|
4246
4248
|
The list prop should be bound to state. Each item must have a unique id and a label field. The pageSize prop controls how many items appear per page (default 10). Unlike Paginate (standalone pagination control), PaginateList manages both list rendering and pagination state together.
|
|
4247
4249
|
|
|
4248
|
-
Catalog key: `PaginateList`
|
|
4249
|
-
Builder: `PaginateList`
|
|
4250
|
-
Props type: `PaginateListProps`
|
|
4251
|
-
Accepts children: no
|
|
4250
|
+
Catalog key: `PaginateList`
|
|
4251
|
+
Builder: `PaginateList`
|
|
4252
|
+
Props type: `PaginateListProps`
|
|
4253
|
+
Accepts children: no
|
|
4252
4254
|
Events: `change`
|
|
4253
4255
|
|
|
4254
4256
|
### Props
|
|
@@ -4308,10 +4310,10 @@ Pane is a child component of SplitPane that defines an individual panel within a
|
|
|
4308
4310
|
- Drag handle appears between panes, respects min/max constraints
|
|
4309
4311
|
- Keyboard navigation supported (arrow keys when handle focused)
|
|
4310
4312
|
|
|
4311
|
-
Catalog key: `Pane`
|
|
4312
|
-
Builder: `Pane`
|
|
4313
|
-
Props type: `PaneProps`
|
|
4314
|
-
Accepts children: yes
|
|
4313
|
+
Catalog key: `Pane`
|
|
4314
|
+
Builder: `Pane`
|
|
4315
|
+
Props type: `PaneProps`
|
|
4316
|
+
Accepts children: yes
|
|
4315
4317
|
Events: `collapsedChange`, `dismiss`, `resize`
|
|
4316
4318
|
|
|
4317
4319
|
### Props
|
|
@@ -4350,10 +4352,10 @@ Supported ARIA attributes: aria-label, aria-labelledby, aria-describedby
|
|
|
4350
4352
|
Set shouldAllowReveal to false to hide the reveal toggle (default: true)
|
|
4351
4353
|
Standalone — does not register with Form; use FormPassword inside a Form instead.
|
|
4352
4354
|
|
|
4353
|
-
Catalog key: `Password`
|
|
4354
|
-
Builder: `Password`
|
|
4355
|
-
Props type: `PasswordProps`
|
|
4356
|
-
Accepts children: no
|
|
4355
|
+
Catalog key: `Password`
|
|
4356
|
+
Builder: `Password`
|
|
4357
|
+
Props type: `PasswordProps`
|
|
4358
|
+
Accepts children: no
|
|
4357
4359
|
Events: `change`, `blur`, `focus`, `click`, `keydown`, `keyup`, `paste`, `mouseenter`, `mouseleave`, `reveal`
|
|
4358
4360
|
|
|
4359
4361
|
### Props
|
|
@@ -4403,10 +4405,10 @@ A numeric input for entering and editing percentage values. Automatically append
|
|
|
4403
4405
|
|
|
4404
4406
|
onChange stores a numeric value (number | string) in state. The component automatically displays a % suffix icon. Use upperLimit/lowerLimit to constrain the range (defaults: 0-100, or -100-100 when allowNegative is true). Standalone — does not register with Form; use FormPercentage inside a Form instead.
|
|
4405
4407
|
|
|
4406
|
-
Catalog key: `Percentage`
|
|
4407
|
-
Builder: `Percentage`
|
|
4408
|
-
Props type: `PercentageProps`
|
|
4409
|
-
Accepts children: no
|
|
4408
|
+
Catalog key: `Percentage`
|
|
4409
|
+
Builder: `Percentage`
|
|
4410
|
+
Props type: `PercentageProps`
|
|
4411
|
+
Accepts children: no
|
|
4410
4412
|
Events: `change`, `blur`
|
|
4411
4413
|
|
|
4412
4414
|
### Props
|
|
@@ -4431,7 +4433,7 @@ Events: `change`, `blur`
|
|
|
4431
4433
|
| `step` | no | number | Increment/decrement step size. Default: 1 |
|
|
4432
4434
|
| `upperLimit` | no | number | Maximum allowed percentage value. Default: 100 |
|
|
4433
4435
|
| `validateOn` | no | [AppGroupSelectValidateOn](./definitions.md#appgroupselectvalidateon) | When to run validation checks. Requires checks to be set |
|
|
4434
|
-
| `value` | no |
|
|
4436
|
+
| `value` | no | string \| number | Current percentage value bound to state |
|
|
4435
4437
|
|
|
4436
4438
|
No additional properties.
|
|
4437
4439
|
|
|
@@ -4452,10 +4454,10 @@ Basic ARIA attributes (aria-label, aria-labelledby, aria-describedby) support ac
|
|
|
4452
4454
|
The region prop is deprecated - use defaultRegion instead
|
|
4453
4455
|
Standalone — does not register with Form; use FormPhone inside a Form instead.
|
|
4454
4456
|
|
|
4455
|
-
Catalog key: `Phone`
|
|
4456
|
-
Builder: `Phone`
|
|
4457
|
-
Props type: `PhoneProps`
|
|
4458
|
-
Accepts children: no
|
|
4457
|
+
Catalog key: `Phone`
|
|
4458
|
+
Builder: `Phone`
|
|
4459
|
+
Props type: `PhoneProps`
|
|
4460
|
+
Accepts children: no
|
|
4459
4461
|
Events: `change`, `blur`, `focus`, `click`, `keydown`, `keyup`, `paste`, `mouseenter`, `mouseleave`, `countryCodeChange`
|
|
4460
4462
|
|
|
4461
4463
|
### Props
|
|
@@ -4521,10 +4523,10 @@ Communicates the status of an ongoing process, like downloading or uploading fil
|
|
|
4521
4523
|
|
|
4522
4524
|
Set isIndeterminate=true when the progress amount is unknown; the bar animates continuously. When progress becomes known, switch to determinate by setting value (0-100) and isIndeterminate=false. Use appearance to convey semantic meaning: SUCCESS for completed operations, ERROR for failed ones, WARNING for operations needing attention. The value prop supports $state/$bindState for real-time updates from backend processes. Always provide an aria-label describing the process (e.g. "Downloading PDF") since the bar is a visual-only cue.
|
|
4523
4525
|
|
|
4524
|
-
Catalog key: `ProgressBar`
|
|
4525
|
-
Builder: `ProgressBar`
|
|
4526
|
-
Props type: `ProgressBarProps`
|
|
4527
|
-
Accepts children: no
|
|
4526
|
+
Catalog key: `ProgressBar`
|
|
4527
|
+
Builder: `ProgressBar`
|
|
4528
|
+
Props type: `ProgressBarProps`
|
|
4529
|
+
Accepts children: no
|
|
4528
4530
|
Events: _none_
|
|
4529
4531
|
|
|
4530
4532
|
### Props
|
|
@@ -4550,10 +4552,10 @@ A multi-step progress indicator that visually shows completed, current, and upco
|
|
|
4550
4552
|
|
|
4551
4553
|
stepsCompleted starts at 1. Use isNumeric for numbered steps. Use isHorizontal for compact horizontal layouts.
|
|
4552
4554
|
|
|
4553
|
-
Catalog key: `ProgressSteps`
|
|
4554
|
-
Builder: `ProgressSteps`
|
|
4555
|
-
Props type: `ProgressStepsProps`
|
|
4556
|
-
Accepts children: no
|
|
4555
|
+
Catalog key: `ProgressSteps`
|
|
4556
|
+
Builder: `ProgressSteps`
|
|
4557
|
+
Props type: `ProgressStepsProps`
|
|
4558
|
+
Accepts children: no
|
|
4557
4559
|
Events: _none_
|
|
4558
4560
|
|
|
4559
4561
|
### Props
|
|
@@ -4574,10 +4576,10 @@ Radio buttons let users choose a single option from two or more mutually exclusi
|
|
|
4574
4576
|
|
|
4575
4577
|
onChange stores the selected option value in state. The stored value matches the value field of the selected option object. onMouseEnter and onMouseLeave write the hovered option value to hoveredValue state path before emitting events. Prefer over Select when showing 5 or fewer options that need to be immediately visible. Standalone — does not register with Form; use FormRadio inside a Form instead.
|
|
4576
4578
|
|
|
4577
|
-
Catalog key: `Radio`
|
|
4578
|
-
Builder: `Radio`
|
|
4579
|
-
Props type: `RadioProps`
|
|
4580
|
-
Accepts children: no
|
|
4579
|
+
Catalog key: `Radio`
|
|
4580
|
+
Builder: `Radio`
|
|
4581
|
+
Props type: `RadioProps`
|
|
4582
|
+
Accepts children: no
|
|
4581
4583
|
Events: `change`, `blur`, `mouseenter`, `mouseleave`
|
|
4582
4584
|
|
|
4583
4585
|
### Props
|
|
@@ -4611,10 +4613,10 @@ A two-handle slider for selecting a numeric range within a track. Use for defini
|
|
|
4611
4613
|
|
|
4612
4614
|
onChange stores an array [minValue, maxValue] representing the selected range in state. onBeforeChange fires when user starts dragging (mouse down/touch start), onChange fires during dragging, onAfterChange fires when dragging ends (mouse up/touch end). For step-based sliders, max-min must be evenly divisible by step. Set step=null to use marks as discrete steps. When isReadOnly=true, displays the range as text (e.g., "10 to 20"). Use appearance to color the track (PRIMARY, ERROR, SUCCESS, WARNING).
|
|
4613
4615
|
|
|
4614
|
-
Catalog key: `RangeSlider`
|
|
4615
|
-
Builder: `RangeSlider`
|
|
4616
|
-
Props type: `RangeSliderProps`
|
|
4617
|
-
Accepts children: no
|
|
4616
|
+
Catalog key: `RangeSlider`
|
|
4617
|
+
Builder: `RangeSlider`
|
|
4618
|
+
Props type: `RangeSliderProps`
|
|
4619
|
+
Accepts children: no
|
|
4618
4620
|
Events: `change`, `beforeChange`, `afterChange`, `blur`
|
|
4619
4621
|
|
|
4620
4622
|
### Props
|
|
@@ -4651,10 +4653,10 @@ A skeleton placeholder shown while tabular report content is loading. Use when t
|
|
|
4651
4653
|
|
|
4652
4654
|
ReportLoader displays a skeleton loading state for report content. It renders an animated skeleton with rows simulating report data including header and data rows with optional role columns.
|
|
4653
4655
|
|
|
4654
|
-
Catalog key: `ReportLoader`
|
|
4655
|
-
Builder: `ReportLoader`
|
|
4656
|
-
Props type: `ReportLoaderProps`
|
|
4657
|
-
Accepts children: no
|
|
4656
|
+
Catalog key: `ReportLoader`
|
|
4657
|
+
Builder: `ReportLoader`
|
|
4658
|
+
Props type: `ReportLoaderProps`
|
|
4659
|
+
Accepts children: no
|
|
4658
4660
|
Events: _none_
|
|
4659
4661
|
|
|
4660
4662
|
### Props
|
|
@@ -4669,10 +4671,10 @@ A skeleton placeholder shown while report sharing content is loading. Use when t
|
|
|
4669
4671
|
|
|
4670
4672
|
ReportShareLoader is a zero-configuration skeleton loader for the report sharing UI. It accepts no props — simply place it where report sharing content will appear. Use ReportLoader for general report content, ReportViewerLoader for the report viewer with sidebar navigation, and ReportShareLoader specifically for the report sharing flow.
|
|
4671
4673
|
|
|
4672
|
-
Catalog key: `ReportShareLoader`
|
|
4673
|
-
Builder: `ReportShareLoader`
|
|
4674
|
-
Props type: `ReportShareLoaderProps`
|
|
4675
|
-
Accepts children: no
|
|
4674
|
+
Catalog key: `ReportShareLoader`
|
|
4675
|
+
Builder: `ReportShareLoader`
|
|
4676
|
+
Props type: `ReportShareLoaderProps`
|
|
4677
|
+
Accepts children: no
|
|
4676
4678
|
Events: _none_
|
|
4677
4679
|
|
|
4678
4680
|
### Props
|
|
@@ -4687,10 +4689,10 @@ A skeleton placeholder shown while report viewer content is loading. Use when th
|
|
|
4687
4689
|
|
|
4688
4690
|
ReportViewerLoader displays a skeleton loading state for a report viewer layout. It renders a full-page placeholder with a sidebar navigation panel and a main report content area. This is a zero-prop component — just place it where the report viewer will appear. For tabular report data loading, use ReportLoader instead. For report sharing dialogs, use ReportShareLoader instead.
|
|
4689
4691
|
|
|
4690
|
-
Catalog key: `ReportViewerLoader`
|
|
4691
|
-
Builder: `ReportViewerLoader`
|
|
4692
|
-
Props type: `ReportViewerLoaderProps`
|
|
4693
|
-
Accepts children: no
|
|
4692
|
+
Catalog key: `ReportViewerLoader`
|
|
4693
|
+
Builder: `ReportViewerLoader`
|
|
4694
|
+
Props type: `ReportViewerLoaderProps`
|
|
4695
|
+
Accepts children: no
|
|
4694
4696
|
Events: _none_
|
|
4695
4697
|
|
|
4696
4698
|
### Props
|
|
@@ -4705,7 +4707,7 @@ A responsive 12-column grid for dashboard widgets that supports drag-to-rearrang
|
|
|
4705
4707
|
|
|
4706
4708
|
**Children:** Each direct child element's spec id must match an entry in this board's `layouts` array. Children with no matching layout entry are dropped silently — keep the two in sync.
|
|
4707
4709
|
|
|
4708
|
-
**Layouts:** Each layout entry carries a unique `identifier` (= the matched child's spec id), the size in grid units (width 1–12, height in row-height multiples), optional `minWidth`/`maxWidth`/`minHeight`/`maxHeight` constraints, and optional per-block styling (`border`, `shadow`, `shapeCorner`).
|
|
4710
|
+
**Layouts:** Each layout entry carries a unique `identifier` (= the matched child's spec id), optional `x`/`y` position in grid units, the size in grid units (width 1–12, height in row-height multiples), optional `minWidth`/`maxWidth`/`minHeight`/`maxHeight` constraints, and optional per-block styling (`border`, `shadow`, `shapeCorner`). When `x` or `y` is omitted, the board auto-calculates that coordinate.
|
|
4709
4711
|
|
|
4710
4712
|
**Uniform styling:** Use top-level `blockShapeCorner` when every block should share the same border-radius; per-entry `shapeCorner` overrides it for that block only.
|
|
4711
4713
|
|
|
@@ -4713,20 +4715,20 @@ A responsive 12-column grid for dashboard widgets that supports drag-to-rearrang
|
|
|
4713
4715
|
|
|
4714
4716
|
**Static mode:** `isStatic` is a single switch — it disables both drag and resize simultaneously. The board does not support disabling only one of them.
|
|
4715
4717
|
|
|
4716
|
-
Catalog key: `ResizableBoard`
|
|
4717
|
-
Builder: `ResizableBoard`
|
|
4718
|
-
Props type: `ResizableBoardProps`
|
|
4719
|
-
Accepts children: yes
|
|
4718
|
+
Catalog key: `ResizableBoard`
|
|
4719
|
+
Builder: `ResizableBoard`
|
|
4720
|
+
Props type: `ResizableBoardProps`
|
|
4721
|
+
Accepts children: yes
|
|
4720
4722
|
Events: `layoutChange`, `breakpointChange`, `dragStart`, `dragStop`, `resizeStart`, `resizeStop`
|
|
4721
4723
|
|
|
4722
4724
|
### Props
|
|
4723
4725
|
|
|
4724
4726
|
| Name | Required | Type | Description |
|
|
4725
4727
|
|---|---:|---|---|
|
|
4726
|
-
| `blockShapeCorner` | no | [
|
|
4728
|
+
| `blockShapeCorner` | no | [BoxRadius](./definitions.md#boxradius) | Shape-corner radius token applied to every block, e.g. "shapeCornerMd". Per-entry `layouts[].shapeCorner` overrides this for individual blocks. |
|
|
4727
4729
|
| `containerPadding` | no | unknown[] | Padding inside the board container in pixels [x, y]. |
|
|
4728
4730
|
| `isStatic` | no | boolean | Locks all blocks: disables both drag and resize together. Default: false. |
|
|
4729
|
-
| `layouts` | yes | [LayoutValue](./types.md#layoutvalue)[] | Layout descriptor for each block. Every entry's `identifier` must match the spec id of one of the board's direct children — that's how a block is wired to its widget content. Drag/resize will respect optional min/max bounds. |
|
|
4731
|
+
| `layouts` | yes | [LayoutValue](./types.md#layoutvalue)[] | Layout descriptor for each block. Every entry's `identifier` must match the spec id of one of the board's direct children — that's how a block is wired to its widget content. Optional `x`/`y` positions are respected; when omitted, the board auto-places blocks. Drag/resize will respect optional min/max bounds. |
|
|
4730
4732
|
| `margin` | no | unknown[] | Horizontal and vertical gutter between blocks in pixels. Default: [24, 24]. |
|
|
4731
4733
|
| `rowHeight` | no | number | Pixel height of one vertical grid unit. Default: 100. |
|
|
4732
4734
|
|
|
@@ -4738,10 +4740,10 @@ Conditionally show or hide content based on container or viewport width breakpoi
|
|
|
4738
4740
|
|
|
4739
4741
|
Responsive conditionally renders children based on viewport or container width. Use mode="show" (default) to display children at a breakpoint, or mode="hide" to hide them. Use above for mobile-first (recommended) or below for desktop-first. Common tokens: breakpointSm, breakpointMd, breakpointLg. Do not mix above and below on the same component. To target a width range, nest two Responsive wrappers: an outer with mode="show" above="breakpointMd", and an inner with mode="hide" above="breakpointLg".
|
|
4740
4742
|
|
|
4741
|
-
Catalog key: `Responsive`
|
|
4742
|
-
Builder: `Responsive`
|
|
4743
|
-
Props type: `ResponsiveProps`
|
|
4744
|
-
Accepts children: yes
|
|
4743
|
+
Catalog key: `Responsive`
|
|
4744
|
+
Builder: `Responsive`
|
|
4745
|
+
Props type: `ResponsiveProps`
|
|
4746
|
+
Accepts children: yes
|
|
4745
4747
|
Events: _none_
|
|
4746
4748
|
|
|
4747
4749
|
### Props
|
|
@@ -4761,10 +4763,10 @@ A linear set of buttons for toggling between closely related choices (2-5 short-
|
|
|
4761
4763
|
|
|
4762
4764
|
onChange stores the selected value (single mode) or an array of selected values (isMulti mode) in state. Pass options as an array of {label, value} objects — these map to the internal `list` prop. Prefer over Radio when options are short labels (2-5 items) and need a compact inline layout. Standalone — does not register with Form; use FormSegmentedControl inside a Form instead.
|
|
4763
4765
|
|
|
4764
|
-
Catalog key: `SegmentedControl`
|
|
4765
|
-
Builder: `SegmentedControl`
|
|
4766
|
-
Props type: `SegmentedControlProps`
|
|
4767
|
-
Accepts children: no
|
|
4766
|
+
Catalog key: `SegmentedControl`
|
|
4767
|
+
Builder: `SegmentedControl`
|
|
4768
|
+
Props type: `SegmentedControlProps`
|
|
4769
|
+
Accepts children: no
|
|
4768
4770
|
Events: `change`, `blur`
|
|
4769
4771
|
|
|
4770
4772
|
### Props
|
|
@@ -4774,7 +4776,7 @@ Events: `change`, `blur`
|
|
|
4774
4776
|
| `name` | no | string | Unique identifier for the input |
|
|
4775
4777
|
| `appearance` | no | [FormSegmentedControlAppearance](./definitions.md#formsegmentedcontrolappearance) | Visual style variant. Default: PRIMARY |
|
|
4776
4778
|
| `checks` | no | [SegmentedControlCheck](./types.md#segmentedcontrolcheck)[] | Array of {type, message, args?} validation rule objects. Requires validateOn to be set |
|
|
4777
|
-
| `defaultValue` | no |
|
|
4779
|
+
| `defaultValue` | no | string \| string[] | Initial value when uncontrolled |
|
|
4778
4780
|
| `isDisabled` | no | boolean | Disables the entire control |
|
|
4779
4781
|
| `isFluid` | no | boolean | Stretches control to fill container width |
|
|
4780
4782
|
| `isMulti` | no | boolean | Allows selecting multiple options |
|
|
@@ -4786,7 +4788,7 @@ Events: `change`, `blur`
|
|
|
4786
4788
|
| `rangeLabels` | no | [SegmentedControlRangeLabel](./types.md#segmentedcontrolrangelabel) | Labels to display at the start and end of the control range |
|
|
4787
4789
|
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Control size variant. Default: M |
|
|
4788
4790
|
| `validateOn` | no | [AppGroupSelectValidateOn](./definitions.md#appgroupselectvalidateon) | When to run validation checks. Requires checks to be set |
|
|
4789
|
-
| `value` | no |
|
|
4791
|
+
| `value` | no | string \| string[] | Currently selected value bound to state |
|
|
4790
4792
|
|
|
4791
4793
|
No additional properties.
|
|
4792
4794
|
|
|
@@ -4802,10 +4804,10 @@ onMenuToggle emits 'menuToggle' event when dropdown opens/closes.
|
|
|
4802
4804
|
Footer onClick emits the custom event name specified in footer.onClick.
|
|
4803
4805
|
Standalone — does not register with Form; use FormSelect inside a Form instead.
|
|
4804
4806
|
|
|
4805
|
-
Catalog key: `Select`
|
|
4806
|
-
Builder: `Select`
|
|
4807
|
-
Props type: `SelectProps`
|
|
4808
|
-
Accepts children: no
|
|
4807
|
+
Catalog key: `Select`
|
|
4808
|
+
Builder: `Select`
|
|
4809
|
+
Props type: `SelectProps`
|
|
4810
|
+
Accepts children: no
|
|
4809
4811
|
Events: `change`, `blur`, `focus`, `paste`, `menuToggle`
|
|
4810
4812
|
|
|
4811
4813
|
### Props
|
|
@@ -4822,7 +4824,7 @@ Events: `change`, `blur`, `focus`, `paste`, `menuToggle`
|
|
|
4822
4824
|
| `creatable` | no | boolean | Allow creating new options not in the list |
|
|
4823
4825
|
| `defaultSearchQuery` | no | string | Initial search input value |
|
|
4824
4826
|
| `dropdownHeight` | no | number | Sets dropdown menu height in pixels |
|
|
4825
|
-
| `emptyListPlaceholder` | no |
|
|
4827
|
+
| `emptyListPlaceholder` | no | string \| [SelectEmptyListPlaceholder](./types.md#selectemptylistplaceholder) | Placeholder when dropdown list is empty. Can be string or object with state-specific placeholders |
|
|
4826
4828
|
| `footer` | no | [SelectFooter](./types.md#selectfooter) | Fixed footer at bottom of dropdown menu |
|
|
4827
4829
|
| `fuseOptions` | no | [SelectFuseOption](./types.md#selectfuseoption) | Fuse.js search options for customizing fuzzy search behavior |
|
|
4828
4830
|
| `id` | no | string | HTML id attribute for the select input |
|
|
@@ -4834,7 +4836,7 @@ Events: `change`, `blur`, `focus`, `paste`, `menuToggle`
|
|
|
4834
4836
|
| `isRequired` | no | boolean | Marks the field as required |
|
|
4835
4837
|
| `isSearchable` | no | boolean | Enable type-to-search filtering |
|
|
4836
4838
|
| `label` | no | string | Label text above the select |
|
|
4837
|
-
| `maxHeight` | no |
|
|
4839
|
+
| `maxHeight` | no | string \| number | Max height of multi-select container (CSS value) |
|
|
4838
4840
|
| `maxTruncationLines` | no | number | Max rows of chips visible before "+X" overflow chip appears (multi-select only) |
|
|
4839
4841
|
| `options` | no | [SelectOption](./types.md#selectoption)[] | Array of option objects with label, value, and optional metadata |
|
|
4840
4842
|
| `placeholder` | no | string | Placeholder text when empty |
|
|
@@ -4858,10 +4860,10 @@ A card-based selection input that renders a group of selectable cards for single
|
|
|
4858
4860
|
|
|
4859
4861
|
onChange stores a single value when isMulti is false, or an array of values when isMulti is true. The list prop must be an array of objects; each object should have a key matching valueIdentifier (default "value") for unique identification, plus title and content keys for BASIC_CARD renderer display. LOCATION_CARD renderer is for location/address-type items. This component does not accept children — use a layout wrapper (VStack) to place multiple SelectableGroup elements together.
|
|
4860
4862
|
|
|
4861
|
-
Catalog key: `SelectableGroup`
|
|
4862
|
-
Builder: `SelectableGroup`
|
|
4863
|
-
Props type: `SelectableGroupProps`
|
|
4864
|
-
Accepts children: no
|
|
4863
|
+
Catalog key: `SelectableGroup`
|
|
4864
|
+
Builder: `SelectableGroup`
|
|
4865
|
+
Props type: `SelectableGroupProps`
|
|
4866
|
+
Accepts children: no
|
|
4865
4867
|
Events: `change`
|
|
4866
4868
|
|
|
4867
4869
|
### Props
|
|
@@ -4873,7 +4875,7 @@ Events: `change`
|
|
|
4873
4875
|
| `aria-label` | no | string | Accessible label for screen readers |
|
|
4874
4876
|
| `aria-labelledby` | no | string | ID of element that labels this input for screen readers |
|
|
4875
4877
|
| `checks` | no | [SelectableGroupCheck](./types.md#selectablegroupcheck)[] | Array of {type, message, args?} validation rule objects. Requires validateOn to be set |
|
|
4876
|
-
| `defaultValue` | no |
|
|
4878
|
+
| `defaultValue` | no | string \| number \| string \| number[] | Initial selection when uncontrolled |
|
|
4877
4879
|
| `id` | no | string | Unique DOM id for the input element |
|
|
4878
4880
|
| `isDisabled` | no | boolean | Disables all items in the group |
|
|
4879
4881
|
| `isMulti` | no | boolean | Allow multiple selection. Default: false |
|
|
@@ -4884,7 +4886,7 @@ Events: `change`
|
|
|
4884
4886
|
| `renderer` | yes | [FormSelectableGroupRenderer](./definitions.md#formselectablegrouprenderer) | Card renderer type: BASIC_CARD or LOCATION_CARD |
|
|
4885
4887
|
| `testId` | no | string | Test identifier for automated testing |
|
|
4886
4888
|
| `validateOn` | no | [AppGroupSelectValidateOn](./definitions.md#appgroupselectvalidateon) | When to run validation checks. Requires checks to be set |
|
|
4887
|
-
| `value` | no |
|
|
4889
|
+
| `value` | no | string \| number \| string \| number[] | Selected value(s). Single value when isMulti is false, array when true |
|
|
4888
4890
|
| `valueIdentifier` | no | string | Key name to extract unique value from each list item. Default: "value" |
|
|
4889
4891
|
|
|
4890
4892
|
No additional properties.
|
|
@@ -4895,10 +4897,10 @@ A dropdown menu that displays selectable options, allowing users to choose from
|
|
|
4895
4897
|
|
|
4896
4898
|
Deprecated — prefer Dropdown for new specs. Bind value to state to track the selected option. The change event fires on selection. The trigger is rendered automatically with the selected option label.
|
|
4897
4899
|
|
|
4898
|
-
Catalog key: `SelectableMenu`
|
|
4899
|
-
Builder: `SelectableMenu`
|
|
4900
|
-
Props type: `SelectableMenuProps`
|
|
4901
|
-
Accepts children: no
|
|
4900
|
+
Catalog key: `SelectableMenu`
|
|
4901
|
+
Builder: `SelectableMenu`
|
|
4902
|
+
Props type: `SelectableMenuProps`
|
|
4903
|
+
Accepts children: no
|
|
4902
4904
|
Events: `change`
|
|
4903
4905
|
|
|
4904
4906
|
### Props
|
|
@@ -4929,10 +4931,10 @@ A skeleton placeholder shown while settings page content is loading. Use when th
|
|
|
4929
4931
|
|
|
4930
4932
|
SettingsLoader displays a skeleton loading state for settings page content. It renders animated rows simulating label/value pairs in a settings layout. Use isCenter to horizontally center the loader. Use margin to override the default top margin.
|
|
4931
4933
|
|
|
4932
|
-
Catalog key: `SettingsLoader`
|
|
4933
|
-
Builder: `SettingsLoader`
|
|
4934
|
-
Props type: `SettingsLoaderProps`
|
|
4935
|
-
Accepts children: no
|
|
4934
|
+
Catalog key: `SettingsLoader`
|
|
4935
|
+
Builder: `SettingsLoader`
|
|
4936
|
+
Props type: `SettingsLoaderProps`
|
|
4937
|
+
Accepts children: no
|
|
4936
4938
|
Events: _none_
|
|
4937
4939
|
|
|
4938
4940
|
### Props
|
|
@@ -4940,7 +4942,7 @@ Events: _none_
|
|
|
4940
4942
|
| Name | Required | Type | Description |
|
|
4941
4943
|
|---|---:|---|---|
|
|
4942
4944
|
| `isCenter` | no | boolean | Center the loader horizontally using auto margins. Default: false |
|
|
4943
|
-
| `margin` | no |
|
|
4945
|
+
| `margin` | no | string \| number | Custom margin for the loader container. Accepts a CSS string (e.g. "16px") or a number (applied as px). Overrides default top margin when provided. |
|
|
4944
4946
|
|
|
4945
4947
|
No additional properties.
|
|
4946
4948
|
|
|
@@ -4950,10 +4952,10 @@ A container that truncates a list of child elements, showing only the first N it
|
|
|
4950
4952
|
|
|
4951
4953
|
ShowMore truncates its direct children — only the first "size" are shown initially, with a toggle to reveal the rest. Items MUST be direct children of ShowMore (not wrapped in a VStack or other container), otherwise truncation has no effect. For dynamic lists from state arrays, place the "repeat" field on the ShowMore element itself so each array item becomes a direct child that can be truncated.
|
|
4952
4954
|
|
|
4953
|
-
Catalog key: `ShowMore`
|
|
4954
|
-
Builder: `ShowMore`
|
|
4955
|
-
Props type: `ShowMoreProps`
|
|
4956
|
-
Accepts children: yes
|
|
4955
|
+
Catalog key: `ShowMore`
|
|
4956
|
+
Builder: `ShowMore`
|
|
4957
|
+
Props type: `ShowMoreProps`
|
|
4958
|
+
Accepts children: yes
|
|
4957
4959
|
Events: _none_
|
|
4958
4960
|
|
|
4959
4961
|
### Props
|
|
@@ -4973,10 +4975,10 @@ A signature capture input that lets users sign by drawing on a canvas or typing
|
|
|
4973
4975
|
|
|
4974
4976
|
onChange stores a base64 PNG data URL string (e.g. "data:image/png;base64,..."). The component provides both a draw canvas and a type-to-sign input. When isTypeSignatureDisabled is true, only the draw canvas is shown.
|
|
4975
4977
|
|
|
4976
|
-
Catalog key: `Signature`
|
|
4977
|
-
Builder: `Signature`
|
|
4978
|
-
Props type: `SignatureProps`
|
|
4979
|
-
Accepts children: no
|
|
4978
|
+
Catalog key: `Signature`
|
|
4979
|
+
Builder: `Signature`
|
|
4980
|
+
Props type: `SignatureProps`
|
|
4981
|
+
Accepts children: no
|
|
4980
4982
|
Events: `change`
|
|
4981
4983
|
|
|
4982
4984
|
### Props
|
|
@@ -5009,10 +5011,10 @@ A specialized masked input for entering Canadian Social Insurance Numbers (SIN).
|
|
|
5009
5011
|
|
|
5010
5012
|
onChange stores the unmasked 9-digit SIN string (no spaces). The input automatically formats display as "XXX XXX XXX". Built-in SIN validation rules apply. Standalone — does not register with Form; use FormSin inside a Form instead.
|
|
5011
5013
|
|
|
5012
|
-
Catalog key: `Sin`
|
|
5013
|
-
Builder: `Sin`
|
|
5014
|
-
Props type: `SinProps`
|
|
5015
|
-
Accepts children: no
|
|
5014
|
+
Catalog key: `Sin`
|
|
5015
|
+
Builder: `Sin`
|
|
5016
|
+
Props type: `SinProps`
|
|
5017
|
+
Accepts children: no
|
|
5016
5018
|
Events: `change`, `blur`
|
|
5017
5019
|
|
|
5018
5020
|
### Props
|
|
@@ -5049,10 +5051,10 @@ An animated placeholder that mimics the shape of content while it loads, availab
|
|
|
5049
5051
|
|
|
5050
5052
|
Variant determines which size props apply: TEXT uses width/lines/gap/lineHeight, CIRCLE uses size, BOX uses width/height/borderRadius. For TEXT variant, lineHeight should be provided (e.g. "1.5em", "20px") to ensure proper height - without it the skeleton will have 0 height and be invisible. Skipped: typestyle (complex theme Typestyle object — use gap and lineHeight directly instead).
|
|
5051
5053
|
|
|
5052
|
-
Catalog key: `Skeleton`
|
|
5053
|
-
Builder: `Skeleton`
|
|
5054
|
-
Props type: `SkeletonProps`
|
|
5055
|
-
Accepts children: no
|
|
5054
|
+
Catalog key: `Skeleton`
|
|
5055
|
+
Builder: `Skeleton`
|
|
5056
|
+
Props type: `SkeletonProps`
|
|
5057
|
+
Accepts children: no
|
|
5056
5058
|
Events: _none_
|
|
5057
5059
|
|
|
5058
5060
|
### Props
|
|
@@ -5060,16 +5062,16 @@ Events: _none_
|
|
|
5060
5062
|
| Name | Required | Type | Description |
|
|
5061
5063
|
|---|---:|---|---|
|
|
5062
5064
|
| `animation` | no | [SkeletonAnimation](./definitions.md#skeletonanimation) | Loading animation style. Default: WAVE |
|
|
5063
|
-
| `borderRadius` | no | [
|
|
5064
|
-
| `gap` | no | [
|
|
5065
|
+
| `borderRadius` | no | [BoxRadius](./definitions.md#boxradius) | Border radius token (BOX variant) |
|
|
5066
|
+
| `gap` | no | [BoxGap](./definitions.md#boxgap) | Gap between lines when lines > 1 (TEXT variant). Spacing token. Default: 4px |
|
|
5065
5067
|
| `height` | no | number | Height in px (BOX variant) |
|
|
5066
5068
|
| `initialTimestamp` | no | number | Initial mount timestamp for animation delay calculation. Used to coordinate animations across multiple skeletons. Default: Date.now() |
|
|
5067
|
-
| `lineHeight` | no |
|
|
5069
|
+
| `lineHeight` | no | string \| number | Line height of text skeleton for pixel-perfect match (TEXT variant). Default: 15px |
|
|
5068
5070
|
| `lines` | no | number | Number of text lines (TEXT variant). Default: 1 |
|
|
5069
5071
|
| `show` | no | boolean | Whether the skeleton is loading. true renders the skeleton, false renders nothing. Default: true |
|
|
5070
5072
|
| `size` | no | number | Diameter in px (CIRCLE variant). Default: 40 |
|
|
5071
5073
|
| `variant` | no | [SkeletonVariant](./definitions.md#skeletonvariant) | Skeleton shape variant. Default: TEXT |
|
|
5072
|
-
| `width` | no |
|
|
5074
|
+
| `width` | no | string \| number | Width of the skeleton (number in px or CSS string) |
|
|
5073
5075
|
|
|
5074
5076
|
No additional properties.
|
|
5075
5077
|
|
|
@@ -5079,10 +5081,10 @@ An interactive control for selecting a single numeric value within a defined ran
|
|
|
5079
5081
|
|
|
5080
5082
|
onChange stores a number in state. Use min/max to define the range and step to set granularity. Set step to null to use marks as step positions. The marks prop accepts a Record<string, string> where keys are numeric positions and values are display labels. beforeChange fires when user starts dragging, afterChange fires when dragging ends. Standalone — does not register with Form; use FormSlider inside a Form instead.
|
|
5081
5083
|
|
|
5082
|
-
Catalog key: `Slider`
|
|
5083
|
-
Builder: `Slider`
|
|
5084
|
-
Props type: `SliderProps`
|
|
5085
|
-
Accepts children: no
|
|
5084
|
+
Catalog key: `Slider`
|
|
5085
|
+
Builder: `Slider`
|
|
5086
|
+
Props type: `SliderProps`
|
|
5087
|
+
Accepts children: no
|
|
5086
5088
|
Events: `change`, `blur`, `beforeChange`, `afterChange`
|
|
5087
5089
|
|
|
5088
5090
|
### Props
|
|
@@ -5118,10 +5120,10 @@ A passive notification that appears at the bottom of the screen to provide quick
|
|
|
5118
5120
|
|
|
5119
5121
|
SnackBar is imperative — it triggers a toast notification when isVisible becomes true. Bind isVisible to state and set it to true via a setState action to show the snackbar. The snackbar auto-dismisses after 7 seconds unless persist is true.
|
|
5120
5122
|
|
|
5121
|
-
Catalog key: `SnackBar`
|
|
5122
|
-
Builder: `SnackBar`
|
|
5123
|
-
Props type: `SnackBarProps`
|
|
5124
|
-
Accepts children: no
|
|
5123
|
+
Catalog key: `SnackBar`
|
|
5124
|
+
Builder: `SnackBar`
|
|
5125
|
+
Props type: `SnackBarProps`
|
|
5126
|
+
Accepts children: no
|
|
5125
5127
|
Events: `dismiss`
|
|
5126
5128
|
|
|
5127
5129
|
### Props
|
|
@@ -5145,10 +5147,10 @@ A progress indicator for communicating that a process or task is currently under
|
|
|
5145
5147
|
|
|
5146
5148
|
windowCentered uses absolute positioning (requires relative parent), fixedWindowCentered uses fixed positioning (viewport center). Skipped: stopInfiniteDomMutation (DataDog internal prop).
|
|
5147
5149
|
|
|
5148
|
-
Catalog key: `Spinner`
|
|
5149
|
-
Builder: `Spinner`
|
|
5150
|
-
Props type: `SpinnerProps`
|
|
5151
|
-
Accepts children: no
|
|
5150
|
+
Catalog key: `Spinner`
|
|
5151
|
+
Builder: `Spinner`
|
|
5152
|
+
Props type: `SpinnerProps`
|
|
5153
|
+
Accepts children: no
|
|
5152
5154
|
Events: _none_
|
|
5153
5155
|
|
|
5154
5156
|
### Props
|
|
@@ -5172,10 +5174,10 @@ A compound button that combines a primary action with a secondary trailing butto
|
|
|
5172
5174
|
|
|
5173
5175
|
The trailing section opens a dropdown when dropdownList is provided. Events: "press" fires on primary button click, "dropdownChange" fires when a dropdown item is selected with the selected value.
|
|
5174
5176
|
|
|
5175
|
-
Catalog key: `SplitButton`
|
|
5176
|
-
Builder: `SplitButton`
|
|
5177
|
-
Props type: `SplitButtonProps`
|
|
5178
|
-
Accepts children: no
|
|
5177
|
+
Catalog key: `SplitButton`
|
|
5178
|
+
Builder: `SplitButton`
|
|
5179
|
+
Props type: `SplitButtonProps`
|
|
5180
|
+
Accepts children: no
|
|
5179
5181
|
Events: `press`, `dropdownChange`
|
|
5180
5182
|
|
|
5181
5183
|
### Props
|
|
@@ -5224,10 +5226,10 @@ SplitPane creates a multi-pane layout container where child Pane components are
|
|
|
5224
5226
|
- 3 (TERTIARY): Optional content, collapses first
|
|
5225
5227
|
- Custom numbers: Use any number for fine-grained control (lower = higher importance)
|
|
5226
5228
|
|
|
5227
|
-
Catalog key: `SplitPane`
|
|
5228
|
-
Builder: `SplitPane`
|
|
5229
|
-
Props type: `SplitPaneProps`
|
|
5230
|
-
Accepts children: yes
|
|
5229
|
+
Catalog key: `SplitPane`
|
|
5230
|
+
Builder: `SplitPane`
|
|
5231
|
+
Props type: `SplitPaneProps`
|
|
5232
|
+
Accepts children: yes
|
|
5231
5233
|
Events: _none_
|
|
5232
5234
|
|
|
5233
5235
|
### Props
|
|
@@ -5236,7 +5238,7 @@ Events: _none_
|
|
|
5236
5238
|
|---|---:|---|---|
|
|
5237
5239
|
| `collapseBelow` | no | [CollapseBelow](./types.md#collapsebelow) | Configure when each priority level auto-collapses based on container width. Keys are priority numbers, values are breakpoint tokens. Use false to disable auto-collapse for a priority level |
|
|
5238
5240
|
| `disableResponsiveCollapse` | no | boolean | Disable all responsive auto-collapse behavior. When true, panes only collapse via user interaction or controlled props. Default: false |
|
|
5239
|
-
| `gap` | no | [
|
|
5241
|
+
| `gap` | no | [BoxGap](./definitions.md#boxgap) | Gap between panes as a spacing token. Default: 0 |
|
|
5240
5242
|
| `singlePaneOnVertical` | no | boolean | When true, only the PRIMARY pane is visible in vertical (mobile) layout. Other panes collapse and can be expanded by user. When false, panes stack vertically without collapsing. Default: true |
|
|
5241
5243
|
|
|
5242
5244
|
No additional properties.
|
|
@@ -5247,10 +5249,10 @@ A specialized masked input for collecting US Social Security Numbers (SSN). Auto
|
|
|
5247
5249
|
|
|
5248
5250
|
onChange stores the unmasked 9-digit SSN string (no hyphens). The input automatically formats display as XXX-XX-XXXX. Built-in SSN validation rules apply. Standalone — does not register with Form; use FormSsn inside a Form instead.
|
|
5249
5251
|
|
|
5250
|
-
Catalog key: `Ssn`
|
|
5251
|
-
Builder: `Ssn`
|
|
5252
|
-
Props type: `SsnProps`
|
|
5253
|
-
Accepts children: no
|
|
5252
|
+
Catalog key: `Ssn`
|
|
5253
|
+
Builder: `Ssn`
|
|
5254
|
+
Props type: `SsnProps`
|
|
5255
|
+
Accepts children: no
|
|
5254
5256
|
Events: `change`, `blur`
|
|
5255
5257
|
|
|
5256
5258
|
### Props
|
|
@@ -5287,10 +5289,10 @@ A static indicator of real-time state or condition, such as availability, progre
|
|
|
5287
5289
|
|
|
5288
5290
|
Status displays a colored dot alongside a text label to indicate the real-time state of an item, process, or workflow. Ideal for data table rows or lists where users need to assess status at a glance. Use appearance to convey semantic meaning: SUCCESS for completed/active, ERROR for failed/blocked, WARNING for needs-attention, PRIMARY/TERTIARY for neutral info, DISABLED for inactive. Use outlined to add a border for additional emphasis. Returns null if text is empty.
|
|
5289
5291
|
|
|
5290
|
-
Catalog key: `Status`
|
|
5291
|
-
Builder: `Status`
|
|
5292
|
-
Props type: `StatusProps`
|
|
5293
|
-
Accepts children: no
|
|
5292
|
+
Catalog key: `Status`
|
|
5293
|
+
Builder: `Status`
|
|
5294
|
+
Props type: `StatusProps`
|
|
5295
|
+
Accepts children: no
|
|
5294
5296
|
Events: _none_
|
|
5295
5297
|
|
|
5296
5298
|
### Props
|
|
@@ -5311,10 +5313,10 @@ A progress indicator that guides users through multi-step sequential workflows b
|
|
|
5311
5313
|
|
|
5312
5314
|
Emits "click" event when a step is clicked. Event data written to state: { index: number, type: "NORMAL" | "STANDALONE" } at the bound path before emitting.
|
|
5313
5315
|
|
|
5314
|
-
Catalog key: `Stepper`
|
|
5315
|
-
Builder: `Stepper`
|
|
5316
|
-
Props type: `StepperProps`
|
|
5317
|
-
Accepts children: no
|
|
5316
|
+
Catalog key: `Stepper`
|
|
5317
|
+
Builder: `Stepper`
|
|
5318
|
+
Props type: `StepperProps`
|
|
5319
|
+
Accepts children: no
|
|
5318
5320
|
Events: `click`
|
|
5319
5321
|
|
|
5320
5322
|
### Props
|
|
@@ -5339,10 +5341,10 @@ A prominent card-like action button with title, caption, icon or image, and opti
|
|
|
5339
5341
|
|
|
5340
5342
|
onClick emits 'press' event. When 'to' prop is provided, button handles navigation automatically. Use 'icon' for Icon.TYPES string or 'image' for an image URL — do not use both simultaneously. Badge types map to BADGE_TYPES enum on the Pebble component.
|
|
5341
5343
|
|
|
5342
|
-
Catalog key: `SupportButton`
|
|
5343
|
-
Builder: `SupportButton`
|
|
5344
|
-
Props type: `SupportButtonProps`
|
|
5345
|
-
Accepts children: no
|
|
5344
|
+
Catalog key: `SupportButton`
|
|
5345
|
+
Builder: `SupportButton`
|
|
5346
|
+
Props type: `SupportButtonProps`
|
|
5347
|
+
Accepts children: no
|
|
5346
5348
|
Events: `press`
|
|
5347
5349
|
|
|
5348
5350
|
### Props
|
|
@@ -5357,7 +5359,7 @@ Events: `press`
|
|
|
5357
5359
|
| `imageBackground` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Surface color token for the avatar when using an image |
|
|
5358
5360
|
| `testId` | no | string | Sets data-testid attribute. Default: test_support_button |
|
|
5359
5361
|
| `title` | yes | string | Primary text label displayed on the button |
|
|
5360
|
-
| `to` | no |
|
|
5362
|
+
| `to` | no | string \| [SupportButtonTo](./types.md#supportbuttonto) | Navigation destination. When provided, button handles navigation automatically |
|
|
5361
5363
|
|
|
5362
5364
|
No additional properties.
|
|
5363
5365
|
|
|
@@ -5367,10 +5369,10 @@ A button-group input for collecting ratings or opinions on a Likert scale (e.g.
|
|
|
5367
5369
|
|
|
5368
5370
|
onChange stores a single value when isMulti is false, or an array of values when isMulti is true. The list prop must be an array of objects with value (required) and label (optional) keys. Use rangeLabels to add descriptive labels for the lowest and highest options.
|
|
5369
5371
|
|
|
5370
|
-
Catalog key: `Survey`
|
|
5371
|
-
Builder: `Survey`
|
|
5372
|
-
Props type: `SurveyProps`
|
|
5373
|
-
Accepts children: no
|
|
5372
|
+
Catalog key: `Survey`
|
|
5373
|
+
Builder: `Survey`
|
|
5374
|
+
Props type: `SurveyProps`
|
|
5375
|
+
Accepts children: no
|
|
5374
5376
|
Events: `change`
|
|
5375
5377
|
|
|
5376
5378
|
### Props
|
|
@@ -5390,7 +5392,7 @@ Events: `change`
|
|
|
5390
5392
|
| `rangeLabels` | no | [SurveyRangeLabel](./types.md#surveyrangelabel) | Labels for lowest and highest options |
|
|
5391
5393
|
| `theme` | no | [FormSurveyTheme](./definitions.md#formsurveytheme) | Survey theme. TWO_LINE stacks label below value |
|
|
5392
5394
|
| `validateOn` | no | [AppGroupSelectValidateOn](./definitions.md#appgroupselectvalidateon) | When to run validation checks. Requires checks to be set |
|
|
5393
|
-
| `value` | no |
|
|
5395
|
+
| `value` | no | string \| number \| string \| number[] | Selected value(s). Single value when isMulti is false, array when true |
|
|
5394
5396
|
|
|
5395
5397
|
No additional properties.
|
|
5396
5398
|
|
|
@@ -5400,10 +5402,10 @@ A toggle that lets users switch instantly between on and off states. Use for act
|
|
|
5400
5402
|
|
|
5401
5403
|
onChange stores a boolean (true/false) in state. Defaults to false when no value is set. Prefer Switch over Checkbox for on/off settings; use Checkbox for agreement/consent scenarios. Standalone — does not register with Form; use FormSwitch inside a Form instead.
|
|
5402
5404
|
|
|
5403
|
-
Catalog key: `Switch`
|
|
5404
|
-
Builder: `Switch`
|
|
5405
|
-
Props type: `SwitchProps`
|
|
5406
|
-
Accepts children: no
|
|
5405
|
+
Catalog key: `Switch`
|
|
5406
|
+
Builder: `Switch`
|
|
5407
|
+
Props type: `SwitchProps`
|
|
5408
|
+
Accepts children: no
|
|
5407
5409
|
Events: `change`, `blur`
|
|
5408
5410
|
|
|
5409
5411
|
### Props
|
|
@@ -5435,10 +5437,10 @@ Labeled controls for alternating between related views within the same page or c
|
|
|
5435
5437
|
|
|
5436
5438
|
Use for view switching and entry path selection. Tab content is managed separately via conditional rendering based on the selected value in state. Type options: BASIC (standard tabs), SWITCH (toggle-style), LINK (navigation-style), SWITCH_WITH_ICON_ONLY (icon-only toggles). Tab items can include icon, badge, tip, and disabled props. onChange stores the selected tab value in state.
|
|
5437
5439
|
|
|
5438
|
-
Catalog key: `Tab`
|
|
5439
|
-
Builder: `Tab`
|
|
5440
|
-
Props type: `TabProps`
|
|
5441
|
-
Accepts children: no
|
|
5440
|
+
Catalog key: `Tab`
|
|
5441
|
+
Builder: `Tab`
|
|
5442
|
+
Props type: `TabProps`
|
|
5443
|
+
Accepts children: no
|
|
5442
5444
|
Events: `change`
|
|
5443
5445
|
|
|
5444
5446
|
### Props
|
|
@@ -5473,10 +5475,10 @@ A read-only data table for displaying moderately large amounts of information in
|
|
|
5473
5475
|
|
|
5474
5476
|
Data-driven table: columns define headers and keys, rows are objects keyed by column key. Cell values are rendered as text. Use align on columns to control text alignment. Set wrapText on columns to wrap long text. Use rowHeight to customize row heights.
|
|
5475
5477
|
|
|
5476
|
-
Catalog key: `TableBasic`
|
|
5477
|
-
Builder: `TableBasic`
|
|
5478
|
-
Props type: `TableBasicProps`
|
|
5479
|
-
Accepts children: no
|
|
5478
|
+
Catalog key: `TableBasic`
|
|
5479
|
+
Builder: `TableBasic`
|
|
5480
|
+
Props type: `TableBasicProps`
|
|
5481
|
+
Accepts children: no
|
|
5480
5482
|
Events: _none_
|
|
5481
5483
|
|
|
5482
5484
|
### Props
|
|
@@ -5495,10 +5497,10 @@ No additional properties.
|
|
|
5495
5497
|
|
|
5496
5498
|
A general-purpose text component for rendering body copy, descriptions, captions, and other non-heading text content. Defaults to a paragraph (<p>) with body-medium typestyle. Use Heading instead for section titles (h1–h6), and TitleCaption for a title paired with a subtitle.
|
|
5497
5499
|
|
|
5498
|
-
Catalog key: `Text`
|
|
5499
|
-
Builder: `Text`
|
|
5500
|
-
Props type: `TextProps`
|
|
5501
|
-
Accepts children: no
|
|
5500
|
+
Catalog key: `Text`
|
|
5501
|
+
Builder: `Text`
|
|
5502
|
+
Props type: `TextProps`
|
|
5503
|
+
Accepts children: no
|
|
5502
5504
|
Events: _none_
|
|
5503
5505
|
|
|
5504
5506
|
### Props
|
|
@@ -5525,10 +5527,10 @@ A multi-line text input for entering longer free-form text such as comments, des
|
|
|
5525
5527
|
|
|
5526
5528
|
onChange stores the text content as a plain string in state. Set hasCharsLimit with maxLength to display a character counter. Use theme="NO_BOX" for a borderless variant. Standalone — does not register with Form; use FormTextarea inside a Form instead.
|
|
5527
5529
|
|
|
5528
|
-
Catalog key: `Textarea`
|
|
5529
|
-
Builder: `Textarea`
|
|
5530
|
-
Props type: `TextareaProps`
|
|
5531
|
-
Accepts children: no
|
|
5530
|
+
Catalog key: `Textarea`
|
|
5531
|
+
Builder: `Textarea`
|
|
5532
|
+
Props type: `TextareaProps`
|
|
5533
|
+
Accepts children: no
|
|
5532
5534
|
Events: `change`, `blur`, `focus`
|
|
5533
5535
|
|
|
5534
5536
|
### Props
|
|
@@ -5572,10 +5574,10 @@ Use stringPadding to automatically pad values (e.g., "1" → "001" with {positio
|
|
|
5572
5574
|
ARIA attributes support accessibility - use aria-label, aria-labelledby, or aria-describedby for screen reader labels
|
|
5573
5575
|
Standalone — does not register with Form; use FormTextAutoSuggest inside a Form instead.
|
|
5574
5576
|
|
|
5575
|
-
Catalog key: `TextAutoSuggest`
|
|
5576
|
-
Builder: `TextAutoSuggest`
|
|
5577
|
-
Props type: `TextAutoSuggestProps`
|
|
5578
|
-
Accepts children: no
|
|
5577
|
+
Catalog key: `TextAutoSuggest`
|
|
5578
|
+
Builder: `TextAutoSuggest`
|
|
5579
|
+
Props type: `TextAutoSuggestProps`
|
|
5580
|
+
Accepts children: no
|
|
5579
5581
|
Events: `change`, `blur`, `focus`, `click`
|
|
5580
5582
|
|
|
5581
5583
|
### Props
|
|
@@ -5619,7 +5621,7 @@ Events: `change`, `blur`, `focus`, `click`
|
|
|
5619
5621
|
| `testId` | no | string | Test ID for automation |
|
|
5620
5622
|
| `theme` | no | string | Theme name from Input.Text.THEMES or custom theme |
|
|
5621
5623
|
| `validateOn` | no | [AppGroupSelectValidateOn](./definitions.md#appgroupselectvalidateon) | When to run validation checks. Requires checks to be set |
|
|
5622
|
-
| `value` | no |
|
|
5624
|
+
| `value` | no | string \| number | Current value bound to state |
|
|
5623
5625
|
|
|
5624
5626
|
No additional properties.
|
|
5625
5627
|
|
|
@@ -5629,10 +5631,10 @@ Displays extensive text or content in a compact area by clipping it at a specifi
|
|
|
5629
5631
|
|
|
5630
5632
|
Wrap long text or content in TextClip to clip it at maxHeight with an expand/collapse toggle. Pass maxHeight as a multiple of the line-height of your content for clean clipping.
|
|
5631
5633
|
|
|
5632
|
-
Catalog key: `TextClip`
|
|
5633
|
-
Builder: `TextClip`
|
|
5634
|
-
Props type: `TextClipProps`
|
|
5635
|
-
Accepts children: yes
|
|
5634
|
+
Catalog key: `TextClip`
|
|
5635
|
+
Builder: `TextClip`
|
|
5636
|
+
Props type: `TextClipProps`
|
|
5637
|
+
Accepts children: yes
|
|
5636
5638
|
Events: _none_
|
|
5637
5639
|
|
|
5638
5640
|
### Props
|
|
@@ -5659,10 +5661,10 @@ Use stringPadding to automatically pad values (e.g., "1" → "001" with {positio
|
|
|
5659
5661
|
ARIA attributes support accessibility - use aria-label or aria-labelledby for screen reader labels
|
|
5660
5662
|
Standalone — does not register with Form; use FormText inside a Form instead.
|
|
5661
5663
|
|
|
5662
|
-
Catalog key: `TextInput`
|
|
5663
|
-
Builder: `TextInput`
|
|
5664
|
-
Props type: `TextInputProps`
|
|
5665
|
-
Accepts children: no
|
|
5664
|
+
Catalog key: `TextInput`
|
|
5665
|
+
Builder: `TextInput`
|
|
5666
|
+
Props type: `TextInputProps`
|
|
5667
|
+
Accepts children: no
|
|
5666
5668
|
Events: `change`, `blur`, `focus`, `click`, `keydown`, `keyup`, `paste`, `mouseenter`, `mouseleave`
|
|
5667
5669
|
|
|
5668
5670
|
### Props
|
|
@@ -5722,10 +5724,10 @@ A read-only text block with a one-click action to copy its content to the clipbo
|
|
|
5722
5724
|
|
|
5723
5725
|
Type "Copy" shows a copy icon; "Download" shows a download icon and uses fileName. Use the "content" prop for plain text; pass children instead when you need rich content (the Download action reads the rendered text from the DOM, so children work for both variants). If both are provided, children take precedence.
|
|
5724
5726
|
|
|
5725
|
-
Catalog key: `TextSnippet`
|
|
5726
|
-
Builder: `TextSnippet`
|
|
5727
|
-
Props type: `TextSnippetProps`
|
|
5728
|
-
Accepts children: yes
|
|
5727
|
+
Catalog key: `TextSnippet`
|
|
5728
|
+
Builder: `TextSnippet`
|
|
5729
|
+
Props type: `TextSnippetProps`
|
|
5730
|
+
Accepts children: yes
|
|
5729
5731
|
Events: _none_
|
|
5730
5732
|
|
|
5731
5733
|
### Props
|
|
@@ -5746,10 +5748,10 @@ A form input for entering or selecting a specific time of day. Supports typed en
|
|
|
5746
5748
|
|
|
5747
5749
|
onChange stores a time string in state. The format depends on shouldReturnISO — when true, an ISO 8601 string is stored; otherwise the component returns the value as-is. Use timezone to display the time relative to a specific IANA timezone. Standalone — does not register with Form; use FormTime inside a Form instead.
|
|
5748
5750
|
|
|
5749
|
-
Catalog key: `Time`
|
|
5750
|
-
Builder: `Time`
|
|
5751
|
-
Props type: `TimeProps`
|
|
5752
|
-
Accepts children: no
|
|
5751
|
+
Catalog key: `Time`
|
|
5752
|
+
Builder: `Time`
|
|
5753
|
+
Props type: `TimeProps`
|
|
5754
|
+
Accepts children: no
|
|
5753
5755
|
Events: `change`, `blur`
|
|
5754
5756
|
|
|
5755
5757
|
### Props
|
|
@@ -5792,10 +5794,10 @@ A time range input for selecting a start and end time pair, such as work schedul
|
|
|
5792
5794
|
|
|
5793
5795
|
onChange stores a tuple [startTime, endTime] in state where each time is an ISO 8601 string with UTC offset (e.g. "2022-03-31T14:30:00.000+00:00") or null. Use timezone to display times relative to a specific IANA timezone. When end time is on the next day, a next-day indicator is shown unless hideDayDifference is true. Set canClear to show a clear button that resets both times to null.
|
|
5794
5796
|
|
|
5795
|
-
Catalog key: `TimeRange`
|
|
5796
|
-
Builder: `TimeRange`
|
|
5797
|
-
Props type: `TimeRangeProps`
|
|
5798
|
-
Accepts children: no
|
|
5797
|
+
Catalog key: `TimeRange`
|
|
5798
|
+
Builder: `TimeRange`
|
|
5799
|
+
Props type: `TimeRangeProps`
|
|
5800
|
+
Accepts children: no
|
|
5799
5801
|
Events: `change`, `blur`
|
|
5800
5802
|
|
|
5801
5803
|
### Props
|
|
@@ -5836,10 +5838,10 @@ A specialized select component for choosing a timezone. Lists all IANA timezones
|
|
|
5836
5838
|
|
|
5837
5839
|
onChange stores an IANA timezone identifier string (e.g. "America/New_York") in state. The component lists all available timezones with search support. Use referenceDate to calculate timezone offsets for a specific point in time (accounts for daylight saving).
|
|
5838
5840
|
|
|
5839
|
-
Catalog key: `Timezone`
|
|
5840
|
-
Builder: `Timezone`
|
|
5841
|
-
Props type: `TimezoneProps`
|
|
5842
|
-
Accepts children: no
|
|
5841
|
+
Catalog key: `Timezone`
|
|
5842
|
+
Builder: `Timezone`
|
|
5843
|
+
Props type: `TimezoneProps`
|
|
5844
|
+
Accepts children: no
|
|
5843
5845
|
Events: `change`, `blur`, `focus`
|
|
5844
5846
|
|
|
5845
5847
|
### Props
|
|
@@ -5878,10 +5880,10 @@ A supportive floating text box that offers contextual details about an associate
|
|
|
5878
5880
|
|
|
5879
5881
|
Wrap any element with Tip to show a tooltip on hover. The child element is the hover target. Use isVisible to control tooltip programmatically via state binding. Skipped: padding/className/truncateClassName (CSS overrides), shallSkipOverflowY (internal overflow), isMobileDevice/shouldPop (function props), middleware/overwriteMiddleware (Popper internals), primaryAction/secondaryAction (deprecated TipAction objects with onClick callbacks), persist (deprecated, always true).
|
|
5880
5882
|
|
|
5881
|
-
Catalog key: `Tip`
|
|
5882
|
-
Builder: `Tip`
|
|
5883
|
-
Props type: `TipProps`
|
|
5884
|
-
Accepts children: yes
|
|
5883
|
+
Catalog key: `Tip`
|
|
5884
|
+
Builder: `Tip`
|
|
5885
|
+
Props type: `TipProps`
|
|
5886
|
+
Accepts children: yes
|
|
5885
5887
|
Events: _none_
|
|
5886
5888
|
|
|
5887
5889
|
### Props
|
|
@@ -5895,8 +5897,8 @@ Events: _none_
|
|
|
5895
5897
|
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
|
|
5896
5898
|
| `isPositionFixed` | no | boolean | Use fixed positioning for the tooltip. Default: false |
|
|
5897
5899
|
| `isVisible` | no | boolean | Control tooltip visibility from parent. Overrides hover behavior when set |
|
|
5898
|
-
| `maxHeight` | no |
|
|
5899
|
-
| `maxWidth` | no |
|
|
5900
|
+
| `maxHeight` | no | number \| string | Max height of tooltip content. Number in px or CSS string |
|
|
5901
|
+
| `maxWidth` | no | number \| string | Max width of tooltip. Number in px or CSS string. Default: 360 |
|
|
5900
5902
|
| `onlyIfChildOverflow` | no | boolean | Only show tooltip if a child element overflows. Default: false |
|
|
5901
5903
|
| `onlyIfOverflow` | no | boolean | Only show tooltip if the trigger element overflows. Default: false |
|
|
5902
5904
|
| `placement` | no | [TipPlacement](./definitions.md#tipplacement) | Tooltip position relative to child. Default: bottom |
|
|
@@ -5912,10 +5914,10 @@ A compact title-and-caption pair for displaying a primary label with an optional
|
|
|
5912
5914
|
|
|
5913
5915
|
TitleCaption renders a title with an optional caption below it. Use captionColor to override the caption text color with a Pebble text/icon color token. The component automatically shows a tooltip when text overflows.
|
|
5914
5916
|
|
|
5915
|
-
Catalog key: `TitleCaption`
|
|
5916
|
-
Builder: `TitleCaption`
|
|
5917
|
-
Props type: `TitleCaptionProps`
|
|
5918
|
-
Accepts children: no
|
|
5917
|
+
Catalog key: `TitleCaption`
|
|
5918
|
+
Builder: `TitleCaption`
|
|
5919
|
+
Props type: `TitleCaptionProps`
|
|
5920
|
+
Accepts children: no
|
|
5919
5921
|
Events: _none_
|
|
5920
5922
|
|
|
5921
5923
|
### Props
|
|
@@ -5934,10 +5936,10 @@ A chevron arrow indicator that toggles between down (collapsed) and up (expanded
|
|
|
5934
5936
|
|
|
5935
5937
|
ToggleableArrow wraps Atoms.ToggleableArrow from Pebble. It renders a chevron icon that visually toggles between pointing down (collapsed) and up (expanded). Use isArrowDown to control the direction. When used without onChange, the component manages its own toggle state on click. Supply arrowDownColor and arrowUpColor to customize the icon color per state. Use horizontalCollapsedPosition to show the arrow horizontally when collapsed.
|
|
5936
5938
|
|
|
5937
|
-
Catalog key: `ToggleableArrow`
|
|
5938
|
-
Builder: `ToggleableArrow`
|
|
5939
|
-
Props type: `ToggleableArrowProps`
|
|
5940
|
-
Accepts children: no
|
|
5939
|
+
Catalog key: `ToggleableArrow`
|
|
5940
|
+
Builder: `ToggleableArrow`
|
|
5941
|
+
Props type: `ToggleableArrowProps`
|
|
5942
|
+
Accepts children: no
|
|
5941
5943
|
Events: _none_
|
|
5942
5944
|
|
|
5943
5945
|
### Props
|
|
@@ -5965,10 +5967,10 @@ A hierarchical selector for choosing from a tree-structured list of parent-child
|
|
|
5965
5967
|
|
|
5966
5968
|
onChange stores a single value string when isMulti is false, or an array of value strings when isMulti is true. The list prop must be a flat array where each item has a value (unique ID) and parent (parent value or null for root). The tree builds its hierarchy from these parent references. When footer is provided, clicking the footer button emits footerAction event. Use aria-* props for accessibility labeling.
|
|
5967
5969
|
|
|
5968
|
-
Catalog key: `Tree`
|
|
5969
|
-
Builder: `Tree`
|
|
5970
|
-
Props type: `TreeProps`
|
|
5971
|
-
Accepts children: no
|
|
5970
|
+
Catalog key: `Tree`
|
|
5971
|
+
Builder: `Tree`
|
|
5972
|
+
Props type: `TreeProps`
|
|
5973
|
+
Accepts children: no
|
|
5972
5974
|
Events: `change`, `footerAction`
|
|
5973
5975
|
|
|
5974
5976
|
### Props
|
|
@@ -6002,7 +6004,7 @@ Events: `change`, `footerAction`
|
|
|
6002
6004
|
| `size` | no | [AppGroupSelectSize](./definitions.md#appgroupselectsize) | Input size. Options: XS, S, M, L. Default: M |
|
|
6003
6005
|
| `theme` | no | [FormTreeTheme](./definitions.md#formtreetheme) | Tree theme for styling variants |
|
|
6004
6006
|
| `validateOn` | no | [AppGroupSelectValidateOn](./definitions.md#appgroupselectvalidateon) | When to run validation checks. Requires checks to be set |
|
|
6005
|
-
| `value` | no |
|
|
6007
|
+
| `value` | no | string \| string[] | Selected value(s). Single string when isMulti is false, array when true |
|
|
6006
6008
|
|
|
6007
6009
|
No additional properties.
|
|
6008
6010
|
|
|
@@ -6012,10 +6014,10 @@ A dropdown select component with a hierarchical tree structure for choosing from
|
|
|
6012
6014
|
|
|
6013
6015
|
onChange stores a single value string when isMulti is false, or an array of value strings when isMulti is true. The list prop must be a flat array where each item has a value (unique ID) and parent (parent value or null for root). Unlike Tree, TreeSelect renders as a dropdown trigger with search built in.
|
|
6014
6016
|
|
|
6015
|
-
Catalog key: `TreeSelect`
|
|
6016
|
-
Builder: `TreeSelect`
|
|
6017
|
-
Props type: `TreeSelectProps`
|
|
6018
|
-
Accepts children: no
|
|
6017
|
+
Catalog key: `TreeSelect`
|
|
6018
|
+
Builder: `TreeSelect`
|
|
6019
|
+
Props type: `TreeSelectProps`
|
|
6020
|
+
Accepts children: no
|
|
6019
6021
|
Events: `change`
|
|
6020
6022
|
|
|
6021
6023
|
### Props
|
|
@@ -6045,7 +6047,7 @@ Events: `change`
|
|
|
6045
6047
|
| `isRequired` | no | boolean | Marks the field as required |
|
|
6046
6048
|
| `label` | no | string | Label text above the input |
|
|
6047
6049
|
| `list` | yes | [TreeSelectList](./types.md#treeselectlist)[] | Flat array of tree items with parent references. Root items have parent: null, children reference parent value |
|
|
6048
|
-
| `maxHeight` | no |
|
|
6050
|
+
| `maxHeight` | no | string \| number | Max height of tags container (CSS value) |
|
|
6049
6051
|
| `placeholder` | no | string | Placeholder text when no selection |
|
|
6050
6052
|
| `placement` | no | [FormTreeSelectPlacement](./definitions.md#formtreeselectplacement) | Dropdown position. Default: bottom-end |
|
|
6051
6053
|
| `selectedOptionsModalClassName` | no | string | Class name for selected options modal (multi-select only) |
|
|
@@ -6065,10 +6067,10 @@ Embedded video player with 16:9 aspect ratio
|
|
|
6065
6067
|
|
|
6066
6068
|
Video embeds an iframe in a 16:9 aspect ratio. Use embed URLs for YouTube/Vimeo (not regular watch URLs).
|
|
6067
6069
|
|
|
6068
|
-
Catalog key: `Video`
|
|
6069
|
-
Builder: `Video`
|
|
6070
|
-
Props type: `VideoProps`
|
|
6071
|
-
Accepts children: no
|
|
6070
|
+
Catalog key: `Video`
|
|
6071
|
+
Builder: `Video`
|
|
6072
|
+
Props type: `VideoProps`
|
|
6073
|
+
Accepts children: no
|
|
6072
6074
|
Events: _none_
|
|
6073
6075
|
|
|
6074
6076
|
### Props
|
|
@@ -6087,10 +6089,10 @@ No additional properties.
|
|
|
6087
6089
|
|
|
6088
6090
|
Vertical stack layout that arranges children top-to-bottom in a column with token-based spacing. Use for stacking elements vertically — e.g. form field groups, page sections, or lists of content blocks. Prefer HStack for horizontal side-by-side arrangement and Box for complex layouts needing custom dimensions, borders, or backgrounds.
|
|
6089
6091
|
|
|
6090
|
-
Catalog key: `VStack`
|
|
6091
|
-
Builder: `VStack`
|
|
6092
|
-
Props type: `VStackProps`
|
|
6093
|
-
Accepts children: yes
|
|
6092
|
+
Catalog key: `VStack`
|
|
6093
|
+
Builder: `VStack`
|
|
6094
|
+
Props type: `VStackProps`
|
|
6095
|
+
Accepts children: yes
|
|
6094
6096
|
Events: _none_
|
|
6095
6097
|
|
|
6096
6098
|
### Props
|
|
@@ -6100,23 +6102,23 @@ Events: _none_
|
|
|
6100
6102
|
| `align` | no | [HStackAlign](./definitions.md#hstackalign) | Cross-axis alignment |
|
|
6101
6103
|
| `alignSelf` | no | [HStackAlignSelf](./definitions.md#hstackalignself) | Align self override when inside a flex parent |
|
|
6102
6104
|
| `backgroundColor` | no | [AvatarFlagSurfaceColor](./definitions.md#avatarflagsurfacecolor) | Background surface color token |
|
|
6103
|
-
| `basis` | no |
|
|
6105
|
+
| `basis` | no | number \| string | Flex basis value |
|
|
6104
6106
|
| `boxSizing` | no | [HStackBoxSizing](./definitions.md#hstackboxsizing) | Box sizing model |
|
|
6105
6107
|
| `color` | no | [ActionCardIconColor](./definitions.md#actioncardiconcolor) | Text/icon color token |
|
|
6106
|
-
| `gap` | no | [
|
|
6108
|
+
| `gap` | no | [BoxGap](./definitions.md#boxgap) | Spacing token for gap between children |
|
|
6107
6109
|
| `grow` | no | number | Flex grow factor |
|
|
6108
|
-
| `height` | no |
|
|
6110
|
+
| `height` | no | number \| string | Height in pixels (number) or CSS string |
|
|
6109
6111
|
| `justify` | no | [HStackJustify](./definitions.md#hstackjustify) | Main-axis alignment |
|
|
6110
|
-
| `margin` | no |
|
|
6111
|
-
| `maxHeight` | no |
|
|
6112
|
-
| `maxWidth` | no |
|
|
6113
|
-
| `minHeight` | no |
|
|
6114
|
-
| `minWidth` | no |
|
|
6112
|
+
| `margin` | no | [BoxGap](./definitions.md#boxgap) \| [VStackMargin](./types.md#vstackmargin) | Margin as a spacing token or directional spacing-token object {top, right, bottom, left} |
|
|
6113
|
+
| `maxHeight` | no | number \| string | Max height in pixels or CSS string |
|
|
6114
|
+
| `maxWidth` | no | number \| string | Max width in pixels or CSS string |
|
|
6115
|
+
| `minHeight` | no | number \| string | Min height in pixels or CSS string |
|
|
6116
|
+
| `minWidth` | no | number \| string | Min width in pixels or CSS string |
|
|
6115
6117
|
| `overflow` | no | [HStackOverflow](./definitions.md#hstackoverflow) | Overflow behavior |
|
|
6116
|
-
| `padding` | no |
|
|
6117
|
-
| `radius` | no | [
|
|
6118
|
+
| `padding` | no | [BoxGap](./definitions.md#boxgap) \| [VStackPadding](./types.md#vstackpadding) | Padding as a spacing token or directional spacing-token object {top, right, bottom, left} |
|
|
6119
|
+
| `radius` | no | [BoxRadius](./definitions.md#boxradius) | Border radius token |
|
|
6118
6120
|
| `shrink` | no | number | Flex shrink factor |
|
|
6119
|
-
| `width` | no |
|
|
6121
|
+
| `width` | no | number \| string | Width in pixels (number) or CSS string |
|
|
6120
6122
|
| `wrap` | no | [ButtonGroupFlexWrap](./definitions.md#buttongroupflexwrap) | Flex wrap behavior |
|
|
6121
6123
|
|
|
6122
6124
|
No additional properties.
|
|
@@ -6135,10 +6137,10 @@ Use prefix/suffix for icons - pass Icon.TYPES names like "EMAIL_OUTLINE" or text
|
|
|
6135
6137
|
Supports basic ARIA attributes (aria-label, aria-labelledby, aria-describedby) for accessibility
|
|
6136
6138
|
Standalone — does not register with Form; use FormWorkEmail inside a Form instead.
|
|
6137
6139
|
|
|
6138
|
-
Catalog key: `WorkEmail`
|
|
6139
|
-
Builder: `WorkEmail`
|
|
6140
|
-
Props type: `WorkEmailProps`
|
|
6141
|
-
Accepts children: no
|
|
6140
|
+
Catalog key: `WorkEmail`
|
|
6141
|
+
Builder: `WorkEmail`
|
|
6142
|
+
Props type: `WorkEmailProps`
|
|
6143
|
+
Accepts children: no
|
|
6142
6144
|
Events: `change`, `blur`, `focus`, `click`, `keydown`, `keyup`, `paste`, `mouseenter`, `mouseleave`
|
|
6143
6145
|
|
|
6144
6146
|
### Props
|