@rippling/pebble-sdui-web 0.18.4 → 0.19.2
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-props.d.ts +19 -6
- package/dist/catalogs/custom-apps/components.d.ts +1 -1
- package/dist/catalogs/custom-apps/function-params.d.ts +21 -5
- package/dist/catalogs/custom-apps/functions.d.ts +20 -3
- 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 -1
- package/dist/catalogs/custom-apps/index.js +356 -45
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +3 -3
- package/dist/docs/typescript/web/catalogs/custom-apps/computed-functions.md +95 -1
- 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 +42 -0
- package/package.json +1 -1
|
@@ -1764,7 +1764,7 @@ Two binding surfaces (independent — use either, both, or neither):
|
|
|
1764
1764
|
|
|
1765
1765
|
2. `values` ($bindState on Form) — PUSH-ONLY aggregate. Form writes the merged `{name: value}` map to the bound path on every change. External writes to that path do NOT propagate back into inputs. Use only when something outside the form needs to observe the whole map; do not use to control inputs.
|
|
1766
1766
|
|
|
1767
|
-
`isSettings=true` renders the native edit/readonly toggle plus Save/Cancel buttons; pair with `isEdit` ($bindState) to control the mode. `onSubmit` fires with current values; use per-input `value` $state refs in the payload rather than relying on `values`. `skipButton` renders a secondary footer action and emits `skip` when clicked.
|
|
1767
|
+
`isSettings=true` renders the native edit/readonly toggle plus Save/Cancel buttons; pair with `isEdit` ($bindState) to control the mode. `onSubmit` fires with current values; use per-input `value` $state refs in the payload rather than relying on `values`. `skipButton` renders a secondary footer action, supports the same icon format as `submitButtonProps.icon`, and emits `skip` when clicked.
|
|
1768
1768
|
|
|
1769
1769
|
External `validationErrors` merge with input-reported errors; clear an error by writing a falsy value to that key.
|
|
1770
1770
|
|
|
@@ -6309,7 +6309,7 @@ No additional properties.
|
|
|
6309
6309
|
|
|
6310
6310
|
A supportive floating text box that offers contextual details about an associated element when hovered over or focused. Use for supplementary, non-critical information such as labelling icon buttons or describing ambiguous UI elements.
|
|
6311
6311
|
|
|
6312
|
-
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).
|
|
6312
|
+
Wrap any element with Tip to show a tooltip on hover. The child element is the hover target. Use the content prop for plain text or slots.content for rich nested content; the slot takes precedence. 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).
|
|
6313
6313
|
|
|
6314
6314
|
Catalog key: `Tip`
|
|
6315
6315
|
Builder: `Tip`
|
|
@@ -6322,7 +6322,7 @@ Events: _none_
|
|
|
6322
6322
|
| Name | Required | Type | Description |
|
|
6323
6323
|
|---|---:|---|---|
|
|
6324
6324
|
| `appearance` | no | [TipAppearance](./definitions.md#tipappearance) | Tooltip theme. Default: LIGHT |
|
|
6325
|
-
| `content` |
|
|
6325
|
+
| `content` | no | string | Plain text tooltip content. Use slots.content for rich content |
|
|
6326
6326
|
| `hideOnDocumentScroll` | no | boolean | Hide tooltip when the document is scrolled. Default: false |
|
|
6327
6327
|
| `isDelayed` | no | boolean | Add delay before showing/hiding the tooltip. Default: false |
|
|
6328
6328
|
| `isMobileSupported` | no | boolean | Show tooltip on mobile devices. Default: false |
|
|
@@ -3,4 +3,98 @@
|
|
|
3
3
|
|
|
4
4
|
Import computed function helpers from `@rippling/pebble-sdui-web/catalogs/custom-apps`. Read [definitions.md](./definitions.md) for enum values linked from param tables.
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
## arrayCompact
|
|
7
|
+
|
|
8
|
+
Remove null and undefined entries while preserving false, zero, and empty strings.
|
|
9
|
+
|
|
10
|
+
Catalog key: `array_compact`
|
|
11
|
+
Helper: `arrayCompact`
|
|
12
|
+
Params type: `ArrayCompactParams`
|
|
13
|
+
|
|
14
|
+
### Params
|
|
15
|
+
|
|
16
|
+
| Name | Required | Type | Description |
|
|
17
|
+
|---|---:|---|---|
|
|
18
|
+
| `items` | yes | unknown[] | |
|
|
19
|
+
|
|
20
|
+
No additional properties.
|
|
21
|
+
|
|
22
|
+
## arrayFilter
|
|
23
|
+
|
|
24
|
+
Return array items matching a composable predicate.
|
|
25
|
+
|
|
26
|
+
where supports eq and contains comparisons plus nested and/or groups.
|
|
27
|
+
field is a path on each item. value may be a literal or another json-render expression.
|
|
28
|
+
Comparisons are case-sensitive by default; set caseSensitive to false for case-insensitive strings.
|
|
29
|
+
|
|
30
|
+
Catalog key: `array_filter`
|
|
31
|
+
Helper: `arrayFilter`
|
|
32
|
+
Params type: `ArrayFilterParams`
|
|
33
|
+
|
|
34
|
+
### Params
|
|
35
|
+
|
|
36
|
+
| Name | Required | Type | Description |
|
|
37
|
+
|---|---:|---|---|
|
|
38
|
+
| `items` | yes | unknown[] | |
|
|
39
|
+
| `where` | yes | unknown | |
|
|
40
|
+
|
|
41
|
+
No additional properties.
|
|
42
|
+
|
|
43
|
+
## arrayIncludes
|
|
44
|
+
|
|
45
|
+
Return whether a scalar array contains a scalar value.
|
|
46
|
+
|
|
47
|
+
Catalog key: `array_includes`
|
|
48
|
+
Helper: `arrayIncludes`
|
|
49
|
+
Params type: `ArrayIncludesParams`
|
|
50
|
+
|
|
51
|
+
### Params
|
|
52
|
+
|
|
53
|
+
| Name | Required | Type | Description |
|
|
54
|
+
|---|---:|---|---|
|
|
55
|
+
| `items` | yes | string \| number \| boolean \| null[] | |
|
|
56
|
+
| `value` | yes | string \| number \| boolean \| null | |
|
|
57
|
+
|
|
58
|
+
No additional properties.
|
|
59
|
+
|
|
60
|
+
## arrayMap
|
|
61
|
+
|
|
62
|
+
Project a field or a named set of fields from every array item.
|
|
63
|
+
|
|
64
|
+
select may be a field path such as "entityId", returning one value per item.
|
|
65
|
+
select may also map output keys to input field paths, for example { id: "entityId" }.
|
|
66
|
+
Non-object items and missing fields produce undefined; compose with array_compact to remove them.
|
|
67
|
+
|
|
68
|
+
Catalog key: `array_map`
|
|
69
|
+
Helper: `arrayMap`
|
|
70
|
+
Params type: `ArrayMapParams`
|
|
71
|
+
|
|
72
|
+
### Params
|
|
73
|
+
|
|
74
|
+
| Name | Required | Type | Description |
|
|
75
|
+
|---|---:|---|---|
|
|
76
|
+
| `items` | yes | unknown[] | |
|
|
77
|
+
| `select` | yes | string \| [SelectValue](./types.md#selectvalue) | |
|
|
78
|
+
|
|
79
|
+
No additional properties.
|
|
80
|
+
|
|
81
|
+
## arraySome
|
|
82
|
+
|
|
83
|
+
Return whether at least one array item matches a composable predicate.
|
|
84
|
+
|
|
85
|
+
where supports eq and contains comparisons plus nested and/or groups.
|
|
86
|
+
field is a path on each item. value may be a literal or another json-render expression.
|
|
87
|
+
Comparisons are case-sensitive by default; set caseSensitive to false for case-insensitive strings.
|
|
88
|
+
|
|
89
|
+
Catalog key: `array_some`
|
|
90
|
+
Helper: `arraySome`
|
|
91
|
+
Params type: `ArraySomeParams`
|
|
92
|
+
|
|
93
|
+
### Params
|
|
94
|
+
|
|
95
|
+
| Name | Required | Type | Description |
|
|
96
|
+
|---|---:|---|---|
|
|
97
|
+
| `items` | yes | unknown[] | |
|
|
98
|
+
| `where` | yes | unknown | |
|
|
99
|
+
|
|
100
|
+
No additional properties.
|
|
@@ -438,6 +438,27 @@ Referenced by:
|
|
|
438
438
|
|---|---|---|
|
|
439
439
|
| component | `AppNavBar` | `theme` |
|
|
440
440
|
|
|
441
|
+
## ArrayPredicateValueOperator
|
|
442
|
+
|
|
443
|
+
TypeScript type:
|
|
444
|
+
|
|
445
|
+
```ts
|
|
446
|
+
"eq" | "contains"
|
|
447
|
+
```
|
|
448
|
+
|
|
449
|
+
Allowed values:
|
|
450
|
+
|
|
451
|
+
| Value |
|
|
452
|
+
|---|
|
|
453
|
+
| `eq` |
|
|
454
|
+
| `contains` |
|
|
455
|
+
|
|
456
|
+
Referenced by:
|
|
457
|
+
|
|
458
|
+
| Kind | Entity | Field |
|
|
459
|
+
|---|---|---|
|
|
460
|
+
| type | `ArrayPredicateValue` | `operator` |
|
|
461
|
+
|
|
441
462
|
## AtomsSeparatorTheme
|
|
442
463
|
|
|
443
464
|
TypeScript type:
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
# custom-apps Catalog
|
|
3
3
|
|
|
4
4
|
Catalog: `custom-apps`
|
|
5
|
-
Version: `1.
|
|
5
|
+
Version: `1.10.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.
|
|
@@ -262,6 +262,39 @@ Badge shown next to the nav item title
|
|
|
262
262
|
|
|
263
263
|
No additional properties.
|
|
264
264
|
|
|
265
|
+
## ArrayPredicateValue
|
|
266
|
+
|
|
267
|
+
### Fields
|
|
268
|
+
|
|
269
|
+
| Name | Required | Type | Description |
|
|
270
|
+
|---|---:|---|---|
|
|
271
|
+
| `caseSensitive` | no | boolean | |
|
|
272
|
+
| `field` | yes | string | |
|
|
273
|
+
| `operator` | yes | [ArrayPredicateValueOperator](./definitions.md#arraypredicatevalueoperator) | |
|
|
274
|
+
| `value` | yes | string \| number \| boolean \| null | |
|
|
275
|
+
|
|
276
|
+
No additional properties.
|
|
277
|
+
|
|
278
|
+
## ArrayPredicateValueVariant2
|
|
279
|
+
|
|
280
|
+
### Fields
|
|
281
|
+
|
|
282
|
+
| Name | Required | Type | Description |
|
|
283
|
+
|---|---:|---|---|
|
|
284
|
+
| `and` | yes | unknown[] | |
|
|
285
|
+
|
|
286
|
+
No additional properties.
|
|
287
|
+
|
|
288
|
+
## ArrayPredicateValueVariant3
|
|
289
|
+
|
|
290
|
+
### Fields
|
|
291
|
+
|
|
292
|
+
| Name | Required | Type | Description |
|
|
293
|
+
|---|---:|---|---|
|
|
294
|
+
| `or` | yes | unknown[] | |
|
|
295
|
+
|
|
296
|
+
No additional properties.
|
|
297
|
+
|
|
265
298
|
## AvatarBadge
|
|
266
299
|
|
|
267
300
|
Badge overlay configuration for the avatar
|
|
@@ -3990,6 +4023,14 @@ No additional properties.
|
|
|
3990
4023
|
|
|
3991
4024
|
No additional properties.
|
|
3992
4025
|
|
|
4026
|
+
## SelectValue
|
|
4027
|
+
|
|
4028
|
+
### Fields
|
|
4029
|
+
|
|
4030
|
+
_No fields._
|
|
4031
|
+
|
|
4032
|
+
Additional properties: string.
|
|
4033
|
+
|
|
3993
4034
|
## ShouldShowHeader
|
|
3994
4035
|
|
|
3995
4036
|
### Fields
|
|
@@ -4060,6 +4101,7 @@ Secondary skip action. Click emits the skip event.
|
|
|
4060
4101
|
|
|
4061
4102
|
| Name | Required | Type | Description |
|
|
4062
4103
|
|---|---:|---|---|
|
|
4104
|
+
| `icon` | no | string \| [FormIcon](./types.md#formicon) | Icon to show in the skip button |
|
|
4063
4105
|
| `label` | no | string | Skip button label. Defaults to the Pebble skip label |
|
|
4064
4106
|
|
|
4065
4107
|
No additional properties.
|