@rippling/pebble-sdui-web 0.9.2 → 0.14.0
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/core/action-params.d.ts +96 -0
- package/dist/catalogs/core/actions.d.ts +21 -0
- package/dist/catalogs/core/catalog.d.ts +33 -0
- package/dist/catalogs/core/component-events.d.ts +193 -0
- package/dist/catalogs/core/component-props.d.ts +5312 -0
- package/dist/catalogs/core/components.d.ts +194 -0
- package/dist/catalogs/core/function-params.d.ts +5 -0
- package/dist/catalogs/core/functions.d.ts +5 -0
- package/dist/catalogs/core/index.cjs +137 -0
- package/dist/catalogs/core/index.cjs.map +1 -0
- package/dist/catalogs/core/index.d.ts +13 -0
- package/dist/catalogs/core/index.js +31848 -0
- package/dist/catalogs/core/index.js.map +1 -0
- package/dist/catalogs/core/render.d.ts +20 -0
- package/dist/catalogs/custom-apps/catalog.d.ts +1 -1
- package/dist/catalogs/custom-apps/component-events.d.ts +3 -3
- package/dist/catalogs/custom-apps/component-props.d.ts +126 -31
- package/dist/catalogs/custom-apps/index.cjs +2 -2
- package/dist/catalogs/custom-apps/index.cjs.map +1 -1
- package/dist/catalogs/custom-apps/index.d.ts +1 -1
- package/dist/catalogs/custom-apps/index.js +715 -156
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/core/actions.md +645 -0
- package/dist/docs/typescript/web/catalogs/core/components.md +6580 -0
- package/dist/docs/typescript/web/catalogs/core/computed-functions.md +6 -0
- package/dist/docs/typescript/web/catalogs/core/definitions.md +4431 -0
- package/dist/docs/typescript/web/catalogs/core/readme.md +16 -0
- package/dist/docs/typescript/web/catalogs/core/types.md +4833 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +65 -96
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +185 -31
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +60 -49
- package/dist/sdk-docs.cjs +41 -10
- package/dist/sdk-docs.cjs.map +1 -1
- package/dist/sdk-docs.js +41 -10
- package/dist/sdk-docs.js.map +1 -1
- package/package.json +6 -6
|
@@ -365,6 +365,7 @@ Box is a flexible layout container built on CSS flexbox. It provides extensive s
|
|
|
365
365
|
- Dimensions (width, height, min/max variants)
|
|
366
366
|
- Colors (backgroundColor, color)
|
|
367
367
|
- Border radius (uniform or per-corner)
|
|
368
|
+
- Positioned layers can use inset and pointerEvents to control placement and hit testing
|
|
368
369
|
- Dimension props support both number (pixels) and string (CSS) values
|
|
369
370
|
- containerType can define the Box as a CSS query container
|
|
370
371
|
|
|
@@ -408,6 +409,7 @@ Events: _none_
|
|
|
408
409
|
| `grow` | no | number \| string | Flex grow factor. Number value |
|
|
409
410
|
| `height` | no | number \| string | Height value. Number (pixels) or CSS string (e.g., "100px", "50%") |
|
|
410
411
|
| `id` | no | string | HTML id attribute |
|
|
412
|
+
| `inset` | no | number \| string | Offsets a positioned Box on all sides. Number (pixels) or CSS string |
|
|
411
413
|
| `isInline` | no | boolean | Use inline-flex instead of flex. Default: false |
|
|
412
414
|
| `justify` | no | string | Justify content on main axis. CSS justify-content value (e.g., "center", "space-between") |
|
|
413
415
|
| `margin` | no | [BoxGap](./definitions.md#boxgap) \| [BoxMargin](./types.md#boxmargin) | Margin value. Spacing token or {top, right, bottom, left} spacing-token object |
|
|
@@ -417,6 +419,7 @@ Events: _none_
|
|
|
417
419
|
| `minWidth` | no | number \| string | Minimum width value. Number (pixels) or CSS string |
|
|
418
420
|
| `overflow` | no | string | CSS overflow value (e.g., "hidden", "auto", "scroll") |
|
|
419
421
|
| `padding` | no | [BoxGap](./definitions.md#boxgap) \| [BoxPadding](./types.md#boxpadding) | Padding value. Spacing token or {top, right, bottom, left} spacing-token object |
|
|
422
|
+
| `pointerEvents` | no | string | CSS pointer-events value controlling whether the Box receives pointer input |
|
|
420
423
|
| `position` | no | string | CSS position value (e.g., "relative", "absolute", "fixed") |
|
|
421
424
|
| `radius` | no | [BoxRadius](./definitions.md#boxradius) \| [BoxRadiu](./types.md#boxradiu) | Border radius. Radius token or {topLeft, topRight, bottomLeft, bottomRight} radius-token object |
|
|
422
425
|
| `reverse` | no | boolean | Reverse the flex direction. Combines with direction prop |
|
|
@@ -533,6 +536,7 @@ Events: `press`, `pressWhileDisabled`, `mouseEnter`, `mouseLeave`
|
|
|
533
536
|
| `aria-labelledby` | no | string | ID of element that labels this button |
|
|
534
537
|
| `aria-pressed` | no | boolean \| [ButtonAriaPressed](./definitions.md#buttonariapressed) | Indicates button pressed state (for toggle buttons) |
|
|
535
538
|
| `badge` | no | string | Badge text shown on the button |
|
|
539
|
+
| `contentAlignment` | no | [ButtonContentAlignment](./definitions.md#buttoncontentalignment) | Horizontal alignment of button content. Default: CENTER |
|
|
536
540
|
| `fontInherit` | no | boolean | When variant is TEXT, inherit font from parent element. Only works with TEXT variant. Default: false |
|
|
537
541
|
| `icon` | no | string \| [ButtonIcon](./types.md#buttonicon) | Icon to show in button. Can be icon name string or object with type, color, alignment |
|
|
538
542
|
| `id` | no | string | DOM id selector for the button element |
|
|
@@ -626,7 +630,7 @@ Events: `edit`, `delete`, `add`, `click`, `action`
|
|
|
626
630
|
| `content` | no | string | Text content to display in the card body |
|
|
627
631
|
| `isAddCard` | no | boolean | Render as add card with plus icon. Emits "add" event when clicked. Default: false |
|
|
628
632
|
| `isDisabled` | no | boolean | Whether the card is disabled. Default: false |
|
|
629
|
-
| `minCardHeight` | no | number | Minimum height of card
|
|
633
|
+
| `minCardHeight` | no | number \| string | Minimum height of card. Number values are pixels. Default: 150 |
|
|
630
634
|
| `padding` | no | 0 \| 8 \| 16 \| 24 \| 32 \| string | Padding for layout mode. Supports Card.Layout PADDINGS values or CSS string |
|
|
631
635
|
| `selectedActionId` | no | string | Bound state path for the selected action id. Written before "action" event fires |
|
|
632
636
|
| `showDelete` | no | boolean | Show delete button. Emits "delete" event when clicked. Default: false |
|
|
@@ -658,7 +662,7 @@ Events: _none_
|
|
|
658
662
|
|
|
659
663
|
| Name | Required | Type | Description |
|
|
660
664
|
|---|---:|---|---|
|
|
661
|
-
| `minCardHeight` | no | number | Minimum height of each card
|
|
665
|
+
| `minCardHeight` | no | number \| string | Minimum height of each card. Number values are pixels. Default: 150 |
|
|
662
666
|
| `placement` | no | [CardGroupPlacement](./definitions.md#cardgroupplacement) | Horizontal alignment of cards within the container. One of: HORIZONTALLY_LEFT, HORIZONTALLY_CENTER, HORIZONTALLY_RIGHT, HORIZONTALLY_SPACE_BETWEEN |
|
|
663
667
|
|
|
664
668
|
No additional properties.
|
|
@@ -3673,15 +3677,15 @@ No additional properties.
|
|
|
3673
3677
|
|
|
3674
3678
|
## ItemNavigator
|
|
3675
3679
|
|
|
3676
|
-
A compact
|
|
3680
|
+
A compact control for stepping through items one at a time, with either an "X of Y items" label or clickable position dots. Use for sequential item-by-item navigation such as cycling through detail views, carousel items, search results, or review queues — not for page-based navigation (use Pagination instead).
|
|
3677
3681
|
|
|
3678
|
-
ItemNavigator displays "X of Y items" with previous/next buttons. Bind currentItemIndex to state. The next
|
|
3682
|
+
ItemNavigator displays either "X of Y items" or clickable position dots with previous/next buttons. Bind currentItemIndex to state. The next, previous, and select events update currentItemIndex automatically. Previous is auto-disabled at index 0; next is auto-disabled at totalItems-1.
|
|
3679
3683
|
|
|
3680
3684
|
Catalog key: `ItemNavigator`
|
|
3681
3685
|
Builder: `ItemNavigator`
|
|
3682
3686
|
Props type: `ItemNavigatorProps`
|
|
3683
3687
|
Accepts children: no
|
|
3684
|
-
Events: `next`, `previous`
|
|
3688
|
+
Events: `next`, `previous`, `select`
|
|
3685
3689
|
|
|
3686
3690
|
### Props
|
|
3687
3691
|
|
|
@@ -3696,6 +3700,7 @@ Events: `next`, `previous`
|
|
|
3696
3700
|
| `prevDisabled` | no | boolean | Force-disable the previous button, overriding default logic |
|
|
3697
3701
|
| `prevTip` | no | string | Tooltip text for the previous button |
|
|
3698
3702
|
| `totalItems` | yes | number | Total number of items to navigate through |
|
|
3703
|
+
| `variant` | no | [ItemNavigatorVariant](./definitions.md#itemnavigatorvariant) | Display style: LABEL shows the item count; DOTS shows clickable position dots |
|
|
3699
3704
|
|
|
3700
3705
|
No additional properties.
|
|
3701
3706
|
|
|
@@ -3926,7 +3931,7 @@ Events: `edit`, `delete`, `click`, `action`
|
|
|
3926
3931
|
|---|---:|---|---|
|
|
3927
3932
|
| `actions` | no | [LocationCardAction](./types.md#locationcardaction)[] | Array of action objects {id, label, icon}. Displayed as dropdown options. Emits "action" event with clicked action id |
|
|
3928
3933
|
| `location` | yes | [Location](./types.md#location) | Location object with nickname and address. Required for displaying location information |
|
|
3929
|
-
| `minCardHeight` | no | number | Minimum height of card
|
|
3934
|
+
| `minCardHeight` | no | number \| string | Minimum height of card. Number values are pixels. Default: 150 |
|
|
3930
3935
|
| `selectedActionId` | no | string | Bound state path for the selected action id. Written before "action" event fires |
|
|
3931
3936
|
| `showDelete` | no | boolean | Show delete button. Emits "delete" event when clicked. Default: false |
|
|
3932
3937
|
| `showEdit` | no | boolean | Show edit button. Emits "edit" event when clicked. Default: false |
|
|
@@ -4474,76 +4479,52 @@ No additional properties.
|
|
|
4474
4479
|
|
|
4475
4480
|
## Pane
|
|
4476
4481
|
|
|
4477
|
-
|
|
4482
|
+
Define one adaptive pane
|
|
4478
4483
|
|
|
4479
|
-
Pane
|
|
4484
|
+
Pane must be a direct child of SplitPane and requires a stable sibling-unique id plus PRIMARY, SECONDARY, or TERTIARY priority.
|
|
4480
4485
|
|
|
4481
|
-
|
|
4482
|
-
-
|
|
4483
|
-
-
|
|
4484
|
-
-
|
|
4485
|
-
-
|
|
4486
|
-
|
|
4487
|
-
**State binding:**
|
|
4488
|
-
- collapsed: Bind to state path to control collapsed state. LLM writes boolean value on collapse/expand
|
|
4489
|
-
- dismissed: Bind to state path to control dismissed state. LLM writes boolean value when dismissed
|
|
4490
|
-
- Use defaultCollapsed/defaultDismissed for uncontrolled mode
|
|
4491
|
-
|
|
4492
|
-
**Events:**
|
|
4493
|
-
- collapsedChange: Fires when pane is collapsed or expanded. collapsed boolean is written to bound state before emit
|
|
4494
|
-
- dismiss: Fires when pane is dismissed. dismissed boolean is written to bound state before emit
|
|
4495
|
-
- resize: Fires when pane is resized via drag. width number is written to state path '/pane/width' before emit
|
|
4496
|
-
|
|
4497
|
-
**Event parameter access:**
|
|
4498
|
-
- onResize callback param 'width' (number) is written to state at path specified by LLM before 'resize' event fires
|
|
4499
|
-
- Access via { $state: '/your/path' } in event actions
|
|
4500
|
-
|
|
4501
|
-
**Size constraints:**
|
|
4502
|
-
- size: Horizontal constraints for desktop (default/min/max as CSS strings)
|
|
4503
|
-
- verticalSize: Vertical constraints for mobile stacked layout
|
|
4504
|
-
- If verticalSize not provided, falls back to size in vertical mode
|
|
4505
|
-
- Panes without size constraints fill remaining space using flex-grow
|
|
4506
|
-
|
|
4507
|
-
**Persistence:**
|
|
4508
|
-
- persistenceId: Provide a stable, unique ID to persist state across sessions
|
|
4509
|
-
- Persisted state includes: width, collapsed, dismissed
|
|
4510
|
-
- Storage key format: splitpane-{persistenceId}
|
|
4511
|
-
|
|
4512
|
-
**Collapsing:**
|
|
4513
|
-
- Collapsed panes show a 24px rail by default with expand button
|
|
4514
|
-
- hideCollapsedRail: true removes the rail completely (for custom expand triggers)
|
|
4515
|
-
- collapsible: Explicitly enable/disable user collapse (auto-inferred if not provided)
|
|
4516
|
-
|
|
4517
|
-
**Resizing:**
|
|
4518
|
-
- resizable: true enables drag-to-resize functionality
|
|
4519
|
-
- Drag handle appears between panes, respects min/max constraints
|
|
4520
|
-
- Keyboard navigation supported (arrow keys when handle focused)
|
|
4486
|
+
- Use sizing and reflowSizing descriptors instead of legacy size constraints. Dimensions are pixel numbers or { value, unit: 'percent' }.
|
|
4487
|
+
- Header, body, footer, controlTips, pin, and adaptation preserve the React descriptor shapes. Icon fields use current Icon.TYPES names.
|
|
4488
|
+
- Bind collapsed, dismissed, and committedSize for controlled state. The wrapper writes each new value before emitting collapsedChange, dismissedChange, or committedSizeChange.
|
|
4489
|
+
- presentation, headerActionId, and footerActionId are JSON-only callback metadata. Bind them to read the callback payload; they are written before presentationChange, headerAction, or footerAction emits.
|
|
4490
|
+
- Pane adaptation accepts Pebble breakpoint token names and the bottomDock, overlay, or hidden presentations.
|
|
4491
|
+
- Persistence belongs to the parent SplitPane.
|
|
4521
4492
|
|
|
4522
4493
|
Catalog key: `Pane`
|
|
4523
4494
|
Builder: `Pane`
|
|
4524
4495
|
Props type: `PaneProps`
|
|
4525
4496
|
Accepts children: yes
|
|
4526
|
-
Events: `collapsedChange`, `
|
|
4497
|
+
Events: `collapsedChange`, `dismissedChange`, `committedSizeChange`, `presentationChange`, `headerAction`, `footerAction`
|
|
4527
4498
|
|
|
4528
4499
|
### Props
|
|
4529
4500
|
|
|
4530
4501
|
| Name | Required | Type | Description |
|
|
4531
4502
|
|---|---:|---|---|
|
|
4532
|
-
| `
|
|
4533
|
-
| `
|
|
4534
|
-
| `
|
|
4535
|
-
| `
|
|
4536
|
-
| `
|
|
4537
|
-
| `
|
|
4538
|
-
| `
|
|
4539
|
-
| `
|
|
4540
|
-
| `
|
|
4541
|
-
| `
|
|
4542
|
-
| `
|
|
4543
|
-
| `
|
|
4544
|
-
| `
|
|
4545
|
-
| `
|
|
4546
|
-
| `
|
|
4503
|
+
| `adaptation` | no | Record<string, unknown>[] | Ordered breakpoint-token rules for bottomDock, overlay, or hidden presentation. |
|
|
4504
|
+
| `ariaLabel` | no | string | Accessible name for the pane region. |
|
|
4505
|
+
| `ariaLabelledBy` | no | string | Space-separated element id list that labels the pane region. |
|
|
4506
|
+
| `body` | no | Record<string, unknown> | Body scrolling and padding behavior. |
|
|
4507
|
+
| `collapseControl` | no | [PaneCollapseControl](./definitions.md#panecollapsecontrol) | Authored Collapse and temporary Hide control location while open. Every collapsed Pane restores from the shared divider rail. Auto uses the header when present and the divider otherwise; header falls back to the divider when no header exists. Default: auto. |
|
|
4508
|
+
| `collapsed` | no | boolean | Controlled explicit collapsed state. Bind for SDUI controlled use. |
|
|
4509
|
+
| `collapsible` | no | boolean | Enable explicit user collapse. Automatic adaptation remains independent. Default: false. |
|
|
4510
|
+
| `committedSize` | no | Record<string, unknown> | Controlled committed pixel size by orientation. Bind for SDUI controlled use. |
|
|
4511
|
+
| `controlTips` | no | Record<string, unknown> | Tooltip overrides for built-in Pane controls. |
|
|
4512
|
+
| `defaultCollapsed` | no | boolean | Initial explicit collapsed state for uncontrolled use. Default: false. |
|
|
4513
|
+
| `defaultCommittedSize` | no | Record<string, unknown> | Initial committed pixel size by orientation for uncontrolled use. |
|
|
4514
|
+
| `defaultDismissed` | no | boolean | Initial dismissed state for uncontrolled use. Default: false. |
|
|
4515
|
+
| `dismissControl` | no | [PaneCollapseControl](./definitions.md#panecollapsecontrol) | Authored dismiss control location. Auto uses the header when present and the divider otherwise; header also falls back to the divider when no header exists. Default: auto. |
|
|
4516
|
+
| `dismissed` | no | boolean | Controlled dismissed state. Bind for SDUI controlled use. |
|
|
4517
|
+
| `dismissible` | no | boolean | Enable explicit user dismissal. Default: false. |
|
|
4518
|
+
| `footer` | no | Record<string, unknown> | Serializable fixed footer rendered outside the scrolling body. |
|
|
4519
|
+
| `footerActionId` | no | string | JSON-only event metadata. Bind to receive the activated footer action id before footerAction emits. |
|
|
4520
|
+
| `header` | no | Record<string, unknown> | Serializable fixed header descriptor rendered outside the scrolling body. |
|
|
4521
|
+
| `headerActionId` | no | string | JSON-only event metadata. Bind to receive the activated header action id before headerAction emits. |
|
|
4522
|
+
| `id` | yes | string | Stable identifier, unique among direct siblings in one SplitPane. |
|
|
4523
|
+
| `pin` | no | [PanePin](./definitions.md#panepin) | Pin to a logical edge and exclude this pane from priority collapse. |
|
|
4524
|
+
| `presentation` | no | [PanePresentation](./definitions.md#panepresentation) | JSON-only event metadata. Bind to receive the resolved presentation before presentationChange emits; this does not control presentation. |
|
|
4525
|
+
| `priority` | yes | [PanePriority](./definitions.md#panepriority) | Retention priority: TERTIARY collapses first, then SECONDARY; PRIMARY remains open. |
|
|
4526
|
+
| `reflowSizing` | no | unknown | Sizing descriptor used while the parent SplitPane is reflowed. |
|
|
4527
|
+
| `sizing` | no | unknown | Docked sizing descriptor. Omit for equal fill sizing without implicit bounds. |
|
|
4547
4528
|
|
|
4548
4529
|
No additional properties.
|
|
4549
4530
|
|
|
@@ -5442,50 +5423,38 @@ No additional properties.
|
|
|
5442
5423
|
|
|
5443
5424
|
## SplitPane
|
|
5444
5425
|
|
|
5445
|
-
|
|
5426
|
+
Compose adaptive multi-pane layouts
|
|
5446
5427
|
|
|
5447
|
-
SplitPane
|
|
5428
|
+
SplitPane accepts direct Pane children and requires a stable id.
|
|
5448
5429
|
|
|
5449
|
-
|
|
5450
|
-
-
|
|
5451
|
-
-
|
|
5452
|
-
-
|
|
5453
|
-
|
|
5454
|
-
**Responsive behavior:**
|
|
5455
|
-
- Desktop: Panes arranged horizontally
|
|
5456
|
-
- Mobile: Panes stack vertically
|
|
5457
|
-
- singlePaneOnVertical: Controls mobile stacking behavior
|
|
5458
|
-
- true (default): Only PRIMARY pane visible, others collapsed
|
|
5459
|
-
- false: All panes stack vertically without collapsing
|
|
5460
|
-
|
|
5461
|
-
**Auto-collapse:**
|
|
5462
|
-
- collapseBelow: Set container width thresholds for each priority level with breakpoint tokens
|
|
5463
|
-
- Keys are priority numbers (e.g., 2 for SECONDARY, 3 for TERTIARY)
|
|
5464
|
-
- Values are breakpoint tokens (pane collapses below the resolved breakpoint width)
|
|
5465
|
-
- Use false to disable auto-collapse for a priority level
|
|
5466
|
-
- Example: { 2: 'breakpointMd', 3: 'breakpointLg' } collapses SECONDARY below breakpointMd, TERTIARY below breakpointLg
|
|
5467
|
-
- disableResponsiveCollapse: Set to true to disable all auto-collapse behavior
|
|
5468
|
-
|
|
5469
|
-
**Priority values:**
|
|
5470
|
-
- 1 (PRIMARY): Main content, never auto-collapses, highest importance
|
|
5471
|
-
- 2 (SECONDARY): Supporting content, collapses before primary
|
|
5472
|
-
- 3 (TERTIARY): Optional content, collapses first
|
|
5473
|
-
- Custom numbers: Use any number for fine-grained control (lower = higher importance)
|
|
5430
|
+
- orientation, showGutter, adaptation, divider, persistence, accessibility, and disableAnimation preserve the React API shape.
|
|
5431
|
+
- React gap is numeric, but SDUI intentionally accepts a strict Pebble spacing-token name and resolves it to a number in the wrapper.
|
|
5432
|
+
- adaptation collapseBelow accepts only SECONDARY and TERTIARY keys with Pebble breakpoint token values. TERTIARY collapses first, then SECONDARY; PRIMARY stays open.
|
|
5433
|
+
- Bind activePaneId for controlled single-reflow selection. The wrapper writes the new string or null before activePaneChange emits.
|
|
5434
|
+
- persistence stores only the selected uncontrolled fields and should use a stable application-global key.
|
|
5474
5435
|
|
|
5475
5436
|
Catalog key: `SplitPane`
|
|
5476
5437
|
Builder: `SplitPane`
|
|
5477
5438
|
Props type: `SplitPaneProps`
|
|
5478
5439
|
Accepts children: yes
|
|
5479
|
-
Events:
|
|
5440
|
+
Events: `activePaneChange`
|
|
5480
5441
|
|
|
5481
5442
|
### Props
|
|
5482
5443
|
|
|
5483
5444
|
| Name | Required | Type | Description |
|
|
5484
5445
|
|---|---:|---|---|
|
|
5485
|
-
| `
|
|
5486
|
-
| `
|
|
5487
|
-
| `
|
|
5488
|
-
| `
|
|
5446
|
+
| `activePaneId` | no | string | Controlled active pane id for single reflow. Bind for SDUI controlled use. |
|
|
5447
|
+
| `adaptation` | no | Record<string, unknown> | Container-driven priority collapse, reflow, and overflow behavior. |
|
|
5448
|
+
| `ariaLabel` | no | string | Accessible name for the pane group. |
|
|
5449
|
+
| `ariaLabelledBy` | no | string | Space-separated element id list that labels the pane group. |
|
|
5450
|
+
| `defaultActivePaneId` | no | string | Initial active pane id for uncontrolled single reflow. |
|
|
5451
|
+
| `disableAnimation` | no | boolean | Disable structural motion. Reduced-motion preferences always take precedence. |
|
|
5452
|
+
| `divider` | no | Record<string, unknown> | Divider line and resize-grip visibility. |
|
|
5453
|
+
| `gap` | no | [BoxGap](./definitions.md#boxgap) | SDUI spacing-token name resolved to the numeric gutter size expected by React. Used when showGutter is true; default: space300. |
|
|
5454
|
+
| `id` | yes | string | Stable identifier for this pane group. |
|
|
5455
|
+
| `orientation` | no | [SplitPaneOrientation](./definitions.md#splitpaneorientation) | Main-axis layout direction. Default: horizontal. |
|
|
5456
|
+
| `persistence` | no | Record<string, unknown> | Selected uncontrolled pane state persisted by the group. |
|
|
5457
|
+
| `showGutter` | no | boolean | Enable guttered Pane treatment. Default: false. |
|
|
5489
5458
|
|
|
5490
5459
|
No additional properties.
|
|
5491
5460
|
|
|
@@ -1117,6 +1117,27 @@ Referenced by:
|
|
|
1117
1117
|
|---|---|---|
|
|
1118
1118
|
| component | `Button` | `aria-pressed` |
|
|
1119
1119
|
|
|
1120
|
+
## ButtonContentAlignment
|
|
1121
|
+
|
|
1122
|
+
TypeScript type:
|
|
1123
|
+
|
|
1124
|
+
```ts
|
|
1125
|
+
"CENTER" | "START"
|
|
1126
|
+
```
|
|
1127
|
+
|
|
1128
|
+
Allowed values:
|
|
1129
|
+
|
|
1130
|
+
| Value |
|
|
1131
|
+
|---|
|
|
1132
|
+
| `CENTER` |
|
|
1133
|
+
| `START` |
|
|
1134
|
+
|
|
1135
|
+
Referenced by:
|
|
1136
|
+
|
|
1137
|
+
| Kind | Entity | Field |
|
|
1138
|
+
|---|---|---|
|
|
1139
|
+
| component | `Button` | `contentAlignment` |
|
|
1140
|
+
|
|
1120
1141
|
## ButtonGroupAlignment
|
|
1121
1142
|
|
|
1122
1143
|
TypeScript type:
|
|
@@ -1865,37 +1886,6 @@ Referenced by:
|
|
|
1865
1886
|
| component | `TextInput` | `inputMode` |
|
|
1866
1887
|
| component | `WorkEmail` | `inputMode` |
|
|
1867
1888
|
|
|
1868
|
-
## EmailStringPaddingPosition
|
|
1869
|
-
|
|
1870
|
-
TypeScript type:
|
|
1871
|
-
|
|
1872
|
-
```ts
|
|
1873
|
-
"start" | "end"
|
|
1874
|
-
```
|
|
1875
|
-
|
|
1876
|
-
Allowed values:
|
|
1877
|
-
|
|
1878
|
-
| Value |
|
|
1879
|
-
|---|
|
|
1880
|
-
| `start` |
|
|
1881
|
-
| `end` |
|
|
1882
|
-
|
|
1883
|
-
Referenced by:
|
|
1884
|
-
|
|
1885
|
-
| Kind | Entity | Field |
|
|
1886
|
-
|---|---|---|
|
|
1887
|
-
| type | `EmailStringPadding` | `position` |
|
|
1888
|
-
| type | `FormEmailStringPadding` | `position` |
|
|
1889
|
-
| type | `FormNumberStringPadding` | `position` |
|
|
1890
|
-
| type | `FormPasswordStringPadding` | `position` |
|
|
1891
|
-
| type | `FormPhoneStringPadding` | `position` |
|
|
1892
|
-
| type | `FormTextStringPadding` | `position` |
|
|
1893
|
-
| type | `NumberStringPadding` | `position` |
|
|
1894
|
-
| type | `PasswordStringPadding` | `position` |
|
|
1895
|
-
| type | `PhoneStringPadding` | `position` |
|
|
1896
|
-
| type | `TextAutoSuggestStringPadding` | `position` |
|
|
1897
|
-
| type | `TextInputStringPadding` | `position` |
|
|
1898
|
-
|
|
1899
1889
|
## EmojiPickerCategories
|
|
1900
1890
|
|
|
1901
1891
|
TypeScript type:
|
|
@@ -2706,6 +2696,27 @@ Referenced by:
|
|
|
2706
2696
|
|---|---|---|
|
|
2707
2697
|
| component | `Image` | `theme` |
|
|
2708
2698
|
|
|
2699
|
+
## ItemNavigatorVariant
|
|
2700
|
+
|
|
2701
|
+
TypeScript type:
|
|
2702
|
+
|
|
2703
|
+
```ts
|
|
2704
|
+
"LABEL" | "DOTS"
|
|
2705
|
+
```
|
|
2706
|
+
|
|
2707
|
+
Allowed values:
|
|
2708
|
+
|
|
2709
|
+
| Value |
|
|
2710
|
+
|---|
|
|
2711
|
+
| `LABEL` |
|
|
2712
|
+
| `DOTS` |
|
|
2713
|
+
|
|
2714
|
+
Referenced by:
|
|
2715
|
+
|
|
2716
|
+
| Kind | Entity | Field |
|
|
2717
|
+
|---|---|---|
|
|
2718
|
+
| component | `ItemNavigator` | `variant` |
|
|
2719
|
+
|
|
2709
2720
|
## LabelAppearance
|
|
2710
2721
|
|
|
2711
2722
|
TypeScript type:
|
|
@@ -3339,6 +3350,128 @@ Referenced by:
|
|
|
3339
3350
|
|---|---|---|
|
|
3340
3351
|
| component | `Paginate` | `theme` |
|
|
3341
3352
|
|
|
3353
|
+
## PaneCollapseControl
|
|
3354
|
+
|
|
3355
|
+
TypeScript type:
|
|
3356
|
+
|
|
3357
|
+
```ts
|
|
3358
|
+
"auto" | "header" | "divider"
|
|
3359
|
+
```
|
|
3360
|
+
|
|
3361
|
+
Allowed values:
|
|
3362
|
+
|
|
3363
|
+
| Value |
|
|
3364
|
+
|---|
|
|
3365
|
+
| `auto` |
|
|
3366
|
+
| `header` |
|
|
3367
|
+
| `divider` |
|
|
3368
|
+
|
|
3369
|
+
Referenced by:
|
|
3370
|
+
|
|
3371
|
+
| Kind | Entity | Field |
|
|
3372
|
+
|---|---|---|
|
|
3373
|
+
| component | `Pane` | `collapseControl` |
|
|
3374
|
+
| component | `Pane` | `dismissControl` |
|
|
3375
|
+
|
|
3376
|
+
## PanePin
|
|
3377
|
+
|
|
3378
|
+
TypeScript type:
|
|
3379
|
+
|
|
3380
|
+
```ts
|
|
3381
|
+
"start" | "end"
|
|
3382
|
+
```
|
|
3383
|
+
|
|
3384
|
+
Allowed values:
|
|
3385
|
+
|
|
3386
|
+
| Value |
|
|
3387
|
+
|---|
|
|
3388
|
+
| `start` |
|
|
3389
|
+
| `end` |
|
|
3390
|
+
|
|
3391
|
+
Referenced by:
|
|
3392
|
+
|
|
3393
|
+
| Kind | Entity | Field |
|
|
3394
|
+
|---|---|---|
|
|
3395
|
+
| component | `Pane` | `pin` |
|
|
3396
|
+
| type | `EmailStringPadding` | `position` |
|
|
3397
|
+
| type | `FormEmailStringPadding` | `position` |
|
|
3398
|
+
| type | `FormNumberStringPadding` | `position` |
|
|
3399
|
+
| type | `FormPasswordStringPadding` | `position` |
|
|
3400
|
+
| type | `FormPhoneStringPadding` | `position` |
|
|
3401
|
+
| type | `FormTextStringPadding` | `position` |
|
|
3402
|
+
| type | `NumberStringPadding` | `position` |
|
|
3403
|
+
| type | `PasswordStringPadding` | `position` |
|
|
3404
|
+
| type | `PhoneStringPadding` | `position` |
|
|
3405
|
+
| type | `TextAutoSuggestStringPadding` | `position` |
|
|
3406
|
+
| type | `TextInputStringPadding` | `position` |
|
|
3407
|
+
|
|
3408
|
+
## PanePresentation
|
|
3409
|
+
|
|
3410
|
+
TypeScript type:
|
|
3411
|
+
|
|
3412
|
+
```ts
|
|
3413
|
+
"docked" | "collapsed" | "hidden" | "bottomDock" | "overlay"
|
|
3414
|
+
```
|
|
3415
|
+
|
|
3416
|
+
Allowed values:
|
|
3417
|
+
|
|
3418
|
+
| Value |
|
|
3419
|
+
|---|
|
|
3420
|
+
| `docked` |
|
|
3421
|
+
| `collapsed` |
|
|
3422
|
+
| `hidden` |
|
|
3423
|
+
| `bottomDock` |
|
|
3424
|
+
| `overlay` |
|
|
3425
|
+
|
|
3426
|
+
Referenced by:
|
|
3427
|
+
|
|
3428
|
+
| Kind | Entity | Field |
|
|
3429
|
+
|---|---|---|
|
|
3430
|
+
| component | `Pane` | `presentation` |
|
|
3431
|
+
|
|
3432
|
+
## PanePriority
|
|
3433
|
+
|
|
3434
|
+
TypeScript type:
|
|
3435
|
+
|
|
3436
|
+
```ts
|
|
3437
|
+
"PRIMARY" | "SECONDARY" | "TERTIARY"
|
|
3438
|
+
```
|
|
3439
|
+
|
|
3440
|
+
Allowed values:
|
|
3441
|
+
|
|
3442
|
+
| Value |
|
|
3443
|
+
|---|
|
|
3444
|
+
| `PRIMARY` |
|
|
3445
|
+
| `SECONDARY` |
|
|
3446
|
+
| `TERTIARY` |
|
|
3447
|
+
|
|
3448
|
+
Referenced by:
|
|
3449
|
+
|
|
3450
|
+
| Kind | Entity | Field |
|
|
3451
|
+
|---|---|---|
|
|
3452
|
+
| component | `Pane` | `priority` |
|
|
3453
|
+
|
|
3454
|
+
## PaneSizingValueVariant3Mode
|
|
3455
|
+
|
|
3456
|
+
TypeScript type:
|
|
3457
|
+
|
|
3458
|
+
```ts
|
|
3459
|
+
"fill" | "resizable"
|
|
3460
|
+
```
|
|
3461
|
+
|
|
3462
|
+
Allowed values:
|
|
3463
|
+
|
|
3464
|
+
| Value |
|
|
3465
|
+
|---|
|
|
3466
|
+
| `fill` |
|
|
3467
|
+
| `resizable` |
|
|
3468
|
+
|
|
3469
|
+
Referenced by:
|
|
3470
|
+
|
|
3471
|
+
| Kind | Entity | Field |
|
|
3472
|
+
|---|---|---|
|
|
3473
|
+
| type | `PaneSizingValueVariant3` | `mode` |
|
|
3474
|
+
|
|
3342
3475
|
## ProgressBarAppearance
|
|
3343
3476
|
|
|
3344
3477
|
TypeScript type:
|
|
@@ -3756,6 +3889,27 @@ Referenced by:
|
|
|
3756
3889
|
|---|---|---|
|
|
3757
3890
|
| component | `SplitButton` | `appearance` |
|
|
3758
3891
|
|
|
3892
|
+
## SplitPaneOrientation
|
|
3893
|
+
|
|
3894
|
+
TypeScript type:
|
|
3895
|
+
|
|
3896
|
+
```ts
|
|
3897
|
+
"horizontal" | "vertical"
|
|
3898
|
+
```
|
|
3899
|
+
|
|
3900
|
+
Allowed values:
|
|
3901
|
+
|
|
3902
|
+
| Value |
|
|
3903
|
+
|---|
|
|
3904
|
+
| `horizontal` |
|
|
3905
|
+
| `vertical` |
|
|
3906
|
+
|
|
3907
|
+
Referenced by:
|
|
3908
|
+
|
|
3909
|
+
| Kind | Entity | Field |
|
|
3910
|
+
|---|---|---|
|
|
3911
|
+
| component | `SplitPane` | `orientation` |
|
|
3912
|
+
|
|
3759
3913
|
## StandAloneStepStatus
|
|
3760
3914
|
|
|
3761
3915
|
TypeScript type:
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
# custom-apps Catalog
|
|
3
3
|
|
|
4
4
|
Catalog: `custom-apps`
|
|
5
|
-
Version: `1.
|
|
5
|
+
Version: `1.5.2`
|
|
6
6
|
SDK language: `typescript`
|
|
7
7
|
|
|
8
8
|
Use this catalog index after you have chosen this catalog for the spec. Do not mix components, actions, computed functions, or render helpers from another catalog unless that catalog explicitly documents compatibility.
|