@rippling/pebble-sdui-web 0.21.1 → 0.21.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/catalog.d.ts +1 -1
- package/dist/catalogs/custom-apps/component-events.d.ts +1 -1
- package/dist/catalogs/custom-apps/component-props.d.ts +27 -1
- 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 +107 -6
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +9 -4
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +21 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +53 -1
- package/package.json +1 -1
|
@@ -1817,6 +1817,8 @@ Two binding surfaces (independent — use either, both, or neither):
|
|
|
1817
1817
|
|
|
1818
1818
|
External `validationErrors` merge with input-reported errors; clear an error by writing a falsy value to that key.
|
|
1819
1819
|
|
|
1820
|
+
To submit from a Button rendered OUTSIDE the Form: set `noFooter: true`, bind `submitSignal` to a state path (e.g. `{ $state: "/form/submitSignal" }`), and give the external Button an `on.press` action that writes a NEW value to that path (increment a counter, set a fresh string, or flip a boolean). The form submits on every change to that value; the first render never submits. Do not write the same value twice — no change means no submit.
|
|
1821
|
+
|
|
1820
1822
|
Catalog key: `Form`
|
|
1821
1823
|
Builder: `Form`
|
|
1822
1824
|
Props type: `FormProps`
|
|
@@ -1846,6 +1848,7 @@ Events: `change`, `submit`, `valid`, `invalid`, `cancel`, `edit`, `skip`
|
|
|
1846
1848
|
| `skipButton` | no | [SkipButton](./types.md#skipbutton) | Secondary skip action. Click emits the skip event. |
|
|
1847
1849
|
| `submitButtonLabel` | no | string | Deprecated submit button label. Prefer submitButtonProps.label for new specs |
|
|
1848
1850
|
| `submitButtonProps` | no | [SubmitButtonProp](./types.md#submitbuttonprop) | Configuration for the form submit button |
|
|
1851
|
+
| `submitSignal` | no | string \| number \| boolean | Bind to state ($state). Whenever this value CHANGES, the form submits (runs validation, then emits submit/invalid). The first render never submits. To submit again, write a new distinct value (increment a number, set a new string/uuid, or flip a boolean) — do NOT write the same value again. Use to submit from a Button rendered outside the Form, usually with noFooter: true. |
|
|
1849
1852
|
| `successMessage` | no | string | Message shown in a snackbar after a successful submit |
|
|
1850
1853
|
| `theme` | no | [FormTheme](./definitions.md#formtheme) | Predefined form style theme |
|
|
1851
1854
|
| `title` | no | string | Form title shown in header |
|
|
@@ -5614,7 +5617,7 @@ No additional properties.
|
|
|
5614
5617
|
|
|
5615
5618
|
A compound button that combines a primary action with a secondary trailing button, typically opening a dropdown of alternative actions. Use when the user has a main action with related alternatives (e.g. "Save" with "Save as draft", "Save and publish").
|
|
5616
5619
|
|
|
5617
|
-
The trailing section opens a dropdown when dropdownList is provided. Events: "press" fires on primary button click
|
|
5620
|
+
The trailing section opens a dropdown when dropdownList is provided. Bind clickedValue to state to capture the selected dropdown item value; it is written before dropdownChange fires so event actions can read it. The primary label remains unchanged because dropdown items are alternative actions, not a selection control. Events: "press" fires on primary button click and "dropdownChange" fires when a dropdown item is selected.
|
|
5618
5621
|
|
|
5619
5622
|
Catalog key: `SplitButton`
|
|
5620
5623
|
Builder: `SplitButton`
|
|
@@ -5627,6 +5630,7 @@ Events: `press`, `dropdownChange`
|
|
|
5627
5630
|
| Name | Required | Type | Description |
|
|
5628
5631
|
|---|---:|---|---|
|
|
5629
5632
|
| `appearance` | no | [SplitButtonAppearance](./definitions.md#splitbuttonappearance) | Visual style variant. Ghost and Solid are not available. Default: PRIMARY |
|
|
5633
|
+
| `clickedValue` | no | string | Bindable last clicked dropdown item value, written before the dropdownChange event emits |
|
|
5630
5634
|
| `dropdownList` | no | [DropdownList](./types.md#dropdownlist)[] | List of items for the trailing dropdown menu |
|
|
5631
5635
|
| `isDisabled` | no | boolean | Disables both primary and trailing sections |
|
|
5632
5636
|
| `isFluid` | no | boolean | Expands button to full container width |
|
|
@@ -5777,14 +5781,14 @@ width: optional CSS width string or pixel number passed to the underlying Grid.
|
|
|
5777
5781
|
height: optional CSS height string. Omit to let the grid auto-size. Pass an explicit value (e.g. "500px") when embedding inside a fixed-height container.
|
|
5778
5782
|
caption: optional sub-title rendered beneath the grid title. Falls back to the backend-configured caption when omitted.
|
|
5779
5783
|
rowActions: optional static row action configs. Dynamic per-row factories are not supported in SDUI; use booleans for isDisabled/isHidden.
|
|
5780
|
-
Events do not receive payload arguments. Bind rowClickedData, rowActionClickedId, or
|
|
5781
|
-
SuperGrid writes the bound
|
|
5784
|
+
Events do not receive payload arguments. Bind rowClickedData, rowActionClickedId, rowActionClickedData, or editData with $bindState, then read those paths with $state inside rowClick, rowActionClick, or edit actions.
|
|
5785
|
+
SuperGrid writes the bound state before emitting rowClick, rowActionClick, or edit. editData contains rowId, issues, outcome, and the submitted items for that row.
|
|
5782
5786
|
|
|
5783
5787
|
Catalog key: `SuperGrid`
|
|
5784
5788
|
Builder: `SuperGrid`
|
|
5785
5789
|
Props type: `SuperGridProps`
|
|
5786
5790
|
Accepts children: no
|
|
5787
|
-
Events: `rowClick`, `rowActionClick`
|
|
5791
|
+
Events: `rowClick`, `rowActionClick`, `edit`
|
|
5788
5792
|
|
|
5789
5793
|
### Props
|
|
5790
5794
|
|
|
@@ -5793,6 +5797,7 @@ Events: `rowClick`, `rowActionClick`
|
|
|
5793
5797
|
| `caption` | no | string | Optional caption rendered below the grid title. |
|
|
5794
5798
|
| `configContext` | no | [ConfigContext](./types.md#configcontext) | Query context sent to dynamic config modifiers for backend-owned variants. |
|
|
5795
5799
|
| `contextFilters` | no | [ContextFilter](./types.md#contextfilter)[] | Filters derived from external state that scope data and filter-dropdown queries. Applied in addition to any user-applied filters. |
|
|
5800
|
+
| `editData` | no | [EditData](./types.md#editdata) | Bind to state with $bindState to receive the sanitized inline-edit update before edit emits. |
|
|
5796
5801
|
| `gridId` | yes | string | Unique identifier for the grid configuration fetched from the backend. |
|
|
5797
5802
|
| `height` | no | string | Any CSS height string (e.g. "400px", "60vh"). When omitted the grid auto-sizes to its rows. |
|
|
5798
5803
|
| `rowActionClickedData` | no | unknown | Bind to state with $bindState to receive clicked row action row data before rowActionClick emits. |
|
|
@@ -1944,6 +1944,27 @@ Referenced by:
|
|
|
1944
1944
|
|---|---|---|
|
|
1945
1945
|
| component | `Dropdown` | `placement` |
|
|
1946
1946
|
|
|
1947
|
+
## EditDataOutcome
|
|
1948
|
+
|
|
1949
|
+
TypeScript type:
|
|
1950
|
+
|
|
1951
|
+
```ts
|
|
1952
|
+
"accepted" | "rejected"
|
|
1953
|
+
```
|
|
1954
|
+
|
|
1955
|
+
Allowed values:
|
|
1956
|
+
|
|
1957
|
+
| Value |
|
|
1958
|
+
|---|
|
|
1959
|
+
| `accepted` |
|
|
1960
|
+
| `rejected` |
|
|
1961
|
+
|
|
1962
|
+
Referenced by:
|
|
1963
|
+
|
|
1964
|
+
| Kind | Entity | Field |
|
|
1965
|
+
|---|---|---|
|
|
1966
|
+
| type | `EditData` | `outcome` |
|
|
1967
|
+
|
|
1947
1968
|
## EmailAutoCapitalize
|
|
1948
1969
|
|
|
1949
1970
|
TypeScript type:
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
# custom-apps Catalog
|
|
3
3
|
|
|
4
4
|
Catalog: `custom-apps`
|
|
5
|
-
Version: `1.12.
|
|
5
|
+
Version: `1.12.4`
|
|
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.
|
|
@@ -301,8 +301,8 @@ No additional properties.
|
|
|
301
301
|
|
|
302
302
|
| Name | Required | Type | Description |
|
|
303
303
|
|---|---:|---|---|
|
|
304
|
-
| `content` | yes | string | File content as a base64 data URL. |
|
|
305
304
|
| `name` | yes | string | File name. |
|
|
305
|
+
| `content` | yes | string | File content as a base64 data URL. |
|
|
306
306
|
|
|
307
307
|
Additional properties: unknown.
|
|
308
308
|
|
|
@@ -576,6 +576,18 @@ No additional properties.
|
|
|
576
576
|
|
|
577
577
|
No additional properties.
|
|
578
578
|
|
|
579
|
+
## Change
|
|
580
|
+
|
|
581
|
+
### Fields
|
|
582
|
+
|
|
583
|
+
| Name | Required | Type | Description |
|
|
584
|
+
|---|---:|---|---|
|
|
585
|
+
| `after` | yes | unknown | Value after the edit. |
|
|
586
|
+
| `before` | yes | unknown | Value before the edit. |
|
|
587
|
+
| `field` | yes | string | Backend field that changed. |
|
|
588
|
+
|
|
589
|
+
No additional properties.
|
|
590
|
+
|
|
579
591
|
## CheckboxArg
|
|
580
592
|
|
|
581
593
|
### Fields
|
|
@@ -1233,6 +1245,21 @@ No additional properties.
|
|
|
1233
1245
|
|
|
1234
1246
|
No additional properties.
|
|
1235
1247
|
|
|
1248
|
+
## EditData
|
|
1249
|
+
|
|
1250
|
+
Bind to state with $bindState to receive the sanitized inline-edit update before edit emits.
|
|
1251
|
+
|
|
1252
|
+
### Fields
|
|
1253
|
+
|
|
1254
|
+
| Name | Required | Type | Description |
|
|
1255
|
+
|---|---:|---|---|
|
|
1256
|
+
| `issues` | yes | [Issue](./types.md#issue)[] | Ordered validation issues returned by the inline edit. |
|
|
1257
|
+
| `items` | no | [SuperGridItem](./types.md#supergriditem)[] | Submitted cell edits associated with this row result. |
|
|
1258
|
+
| `outcome` | yes | [EditDataOutcome](./definitions.md#editdataoutcome) | Inline-edit outcome. |
|
|
1259
|
+
| `rowId` | yes | string | Stable ID of the edited row. |
|
|
1260
|
+
|
|
1261
|
+
No additional properties.
|
|
1262
|
+
|
|
1236
1263
|
## EmailArg
|
|
1237
1264
|
|
|
1238
1265
|
### Fields
|
|
@@ -2869,6 +2896,18 @@ No additional properties.
|
|
|
2869
2896
|
|
|
2870
2897
|
No additional properties.
|
|
2871
2898
|
|
|
2899
|
+
## Issue
|
|
2900
|
+
|
|
2901
|
+
### Fields
|
|
2902
|
+
|
|
2903
|
+
| Name | Required | Type | Description |
|
|
2904
|
+
|---|---:|---|---|
|
|
2905
|
+
| `code` | yes | string | Stable validation code supplied by the backend. |
|
|
2906
|
+
| `columnId` | yes | string | Column ID that owns this validation issue. |
|
|
2907
|
+
| `message` | yes | string | Human-readable validation message. |
|
|
2908
|
+
|
|
2909
|
+
No additional properties.
|
|
2910
|
+
|
|
2872
2911
|
## LabelLeftIcon
|
|
2873
2912
|
|
|
2874
2913
|
### Fields
|
|
@@ -4278,6 +4317,19 @@ Configuration for the form submit button
|
|
|
4278
4317
|
|
|
4279
4318
|
No additional properties.
|
|
4280
4319
|
|
|
4320
|
+
## SuperGridItem
|
|
4321
|
+
|
|
4322
|
+
### Fields
|
|
4323
|
+
|
|
4324
|
+
| Name | Required | Type | Description |
|
|
4325
|
+
|---|---:|---|---|
|
|
4326
|
+
| `changeNote` | no | string | Optional change note. |
|
|
4327
|
+
| `changes` | yes | [Change](./types.md#change)[] | |
|
|
4328
|
+
| `columnId` | yes | string | Column that originated the edit. |
|
|
4329
|
+
| `rowId` | yes | string | Stable ID of the edited row. |
|
|
4330
|
+
|
|
4331
|
+
No additional properties.
|
|
4332
|
+
|
|
4281
4333
|
## SupportButtonTo
|
|
4282
4334
|
|
|
4283
4335
|
### Fields
|