@rippling/pebble-sdui-web 0.7.0 → 0.8.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/custom-apps/catalog.d.ts +1 -1
- package/dist/catalogs/custom-apps/component-events.d.ts +2 -0
- package/dist/catalogs/custom-apps/component-props.d.ts +71 -0
- package/dist/catalogs/custom-apps/components.d.ts +4 -2
- package/dist/catalogs/custom-apps/index.cjs +2 -2
- package/dist/catalogs/custom-apps/index.cjs.map +1 -1
- package/dist/catalogs/custom-apps/index.d.ts +3 -3
- package/dist/catalogs/custom-apps/index.js +502 -182
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +82 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +70 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +63 -0
- package/package.json +1 -1
|
@@ -938,6 +938,48 @@ Events: `change`, `blur`
|
|
|
938
938
|
|
|
939
939
|
No additional properties.
|
|
940
940
|
|
|
941
|
+
## Comments
|
|
942
|
+
|
|
943
|
+
Comments surface for a product object or a set of product threads. Supports single-thread and multithread comment chains.
|
|
944
|
+
|
|
945
|
+
For single-thread comments, pass productName and productId.
|
|
946
|
+
For multithreaded comments, pass productName and a non-empty productThreads array. Each thread must include productId.
|
|
947
|
+
Callback props are exposed as events. Use statePaths when the spec needs the callback payload written to SDUI state before the event handler runs.
|
|
948
|
+
|
|
949
|
+
Catalog key: `Comments`
|
|
950
|
+
Builder: `Comments`
|
|
951
|
+
Props type: `CommentsProps`
|
|
952
|
+
Accepts children: no
|
|
953
|
+
Events: `commentChainCreation`, `commentAddition`, `commentEdit`, `commentRemoval`
|
|
954
|
+
|
|
955
|
+
### Props
|
|
956
|
+
|
|
957
|
+
| Name | Required | Type | Description |
|
|
958
|
+
|---|---:|---|---|
|
|
959
|
+
| `commentsOrder` | no | [CommentsCommentsOrder](./definitions.md#commentscommentsorder) | Order in which comments render. Defaults to NEWEST_FIRST. |
|
|
960
|
+
| `dataTestId` | no | string | Test id on the comments root. |
|
|
961
|
+
| `enableReactions` | no | boolean | When true, enables platform comment reactions. |
|
|
962
|
+
| `groupId` | no | string | Groups related comment chains. |
|
|
963
|
+
| `headerText` | no | string | Optional string header. Defaults to the translated Comments label. |
|
|
964
|
+
| `hideNewCommentEditor` | no | boolean | When true, hides the new-comment editor. |
|
|
965
|
+
| `maxHeight` | no | string \| number | Maximum height for the scrollable comments container. |
|
|
966
|
+
| `productId` | no | string | Product object id for single-thread comments. Required unless productThreads is provided. |
|
|
967
|
+
| `productMetadata` | no | [ProductMetadata](./types.md#productmetadata) | Product metadata for a single comment chain. |
|
|
968
|
+
| `productName` | yes | string | Product name used to identify the comment chain. |
|
|
969
|
+
| `productSubCategory` | no | string | Optional product subcategory. |
|
|
970
|
+
| `productThreads` | no | [ProductThread](./types.md#productthread)[] | Non-empty thread list for multithreaded comments. When provided, renders the multithread view. |
|
|
971
|
+
| `readOnly` | no | boolean | When true, hides editing controls and shows a read-only badge. |
|
|
972
|
+
| `requestOptions` | no | [RequestOption](./types.md#requestoption) | Request options passed to the comments API calls. |
|
|
973
|
+
| `rumExcluded` | no | boolean | When true, excludes initial API calls from RUM metrics. |
|
|
974
|
+
| `scrollToTop` | no | boolean | When true, scrolls the top comment into view after load. |
|
|
975
|
+
| `showHeaderText` | no | boolean | When false, hides the comments header. |
|
|
976
|
+
| `showInlineAttachments` | no | boolean | When false, hides the inline attachment affordance. |
|
|
977
|
+
| `showUnreadCountBadge` | no | boolean | When false, hides the unread-count badge in the header. |
|
|
978
|
+
| `statePaths` | no | [StatePath](./types.md#statepath) | Optional state paths written before emitting comment events. |
|
|
979
|
+
| `theme` | no | [CommentsTheme](./definitions.md#commentstheme) | Visual theme override for embedding comments in tight layouts. |
|
|
980
|
+
|
|
981
|
+
No additional properties.
|
|
982
|
+
|
|
941
983
|
## ContentLoader
|
|
942
984
|
|
|
943
985
|
A low-level SVG shimmer placeholder used to indicate loading state. Renders a plain animated rectangle whose dimensions you control. For shaped placeholders (text lines, circles, boxes), use Skeleton instead.
|
|
@@ -1444,6 +1486,46 @@ Events: `change`
|
|
|
1444
1486
|
|
|
1445
1487
|
No additional properties.
|
|
1446
1488
|
|
|
1489
|
+
## EmployeeSearch
|
|
1490
|
+
|
|
1491
|
+
Employee search input powered by a backend role search API. Supports single and multi-select modes with type-ahead search. Use for any field that picks one or more employees.
|
|
1492
|
+
|
|
1493
|
+
The component hits a backend role search API on each keystroke (or on mount when enableEmptySearch is true). Results are cached per search term for the session.
|
|
1494
|
+
For large employee lists, set isInfiniteScroll: true and enableEmptySearch: true so the dropdown pre-populates without requiring the user to type first.
|
|
1495
|
+
value supports $bindState for two-way binding. On change, value is set to the selected role id (string) or ids (string[]) and onChange fires.
|
|
1496
|
+
defaultValue is the uncontrolled initial value; value is the controlled prop. Do not mix both — use one or the other.
|
|
1497
|
+
|
|
1498
|
+
Catalog key: `EmployeeSearch`
|
|
1499
|
+
Builder: `EmployeeSearch`
|
|
1500
|
+
Props type: `EmployeeSearchProps`
|
|
1501
|
+
Accepts children: no
|
|
1502
|
+
Events: `change`
|
|
1503
|
+
|
|
1504
|
+
### Props
|
|
1505
|
+
|
|
1506
|
+
| Name | Required | Type | Description |
|
|
1507
|
+
|---|---:|---|---|
|
|
1508
|
+
| `name` | no | string | Form field name. Defaults to "role". |
|
|
1509
|
+
| `canClear` | no | boolean | When true, shows a clear button to reset the selection. |
|
|
1510
|
+
| `defaultValue` | no | string \| string[] | Initial uncontrolled value — a role id (string) or array of role ids. |
|
|
1511
|
+
| `enableEmptySearch` | no | boolean | When true and isInfiniteScroll is true, loads an initial list without requiring a search query. |
|
|
1512
|
+
| `helperMessage` | no | string | Helper message displayed below the input. |
|
|
1513
|
+
| `isDisabled` | no | boolean | When true, disables the input. |
|
|
1514
|
+
| `isInfiniteScroll` | no | boolean | When true, uses paginated backend search. Recommended for large employee lists. |
|
|
1515
|
+
| `isMulti` | no | boolean | When true, allows selecting multiple employees. |
|
|
1516
|
+
| `isRequired` | no | boolean | Marks the field as required in a form context. |
|
|
1517
|
+
| `nullPlaceholder` | no | string | Placeholder text displayed when no value is selected (distinct from the search placeholder). |
|
|
1518
|
+
| `placeholder` | no | string | Placeholder text shown inside the input when empty. |
|
|
1519
|
+
| `roleIdsToIgnore` | no | string[] | Role ids to exclude from search results. |
|
|
1520
|
+
| `roleIdsToInclude` | no | string[] | When set, only these role ids appear in results. |
|
|
1521
|
+
| `roleTypes` | no | [EmployeeSearchRoleTypes](./definitions.md#employeesearchroletypes)[] | Filters employees by role type. Defaults to ["ACCEPTED_AND_ACTIVE"]. |
|
|
1522
|
+
| `shouldShowSearchIcon` | no | boolean | When true, renders a search icon inside the input. |
|
|
1523
|
+
| `tip` | no | string | Helper tip text displayed below the title. |
|
|
1524
|
+
| `title` | no | string | Label displayed above the search input. |
|
|
1525
|
+
| `value` | no | string \| string[] | Controlled value — a role id (string) or array of role ids. Use $bindState for two-way binding. |
|
|
1526
|
+
|
|
1527
|
+
No additional properties.
|
|
1528
|
+
|
|
1447
1529
|
## ExpansionPanel
|
|
1448
1530
|
|
|
1449
1531
|
A collapsible panel that expands or contracts to reveal additional detailed information. Use to organize related content within limited space, such as FAQs, settings menus, or side panels. Prefer a full scrolling page when users need to read all content.
|
|
@@ -1532,6 +1532,47 @@ Referenced by:
|
|
|
1532
1532
|
| component | `Chip` | `size` |
|
|
1533
1533
|
| component | `Status` | `size` |
|
|
1534
1534
|
|
|
1535
|
+
## CommentsCommentsOrder
|
|
1536
|
+
|
|
1537
|
+
TypeScript type:
|
|
1538
|
+
|
|
1539
|
+
```ts
|
|
1540
|
+
"NEWEST_FIRST" | "OLDEST_FIRST"
|
|
1541
|
+
```
|
|
1542
|
+
|
|
1543
|
+
Allowed values:
|
|
1544
|
+
|
|
1545
|
+
| Value |
|
|
1546
|
+
|---|
|
|
1547
|
+
| `NEWEST_FIRST` |
|
|
1548
|
+
| `OLDEST_FIRST` |
|
|
1549
|
+
|
|
1550
|
+
Referenced by:
|
|
1551
|
+
|
|
1552
|
+
| Kind | Entity | Field |
|
|
1553
|
+
|---|---|---|
|
|
1554
|
+
| component | `Comments` | `commentsOrder` |
|
|
1555
|
+
|
|
1556
|
+
## CommentsTheme
|
|
1557
|
+
|
|
1558
|
+
TypeScript type:
|
|
1559
|
+
|
|
1560
|
+
```ts
|
|
1561
|
+
"NO_BORDER_AND_PADDING"
|
|
1562
|
+
```
|
|
1563
|
+
|
|
1564
|
+
Allowed values:
|
|
1565
|
+
|
|
1566
|
+
| Value |
|
|
1567
|
+
|---|
|
|
1568
|
+
| `NO_BORDER_AND_PADDING` |
|
|
1569
|
+
|
|
1570
|
+
Referenced by:
|
|
1571
|
+
|
|
1572
|
+
| Kind | Entity | Field |
|
|
1573
|
+
|---|---|---|
|
|
1574
|
+
| component | `Comments` | `theme` |
|
|
1575
|
+
|
|
1535
1576
|
## CountryIconAlignment
|
|
1536
1577
|
|
|
1537
1578
|
TypeScript type:
|
|
@@ -1835,6 +1876,35 @@ Referenced by:
|
|
|
1835
1876
|
|---|---|---|
|
|
1836
1877
|
| component | `EmojiPicker` | `categories` |
|
|
1837
1878
|
|
|
1879
|
+
## EmployeeSearchRoleTypes
|
|
1880
|
+
|
|
1881
|
+
TypeScript type:
|
|
1882
|
+
|
|
1883
|
+
```ts
|
|
1884
|
+
"ACTIVE" | "GOOD" | "ACCEPTED_AND_ACTIVE" | "NON_INIT" | "INIT" | "ALL_INCLUDING_INIT" | "GOOD_INCLUDING_ADMINS" | "NON_INIT_INCLUDING_ADMINS" | "NON_TERMINATED_INCLUDING_3RD_ADMINS" | "TERMINATED"
|
|
1885
|
+
```
|
|
1886
|
+
|
|
1887
|
+
Allowed values:
|
|
1888
|
+
|
|
1889
|
+
| Value |
|
|
1890
|
+
|---|
|
|
1891
|
+
| `ACTIVE` |
|
|
1892
|
+
| `GOOD` |
|
|
1893
|
+
| `ACCEPTED_AND_ACTIVE` |
|
|
1894
|
+
| `NON_INIT` |
|
|
1895
|
+
| `INIT` |
|
|
1896
|
+
| `ALL_INCLUDING_INIT` |
|
|
1897
|
+
| `GOOD_INCLUDING_ADMINS` |
|
|
1898
|
+
| `NON_INIT_INCLUDING_ADMINS` |
|
|
1899
|
+
| `NON_TERMINATED_INCLUDING_3RD_ADMINS` |
|
|
1900
|
+
| `TERMINATED` |
|
|
1901
|
+
|
|
1902
|
+
Referenced by:
|
|
1903
|
+
|
|
1904
|
+
| Kind | Entity | Field |
|
|
1905
|
+
|---|---|---|
|
|
1906
|
+
| component | `EmployeeSearch` | `roleTypes` |
|
|
1907
|
+
|
|
1838
1908
|
## ExpansionPanelTheme
|
|
1839
1909
|
|
|
1840
1910
|
TypeScript type:
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
# custom-apps Catalog
|
|
3
3
|
|
|
4
4
|
Catalog: `custom-apps`
|
|
5
|
-
Version: `1.
|
|
5
|
+
Version: `1.3.0`
|
|
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.
|
|
@@ -685,6 +685,21 @@ No additional properties.
|
|
|
685
685
|
|
|
686
686
|
No additional properties.
|
|
687
687
|
|
|
688
|
+
## Display
|
|
689
|
+
|
|
690
|
+
Optional display metadata for a multithreaded comment thread.
|
|
691
|
+
|
|
692
|
+
### Fields
|
|
693
|
+
|
|
694
|
+
| Name | Required | Type | Description |
|
|
695
|
+
|---|---:|---|---|
|
|
696
|
+
| `caption` | no | string | Optional secondary thread text. |
|
|
697
|
+
| `iconType` | yes | string | Pebble icon type for the thread label. |
|
|
698
|
+
| `label` | yes | string | Visible thread label. |
|
|
699
|
+
| `labelAppearance` | yes | string | Pebble Label appearance token for the thread label. |
|
|
700
|
+
|
|
701
|
+
No additional properties.
|
|
702
|
+
|
|
688
703
|
## DraggableListList
|
|
689
704
|
|
|
690
705
|
### Fields
|
|
@@ -2341,6 +2356,29 @@ Pads input value with character until reaching maxLength
|
|
|
2341
2356
|
|
|
2342
2357
|
No additional properties.
|
|
2343
2358
|
|
|
2359
|
+
## ProductMetadata
|
|
2360
|
+
|
|
2361
|
+
Product metadata for a single comment chain.
|
|
2362
|
+
|
|
2363
|
+
### Fields
|
|
2364
|
+
|
|
2365
|
+
_No fields._
|
|
2366
|
+
|
|
2367
|
+
Additional properties: unknown.
|
|
2368
|
+
|
|
2369
|
+
## ProductThread
|
|
2370
|
+
|
|
2371
|
+
### Fields
|
|
2372
|
+
|
|
2373
|
+
| Name | Required | Type | Description |
|
|
2374
|
+
|---|---:|---|---|
|
|
2375
|
+
| `display` | no | [Display](./types.md#display) | Optional display metadata for a multithreaded comment thread. |
|
|
2376
|
+
| `groupId` | no | string | Groups related comment chains. |
|
|
2377
|
+
| `productId` | yes | string | Unique product object id for this thread. |
|
|
2378
|
+
| `productMetadata` | no | [ProductMetadata](./types.md#productmetadata) | Product metadata for this comment chain. |
|
|
2379
|
+
|
|
2380
|
+
No additional properties.
|
|
2381
|
+
|
|
2344
2382
|
## ProgressStepsStep
|
|
2345
2383
|
|
|
2346
2384
|
### Fields
|
|
@@ -2463,6 +2501,16 @@ Additional properties: [RenderPropValue](./types.md#renderpropvalue).
|
|
|
2463
2501
|
|
|
2464
2502
|
No additional properties.
|
|
2465
2503
|
|
|
2504
|
+
## RequestOption
|
|
2505
|
+
|
|
2506
|
+
Request options passed to the comments API calls.
|
|
2507
|
+
|
|
2508
|
+
### Fields
|
|
2509
|
+
|
|
2510
|
+
_No fields._
|
|
2511
|
+
|
|
2512
|
+
Additional properties: unknown.
|
|
2513
|
+
|
|
2466
2514
|
## Role
|
|
2467
2515
|
|
|
2468
2516
|
### Fields
|
|
@@ -2854,6 +2902,21 @@ No additional properties.
|
|
|
2854
2902
|
|
|
2855
2903
|
No additional properties.
|
|
2856
2904
|
|
|
2905
|
+
## StatePath
|
|
2906
|
+
|
|
2907
|
+
Optional state paths written before emitting comment events.
|
|
2908
|
+
|
|
2909
|
+
### Fields
|
|
2910
|
+
|
|
2911
|
+
| Name | Required | Type | Description |
|
|
2912
|
+
|---|---:|---|---|
|
|
2913
|
+
| `commentChainId` | no | string | Path updated with the created comment chain id. |
|
|
2914
|
+
| `lastAddedComment` | no | string | Path updated with the most recently added comment. |
|
|
2915
|
+
| `lastEditedComment` | no | string | Path updated with the most recently edited comment. |
|
|
2916
|
+
| `lastRemovedComment` | no | string | Path updated with the most recently removed comment. |
|
|
2917
|
+
|
|
2918
|
+
No additional properties.
|
|
2919
|
+
|
|
2857
2920
|
## StepperAvatar
|
|
2858
2921
|
|
|
2859
2922
|
Avatar configuration to display with the step. Supports image URLs
|