@rippling/pebble-sdui-web 0.21.0 → 0.21.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/action-params.d.ts +2 -1
- package/dist/catalogs/custom-apps/catalog.d.ts +1 -1
- package/dist/catalogs/custom-apps/component-props.d.ts +7 -0
- package/dist/catalogs/custom-apps/index.cjs +3 -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 +43 -3
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/actions.md +2 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +5 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +12 -1
- package/package.json +1 -1
|
@@ -64,6 +64,7 @@ Open Chat Assistant and send an initial message in a new conversation.
|
|
|
64
64
|
|
|
65
65
|
text: prompt/message that should be sent immediately after Chat Assistant opens.
|
|
66
66
|
target: optional Chat Assistant surface target. Omit to use the default chat surface.
|
|
67
|
+
attachments: optional FormFileDrop values. FormFileDrop can restrict selectable file types; Chat Assistant validates final support.
|
|
67
68
|
|
|
68
69
|
Catalog key: `openChatAssistantWithMessage`
|
|
69
70
|
Creator: `openChatAssistantWithMessage`
|
|
@@ -73,6 +74,7 @@ Params type: `OpenChatAssistantWithMessageParams`
|
|
|
73
74
|
|
|
74
75
|
| Name | Required | Type | Description |
|
|
75
76
|
|---|---:|---|---|
|
|
77
|
+
| `attachments` | no | [Attachment](./types.md#attachment)[] | Optional FormFileDrop values to attach to the initial message. Each value must include name and base64 data-URL content. FormFileDrop can restrict selectable file types; Chat Assistant validates final support. |
|
|
76
78
|
| `target` | no | [openChatAssistantWithMessageTarget](./definitions.md#openchatassistantwithmessagetarget) | Optional Chat Assistant surface target. |
|
|
77
79
|
| `text` | yes | string | Initial message to send in a new Chat Assistant conversation. Must contain at least one non-whitespace character. |
|
|
78
80
|
|
|
@@ -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 |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
# custom-apps Catalog
|
|
3
3
|
|
|
4
4
|
Catalog: `custom-apps`
|
|
5
|
-
Version: `1.12.
|
|
5
|
+
Version: `1.12.3`
|
|
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.
|
|
@@ -295,6 +295,17 @@ No additional properties.
|
|
|
295
295
|
|
|
296
296
|
No additional properties.
|
|
297
297
|
|
|
298
|
+
## Attachment
|
|
299
|
+
|
|
300
|
+
### Fields
|
|
301
|
+
|
|
302
|
+
| Name | Required | Type | Description |
|
|
303
|
+
|---|---:|---|---|
|
|
304
|
+
| `name` | yes | string | File name. |
|
|
305
|
+
| `content` | yes | string | File content as a base64 data URL. |
|
|
306
|
+
|
|
307
|
+
Additional properties: unknown.
|
|
308
|
+
|
|
298
309
|
## AvatarBadge
|
|
299
310
|
|
|
300
311
|
Badge overlay configuration for the avatar
|
|
@@ -3626,7 +3637,7 @@ No additional properties.
|
|
|
3626
3637
|
| Name | Required | Type | Description |
|
|
3627
3638
|
|---|---:|---|---|
|
|
3628
3639
|
| `hasError` | no | boolean | Marks the step as having an error |
|
|
3629
|
-
| `icon` | no | string |
|
|
3640
|
+
| `icon` | no | string | Pebble icon name to display for the step (e.g. "CHECK_CIRCLE_OUTLINE"). |
|
|
3630
3641
|
| `isDisabled` | no | boolean | Disables the step |
|
|
3631
3642
|
| `subtitle` | no | string | Subtitle text for the step |
|
|
3632
3643
|
| `title` | no | string | Title text for the step |
|