@rippling/pebble-sdui-web 0.21.2 → 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 +24 -0
- package/dist/catalogs/custom-apps/index.cjs +1 -1
- 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 +85 -2
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +4 -3
- 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 +52 -0
- package/package.json +1 -1
|
@@ -5781,14 +5781,14 @@ width: optional CSS width string or pixel number passed to the underlying Grid.
|
|
|
5781
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.
|
|
5782
5782
|
caption: optional sub-title rendered beneath the grid title. Falls back to the backend-configured caption when omitted.
|
|
5783
5783
|
rowActions: optional static row action configs. Dynamic per-row factories are not supported in SDUI; use booleans for isDisabled/isHidden.
|
|
5784
|
-
Events do not receive payload arguments. Bind rowClickedData, rowActionClickedId, or
|
|
5785
|
-
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.
|
|
5786
5786
|
|
|
5787
5787
|
Catalog key: `SuperGrid`
|
|
5788
5788
|
Builder: `SuperGrid`
|
|
5789
5789
|
Props type: `SuperGridProps`
|
|
5790
5790
|
Accepts children: no
|
|
5791
|
-
Events: `rowClick`, `rowActionClick`
|
|
5791
|
+
Events: `rowClick`, `rowActionClick`, `edit`
|
|
5792
5792
|
|
|
5793
5793
|
### Props
|
|
5794
5794
|
|
|
@@ -5797,6 +5797,7 @@ Events: `rowClick`, `rowActionClick`
|
|
|
5797
5797
|
| `caption` | no | string | Optional caption rendered below the grid title. |
|
|
5798
5798
|
| `configContext` | no | [ConfigContext](./types.md#configcontext) | Query context sent to dynamic config modifiers for backend-owned variants. |
|
|
5799
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. |
|
|
5800
5801
|
| `gridId` | yes | string | Unique identifier for the grid configuration fetched from the backend. |
|
|
5801
5802
|
| `height` | no | string | Any CSS height string (e.g. "400px", "60vh"). When omitted the grid auto-sizes to its rows. |
|
|
5802
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.
|
|
@@ -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
|