@rippling/pebble-sdui-web 0.23.0 → 0.24.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 +1 -0
- package/dist/catalogs/custom-apps/component-props.d.ts +120 -2
- package/dist/catalogs/custom-apps/components.d.ts +3 -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 +726 -125
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +57 -4
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +88 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +165 -0
- package/package.json +1 -1
|
@@ -219,7 +219,9 @@ Events: `navigate`, `action`
|
|
|
219
219
|
| `actions` | no | [AppNavBarAction](./types.md#appnavbaraction)[] | Array of action buttons displayed in the nav bar. Each emits an action event with its id |
|
|
220
220
|
| `activeUrl` | no | string | The currently active URL path. Use $bindState to two-way bind this to state — the value updates automatically when the user clicks a nav item. |
|
|
221
221
|
| `baseURL` | no | string | Base URL prefix prepended to all link paths |
|
|
222
|
+
| `breadcrumbs` | no | [AppNavBarBreadcrumb](./types.md#appnavbarbreadcrumb)[] | Breadcrumb items for the v2 header: {title, value, isDisabled?, href?}. Only rendered when isV2 is true |
|
|
222
223
|
| `isLogoRound` | no | boolean | If true, logo has rounded corners |
|
|
224
|
+
| `isV2` | no | boolean | Enable the v2 app shell layout: breadcrumb header, updated tab styling, and "More" overflow. Default: false |
|
|
223
225
|
| `isVertical` | no | boolean | If true, renders a vertical sidebar navigation instead of horizontal tabs |
|
|
224
226
|
| `links` | no | Record<string, unknown>[] | Navigation items. Omit or pass an empty array to render the header without tabs |
|
|
225
227
|
| `logoUrl` | no | string | URL for a logo image in the header area |
|
|
@@ -617,7 +619,7 @@ No additional properties.
|
|
|
617
619
|
|
|
618
620
|
Visually groups related information and components into a contained, interactive card. Use for summarizing content, facilitating comparisons, or guiding users toward specific actions. Renders as a simple layout container when used with children only (no title/content).
|
|
619
621
|
|
|
620
|
-
Card emits "click" when clicked, "edit"/"delete" for those actions, "add" for add cards, and "action" when a dropdown action is clicked. The clicked action id is written to the selectedActionId bound state before the "action" event fires. Use "to" prop for navigation. Use "content" prop for simple text or children for complex layouts. In layout mode (children only, no title/content), padding, theme, and fluid are passed to Card.Layout. IMPORTANT: There is no margin beneath the card title. Always use a VStack with a top padding token as the first child of the Card to create spacing between the title and the content below.
|
|
622
|
+
Card emits "click" when clicked, "edit"/"delete" for those actions, "add" for add cards, and "action" when a dropdown action is clicked. The clicked action id is written to the selectedActionId bound state before the "action" event fires. Use "to" prop for navigation. Use "content" prop for simple text or children for complex layouts. In layout mode (children only, no title/content), padding, theme, and fluid are passed to Card.Layout. Prefer spacing tokens for padding (e.g. space300). Existing numeric and CSS padding inputs remain supported. Padding is ignored in basic card mode. IMPORTANT: There is no margin beneath the card title. Always use a VStack with a top padding token as the first child of the Card to create spacing between the title and the content below.
|
|
621
623
|
|
|
622
624
|
Catalog key: `Card`
|
|
623
625
|
Builder: `Card`
|
|
@@ -636,7 +638,7 @@ Events: `edit`, `delete`, `add`, `click`, `action`
|
|
|
636
638
|
| `isAddCard` | no | boolean | Render as add card with plus icon. Emits "add" event when clicked. Default: false |
|
|
637
639
|
| `isDisabled` | no | boolean | Whether the card is disabled. Default: false |
|
|
638
640
|
| `minCardHeight` | no | number \| string | Minimum height of card. Number values are pixels. Default: 150 |
|
|
639
|
-
| `padding` | no | 0 \| 8 \| 16 \| 24 \| 32 \| string |
|
|
641
|
+
| `padding` | no | 0 \| 8 \| 16 \| 24 \| 32 \| [BoxGap](./definitions.md#boxgap) \| string | Layout mode only (children without title/content). Spacing token (e.g. space300), Card.Layout PADDINGS number (0, 8, 16, 24, 32), or CSS padding string. Spacing tokens are resolved from the active theme. CSS strings pass through unchanged. Ignored in basic card mode |
|
|
640
642
|
| `selectedActionId` | no | string | Bound state path for the selected action id. Written before "action" event fires |
|
|
641
643
|
| `showDelete` | no | boolean | Show delete button. Emits "delete" event when clicked. Default: false |
|
|
642
644
|
| `showEdit` | no | boolean | Show edit button. Emits "edit" event when clicked. Default: false |
|
|
@@ -3207,6 +3209,7 @@ Events: `change`, `blur`
|
|
|
3207
3209
|
| `maxLength` | no | number | Maximum character count |
|
|
3208
3210
|
| `maxWidth` | no | string | Maximum width CSS value |
|
|
3209
3211
|
| `minLength` | no | number | Minimum character count |
|
|
3212
|
+
| `passwordManagers` | no | [FormTextPasswordManagers](./definitions.md#formtextpasswordmanagers) | Password-manager autofill (LastPass, 1Password, Bitwarden, Dashlane). "off" suppresses it on non-credential fields. Default: "auto" (disabled on search inputs, enabled elsewhere) |
|
|
3210
3213
|
| `placeholder` | no | string | Placeholder text when empty |
|
|
3211
3214
|
| `prefix` | no | string | Text or icon name from Icon.TYPES to show before the input value |
|
|
3212
3215
|
| `readOnlyAffixSpacing` | no | boolean | Controls gap between affixes and value in read-only mode. Default: true. Set false to remove gap |
|
|
@@ -3299,6 +3302,7 @@ Events: `change`, `blur`
|
|
|
3299
3302
|
| `label` | no | string | Label text above the input |
|
|
3300
3303
|
| `list` | yes | [FormTextAutoSuggestList](./types.md#formtextautosuggestlist)[] | Flat suggestion list matching the React `list` item shape |
|
|
3301
3304
|
| `maxLength` | no | number | Maximum character count |
|
|
3305
|
+
| `passwordManagers` | no | [FormTextPasswordManagers](./definitions.md#formtextpasswordmanagers) | Password-manager autofill (LastPass, 1Password, Bitwarden, Dashlane). Default: "off" since suggestions inputs are not credential fields; set "auto" to re-enable |
|
|
3302
3306
|
| `placeholder` | no | string | Placeholder text when empty |
|
|
3303
3307
|
| `shouldShowMenuOnFocus` | no | boolean | Show dropdown menu on input focus. Default: false |
|
|
3304
3308
|
| `shouldShowSearchIcon` | no | boolean | Show search icon prefix. Default: false |
|
|
@@ -4047,7 +4051,7 @@ No additional properties.
|
|
|
4047
4051
|
|
|
4048
4052
|
A standard card container for creating card-based page layouts with configurable padding and an optional selectable theme for selection interfaces.
|
|
4049
4053
|
|
|
4050
|
-
LayoutCard is a layout wrapper component providing consistent card styling with configurable padding. Use SELECTABLE theme for selection interfaces. Emits "press" event when clicked (requires onClick binding).
|
|
4054
|
+
LayoutCard is a layout wrapper component providing consistent card styling with configurable padding. Prefer spacing tokens for padding (e.g. space300); they are resolved from the active theme. Legacy PX_0/PX_8/PX_16/PX_24/PX_32 values remain supported. Omitted padding defaults to PX_24. Use SELECTABLE theme for selection interfaces. Emits "press" event when clicked (requires onClick binding).
|
|
4051
4055
|
|
|
4052
4056
|
Catalog key: `LayoutCard`
|
|
4053
4057
|
Builder: `LayoutCard`
|
|
@@ -4060,7 +4064,7 @@ Events: `press`
|
|
|
4060
4064
|
| Name | Required | Type | Description |
|
|
4061
4065
|
|---|---:|---|---|
|
|
4062
4066
|
| `fluid` | no | boolean | When true, the card fills its parent width (including inside row layouts, where it would otherwise size to its content). Default: false |
|
|
4063
|
-
| `padding` | no | [LayoutCardPadding](./definitions.md#layoutcardpadding) |
|
|
4067
|
+
| `padding` | no | [LayoutCardPadding](./definitions.md#layoutcardpadding) | Spacing token (e.g. space300) or legacy PX_0/PX_8/PX_16/PX_24/PX_32 padding. Default: PX_24 |
|
|
4064
4068
|
| `theme` | no | [CardTheme](./definitions.md#cardtheme) | Card theme. SELECTABLE adds 2px tertiary border for selection UI. Default: DEFAULT |
|
|
4065
4069
|
|
|
4066
4070
|
No additional properties.
|
|
@@ -5249,6 +5253,51 @@ Events: _none_
|
|
|
5249
5253
|
|
|
5250
5254
|
No additional properties.
|
|
5251
5255
|
|
|
5256
|
+
## RichTextEditor
|
|
5257
|
+
|
|
5258
|
+
Rich text input or read-only document using Pebble RichTextEditor. Set editable=true and bind htmlContent to persist edits as HTML.
|
|
5259
|
+
|
|
5260
|
+
initialContent is applied once on mount. htmlContent, markdownContent and jsonContent are output bindings, not controlled document values. Seed initialContent and htmlContent with the same draft when saving an untouched document. Output bindings may start null.
|
|
5261
|
+
Each edit exports HTML and requested Markdown/JSON outputs, writes successful bound outputs, then fires change. Initialization does not write output or fire change. Actions on change can read completed outputs. If an optional Markdown/JSON export fails, its previous bound value is retained and HTML/change still succeed; an HTML export failure does not fire change.
|
|
5262
|
+
HTML extraction is asynchronous. There is no debounce or Save flush API; persist from change or save the latest completed bound output.
|
|
5263
|
+
editable=false hides editing controls; editable=true with disabled=true preserves the editing presentation but prevents interaction.
|
|
5264
|
+
features uses Pebble names; variables and fileUpload default to false. mentionables defaults to false for SDUI compatibility; enable it explicitly for configured custom mentions or host employee lookup. Choose structural features before mounting.
|
|
5265
|
+
Set features.markdown=false to disable Markdown parsing; HTML-looking content is still imported as HTML. markdownContent becomes an empty string when Markdown is disabled. JSON output is serialized text, not a runtime EditorState instance.
|
|
5266
|
+
Static variables require features.variables=true and config.variable.variables. Local image insertion requires features.fileUpload=true; config.upload.cloudStorage must be false when provided.
|
|
5267
|
+
Custom mentions require features.mentionables=true and config.mentionables entries with trigger and options. The renderer supplies case-insensitive label/caption search; reserved @, : and / triggers keep their host behavior.
|
|
5268
|
+
This is a standalone editor, not a Form field. Empty content can contain HTML markup; validate meaningful text rather than HTML string length.
|
|
5269
|
+
|
|
5270
|
+
Catalog key: `RichTextEditor`
|
|
5271
|
+
Builder: `RichTextEditor`
|
|
5272
|
+
Props type: `RichTextEditorProps`
|
|
5273
|
+
Accepts children: no
|
|
5274
|
+
Events: `change`
|
|
5275
|
+
|
|
5276
|
+
### Props
|
|
5277
|
+
|
|
5278
|
+
| Name | Required | Type | Description |
|
|
5279
|
+
|---|---:|---|---|
|
|
5280
|
+
| `aria-label` | no | string | Accessible editor label. |
|
|
5281
|
+
| `aria-labelledby` | no | string | Id of the element labeling the editor. |
|
|
5282
|
+
| `config` | no | [Config](./types.md#config) | JSON-safe editor plugin configuration for static variables, local images and custom mention options. |
|
|
5283
|
+
| `containerStyle` | no | [ContainerStyle](./types.md#containerstyle) | Plain editor dimensions. Arbitrary border/color styling is excluded. |
|
|
5284
|
+
| `defaultSelection` | no | [RichTextEditorDefaultSelection](./definitions.md#richtexteditordefaultselection) | Initial selection position; does not control later selection. |
|
|
5285
|
+
| `disableAudioEye` | no | boolean | Adds data-audioeye-ignore to the editor textbox when true. Defaults to false. |
|
|
5286
|
+
| `disabled` | no | boolean | Disables interaction while retaining the editing presentation. Defaults to false. |
|
|
5287
|
+
| `editable` | no | boolean | Allows editing. Defaults to false; set true for an input. |
|
|
5288
|
+
| `features` | no | [Feature](./types.md#feature) | Optional editor feature flags. Omitted flags retain Pebble defaults. Choose structural features such as table before mounting the editor. |
|
|
5289
|
+
| `focusedPlaceholder` | no | string | Placeholder shown in a focused empty block. |
|
|
5290
|
+
| `htmlContent` | no | string | HTML output. Bind with $bindState to receive edits before change fires. An initially null bound state is treated as absent output; literal null is not supported. This does not control or initialize the document; seed initialContent separately. |
|
|
5291
|
+
| `initialContent` | no | string | Mount-time document content. Omit or use an empty string for an empty document. HTML-looking strings import as HTML; other strings import as Markdown when features.markdown is enabled. Later changes do not replace the document. |
|
|
5292
|
+
| `jsonContent` | no | string | Serialized editor-state JSON text output binding, written before change. Parse the string to read its root/nodes. This is not a supported initialContent input. |
|
|
5293
|
+
| `markdownContent` | no | string | Markdown output binding. Written before change on successful export. When features.markdown=false, writes an empty string. Rich nodes may not have a lossless Markdown representation. |
|
|
5294
|
+
| `overrideToLight` | no | boolean | Forces the editor sheet to use the light theme. |
|
|
5295
|
+
| `placeholder` | no | string | Placeholder for an empty editor. |
|
|
5296
|
+
| `shouldDisableFormatting` | no | boolean | Disables formatting controls. |
|
|
5297
|
+
| `toolbar` | no | boolean | Shows the toolbar when editable. Defaults to true. |
|
|
5298
|
+
|
|
5299
|
+
No additional properties.
|
|
5300
|
+
|
|
5252
5301
|
## SegmentedControl
|
|
5253
5302
|
|
|
5254
5303
|
A linear set of buttons for toggling between closely related choices (2-5 short-label options) and instantly applying a selection. Supports single, multi, and range selection modes. NOT suitable for binary (2-option) choices — use Toggle or ToggleButton instead. Prefer over Radio when options are short labels needing a compact inline layout; use Radio for longer phrases, Tabs for content navigation.
|
|
@@ -5981,9 +6030,11 @@ Events: `change`
|
|
|
5981
6030
|
| `activeIndex` | no | number | Controlled active tab index |
|
|
5982
6031
|
| `aria-label` | no | string | Accessible label for the tabs |
|
|
5983
6032
|
| `aria-labelledby` | no | string | ID of element that labels the tabs |
|
|
6033
|
+
| `breadcrumbs` | no | [TabBreadcrumb](./types.md#tabbreadcrumb)[] | Breadcrumb items for the v2 header: {title, value, isDisabled?, href?}. Only rendered when isV2 is true on horizontal LINK tabs; without it the v2 header shows no title |
|
|
5984
6034
|
| `defaultActiveIndex` | no | number | Tab index to be active by default |
|
|
5985
6035
|
| `isCompact` | no | boolean | Use compact spacing |
|
|
5986
6036
|
| `isLogoRound` | no | boolean | Whether to display logo with rounded corners |
|
|
6037
|
+
| `isV2` | no | boolean | Enable the v2 app-shell tab styling (updated spacing, typography, active indicator, "More" overflow). Only applies to horizontal LINK tabs. Default: false |
|
|
5987
6038
|
| `isVertical` | no | boolean | Display tabs in vertical orientation (only for LINK type) |
|
|
5988
6039
|
| `items` | no | [TabItem](./types.md#tabitem)[] | JSON-only selection model for state-bound tabs with title, value, and optional icon/badge/tip |
|
|
5989
6040
|
| `list` | no | [TabList](./types.md#tablist)[] | React Tabs list branch for LINK tabs, including optional nested links |
|
|
@@ -6140,6 +6191,7 @@ Events: `change`, `blur`, `focus`, `click`
|
|
|
6140
6191
|
| `maxLength` | no | number | Maximum character count |
|
|
6141
6192
|
| `maxWidth` | no | string | Maximum width CSS value |
|
|
6142
6193
|
| `minLength` | no | number | Minimum character count |
|
|
6194
|
+
| `passwordManagers` | no | [FormTextPasswordManagers](./definitions.md#formtextpasswordmanagers) | Password-manager autofill (LastPass, 1Password, Bitwarden, Dashlane). Default: "off" since suggestions inputs are not credential fields; set "auto" to re-enable |
|
|
6143
6195
|
| `placeholder` | no | string | Placeholder text when empty |
|
|
6144
6196
|
| `prefix` | no | string | Text or icon name from Icon.TYPES to show before the input value |
|
|
6145
6197
|
| `readOnlyAffixSpacing` | no | boolean | Controls gap between affixes and value in read-only mode. Default: true. Set false to remove gap |
|
|
@@ -6234,6 +6286,7 @@ Events: `change`, `blur`, `focus`, `click`, `keydown`, `keyup`, `paste`, `mousee
|
|
|
6234
6286
|
| `maxLength` | no | number | Maximum character count |
|
|
6235
6287
|
| `maxWidth` | no | string | Maximum width CSS value |
|
|
6236
6288
|
| `minLength` | no | number | Minimum character count |
|
|
6289
|
+
| `passwordManagers` | no | [FormTextPasswordManagers](./definitions.md#formtextpasswordmanagers) | Password-manager autofill (LastPass, 1Password, Bitwarden, Dashlane). "off" suppresses it on non-credential fields. Default: "auto" (disabled on search inputs, enabled elsewhere) |
|
|
6237
6290
|
| `placeholder` | no | string | Placeholder text when empty |
|
|
6238
6291
|
| `prefix` | no | string | Text or icon name from Icon.TYPES to show before the input value |
|
|
6239
6292
|
| `readOnlyAffixSpacing` | no | boolean | Controls gap between affixes and value in read-only mode. Default: true. Set false to remove gap |
|
|
@@ -931,6 +931,7 @@ Referenced by:
|
|
|
931
931
|
| component | `Box` | `margin` |
|
|
932
932
|
| component | `Box` | `padding` |
|
|
933
933
|
| component | `ButtonGroup` | `gap` |
|
|
934
|
+
| component | `Card` | `padding` |
|
|
934
935
|
| component | `ChipGroup` | `gap` |
|
|
935
936
|
| component | `ColorPicker` | `columnGap` |
|
|
936
937
|
| component | `ColorPicker` | `rowGap` |
|
|
@@ -2443,6 +2444,30 @@ Referenced by:
|
|
|
2443
2444
|
| component | `FormSurvey` | `theme` |
|
|
2444
2445
|
| component | `Survey` | `theme` |
|
|
2445
2446
|
|
|
2447
|
+
## FormTextPasswordManagers
|
|
2448
|
+
|
|
2449
|
+
TypeScript type:
|
|
2450
|
+
|
|
2451
|
+
```ts
|
|
2452
|
+
"auto" | "off"
|
|
2453
|
+
```
|
|
2454
|
+
|
|
2455
|
+
Allowed values:
|
|
2456
|
+
|
|
2457
|
+
| Value |
|
|
2458
|
+
|---|
|
|
2459
|
+
| `auto` |
|
|
2460
|
+
| `off` |
|
|
2461
|
+
|
|
2462
|
+
Referenced by:
|
|
2463
|
+
|
|
2464
|
+
| Kind | Entity | Field |
|
|
2465
|
+
|---|---|---|
|
|
2466
|
+
| component | `FormText` | `passwordManagers` |
|
|
2467
|
+
| component | `FormTextAutoSuggest` | `passwordManagers` |
|
|
2468
|
+
| component | `TextAutoSuggest` | `passwordManagers` |
|
|
2469
|
+
| component | `TextInput` | `passwordManagers` |
|
|
2470
|
+
|
|
2446
2471
|
## FormTheme
|
|
2447
2472
|
|
|
2448
2473
|
TypeScript type:
|
|
@@ -2979,7 +3004,7 @@ Referenced by:
|
|
|
2979
3004
|
TypeScript type:
|
|
2980
3005
|
|
|
2981
3006
|
```ts
|
|
2982
|
-
"PX_0" | "PX_8" | "PX_16" | "PX_24" | "PX_32"
|
|
3007
|
+
"PX_0" | "PX_8" | "PX_16" | "PX_24" | "PX_32" | "space0" | "space25" | "space50" | "space75" | "space100" | "space125" | "space150" | "space175" | "space200" | "space225" | "space250" | "space275" | "space300" | "space350" | "space400" | "space450" | "space500" | "space600" | "space700" | "space800" | "space900" | "space1000" | "space1100" | "space1200" | "space1400" | "space1600" | "space2000" | "space2400" | "space2800" | "space3200" | "space3600" | "space4000" | "space4400" | "space4800" | "space5200" | "space5600" | "space6000" | "space6400" | "space7200" | "space8000" | "space9600"
|
|
2983
3008
|
```
|
|
2984
3009
|
|
|
2985
3010
|
Allowed values:
|
|
@@ -2991,6 +3016,47 @@ Allowed values:
|
|
|
2991
3016
|
| `PX_16` |
|
|
2992
3017
|
| `PX_24` |
|
|
2993
3018
|
| `PX_32` |
|
|
3019
|
+
| `space0` |
|
|
3020
|
+
| `space25` |
|
|
3021
|
+
| `space50` |
|
|
3022
|
+
| `space75` |
|
|
3023
|
+
| `space100` |
|
|
3024
|
+
| `space125` |
|
|
3025
|
+
| `space150` |
|
|
3026
|
+
| `space175` |
|
|
3027
|
+
| `space200` |
|
|
3028
|
+
| `space225` |
|
|
3029
|
+
| `space250` |
|
|
3030
|
+
| `space275` |
|
|
3031
|
+
| `space300` |
|
|
3032
|
+
| `space350` |
|
|
3033
|
+
| `space400` |
|
|
3034
|
+
| `space450` |
|
|
3035
|
+
| `space500` |
|
|
3036
|
+
| `space600` |
|
|
3037
|
+
| `space700` |
|
|
3038
|
+
| `space800` |
|
|
3039
|
+
| `space900` |
|
|
3040
|
+
| `space1000` |
|
|
3041
|
+
| `space1100` |
|
|
3042
|
+
| `space1200` |
|
|
3043
|
+
| `space1400` |
|
|
3044
|
+
| `space1600` |
|
|
3045
|
+
| `space2000` |
|
|
3046
|
+
| `space2400` |
|
|
3047
|
+
| `space2800` |
|
|
3048
|
+
| `space3200` |
|
|
3049
|
+
| `space3600` |
|
|
3050
|
+
| `space4000` |
|
|
3051
|
+
| `space4400` |
|
|
3052
|
+
| `space4800` |
|
|
3053
|
+
| `space5200` |
|
|
3054
|
+
| `space5600` |
|
|
3055
|
+
| `space6000` |
|
|
3056
|
+
| `space6400` |
|
|
3057
|
+
| `space7200` |
|
|
3058
|
+
| `space8000` |
|
|
3059
|
+
| `space9600` |
|
|
2994
3060
|
|
|
2995
3061
|
Referenced by:
|
|
2996
3062
|
|
|
@@ -3785,6 +3851,27 @@ Referenced by:
|
|
|
3785
3851
|
|---|---|---|
|
|
3786
3852
|
| component | `Responsive` | `mode` |
|
|
3787
3853
|
|
|
3854
|
+
## RichTextEditorDefaultSelection
|
|
3855
|
+
|
|
3856
|
+
TypeScript type:
|
|
3857
|
+
|
|
3858
|
+
```ts
|
|
3859
|
+
"rootStart" | "rootEnd"
|
|
3860
|
+
```
|
|
3861
|
+
|
|
3862
|
+
Allowed values:
|
|
3863
|
+
|
|
3864
|
+
| Value |
|
|
3865
|
+
|---|
|
|
3866
|
+
| `rootStart` |
|
|
3867
|
+
| `rootEnd` |
|
|
3868
|
+
|
|
3869
|
+
Referenced by:
|
|
3870
|
+
|
|
3871
|
+
| Kind | Entity | Field |
|
|
3872
|
+
|---|---|---|
|
|
3873
|
+
| component | `RichTextEditor` | `defaultSelection` |
|
|
3874
|
+
|
|
3788
3875
|
## RowActionAppearance
|
|
3789
3876
|
|
|
3790
3877
|
TypeScript type:
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
# custom-apps Catalog
|
|
3
3
|
|
|
4
4
|
Catalog: `custom-apps`
|
|
5
|
-
Version: `1.
|
|
5
|
+
Version: `1.15.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.
|
|
@@ -249,6 +249,19 @@ No additional properties.
|
|
|
249
249
|
|
|
250
250
|
No additional properties.
|
|
251
251
|
|
|
252
|
+
## AppNavBarBreadcrumb
|
|
253
|
+
|
|
254
|
+
### Fields
|
|
255
|
+
|
|
256
|
+
| Name | Required | Type | Description |
|
|
257
|
+
|---|---:|---|---|
|
|
258
|
+
| `href` | no | string | URL to navigate to when clicked |
|
|
259
|
+
| `isDisabled` | no | boolean | Disables the breadcrumb item |
|
|
260
|
+
| `title` | yes | string | Display label for the breadcrumb item |
|
|
261
|
+
| `value` | yes | string | Unique value identifier for the item |
|
|
262
|
+
|
|
263
|
+
No additional properties.
|
|
264
|
+
|
|
252
265
|
## AppNavBarNavItemBadge
|
|
253
266
|
|
|
254
267
|
Badge shown next to the nav item title
|
|
@@ -802,6 +815,20 @@ No additional properties.
|
|
|
802
815
|
|
|
803
816
|
No additional properties.
|
|
804
817
|
|
|
818
|
+
## Config
|
|
819
|
+
|
|
820
|
+
JSON-safe editor plugin configuration for static variables, local images and custom mention options.
|
|
821
|
+
|
|
822
|
+
### Fields
|
|
823
|
+
|
|
824
|
+
| Name | Required | Type | Description |
|
|
825
|
+
|---|---:|---|---|
|
|
826
|
+
| `mentionables` | no | [Mentionable](./types.md#mentionable)[] | Custom mention configurations; requires features.mentionables=true. Use options instead of a runtime callback. |
|
|
827
|
+
| `upload` | no | [Upload](./types.md#upload) | Local image upload configuration; requires features.fileUpload=true. |
|
|
828
|
+
| `variable` | no | [Variable](./types.md#variable) | Static variable configuration; function getters and custom search/sort callbacks are excluded. |
|
|
829
|
+
|
|
830
|
+
No additional properties.
|
|
831
|
+
|
|
805
832
|
## ConfigContext
|
|
806
833
|
|
|
807
834
|
Query context sent to dynamic config modifiers for backend-owned variants.
|
|
@@ -812,6 +839,23 @@ _No fields._
|
|
|
812
839
|
|
|
813
840
|
Additional properties: string.
|
|
814
841
|
|
|
842
|
+
## ContainerStyle
|
|
843
|
+
|
|
844
|
+
Plain editor dimensions. Arbitrary border/color styling is excluded.
|
|
845
|
+
|
|
846
|
+
### Fields
|
|
847
|
+
|
|
848
|
+
| Name | Required | Type | Description |
|
|
849
|
+
|---|---:|---|---|
|
|
850
|
+
| `height` | no | number \| string | Editor container height; number in pixels or CSS dimension. |
|
|
851
|
+
| `maxHeight` | no | number \| string | Maximum editor container height; number in pixels or CSS dimension. |
|
|
852
|
+
| `maxWidth` | no | number \| string | Maximum editor container width; number in pixels or CSS dimension. |
|
|
853
|
+
| `minHeight` | no | number \| string | Minimum editor container height; number in pixels or CSS dimension. |
|
|
854
|
+
| `minWidth` | no | number \| string | Minimum editor container width; number in pixels or CSS dimension. |
|
|
855
|
+
| `width` | no | number \| string | Editor container width; number in pixels or CSS dimension. |
|
|
856
|
+
|
|
857
|
+
No additional properties.
|
|
858
|
+
|
|
815
859
|
## ContextFilter
|
|
816
860
|
|
|
817
861
|
### Fields
|
|
@@ -1318,6 +1362,32 @@ Toggle icon layout options
|
|
|
1318
1362
|
|
|
1319
1363
|
No additional properties.
|
|
1320
1364
|
|
|
1365
|
+
## Feature
|
|
1366
|
+
|
|
1367
|
+
Optional editor feature flags. Omitted flags retain Pebble defaults. Choose structural features such as table before mounting the editor.
|
|
1368
|
+
|
|
1369
|
+
### Fields
|
|
1370
|
+
|
|
1371
|
+
| Name | Required | Type | Description |
|
|
1372
|
+
|---|---:|---|---|
|
|
1373
|
+
| `advanceListPatterns` | no | boolean | |
|
|
1374
|
+
| `allowCustomColors` | no | boolean | |
|
|
1375
|
+
| `checklist` | no | boolean | |
|
|
1376
|
+
| `componentPicker` | no | boolean | |
|
|
1377
|
+
| `customColorStripping` | no | boolean | |
|
|
1378
|
+
| `emojiPicker` | no | boolean | |
|
|
1379
|
+
| `fileUpload` | no | boolean | Enables local image insertion. Defaults to false; config.upload supports local images only. |
|
|
1380
|
+
| `markdown` | no | boolean | |
|
|
1381
|
+
| `markdownPaste` | no | boolean | |
|
|
1382
|
+
| `mentionables` | no | boolean | Enables host employee mentions and configured custom mentions. Defaults to false for existing SDUI specs; host employee lookup must be available. |
|
|
1383
|
+
| `slashCommands` | no | boolean | |
|
|
1384
|
+
| `stickyToolbar` | no | boolean | |
|
|
1385
|
+
| `table` | no | boolean | |
|
|
1386
|
+
| `textDirection` | no | boolean | |
|
|
1387
|
+
| `variables` | no | boolean | Enables variable chips and insertion. Defaults to false; provide static config.variable.variables. |
|
|
1388
|
+
|
|
1389
|
+
No additional properties.
|
|
1390
|
+
|
|
1321
1391
|
## FileAllowCameraCapture
|
|
1322
1392
|
|
|
1323
1393
|
### Fields
|
|
@@ -2864,6 +2934,21 @@ No additional properties.
|
|
|
2864
2934
|
|
|
2865
2935
|
No additional properties.
|
|
2866
2936
|
|
|
2937
|
+
## ImageCompression
|
|
2938
|
+
|
|
2939
|
+
Optional local image compression settings.
|
|
2940
|
+
|
|
2941
|
+
### Fields
|
|
2942
|
+
|
|
2943
|
+
| Name | Required | Type | Description |
|
|
2944
|
+
|---|---:|---|---|
|
|
2945
|
+
| `alwaysKeepResolution` | no | boolean | Preserves original image resolution when true. |
|
|
2946
|
+
| `compressImages` | yes | boolean | Whether to compress inserted images. |
|
|
2947
|
+
| `maxSizeMB` | no | number | Maximum compressed image size in megabytes. |
|
|
2948
|
+
| `maxWidthOrHeight` | no | number | Maximum compressed image width or height in pixels. |
|
|
2949
|
+
|
|
2950
|
+
No additional properties.
|
|
2951
|
+
|
|
2867
2952
|
## ImageProp
|
|
2868
2953
|
|
|
2869
2954
|
### Fields
|
|
@@ -3174,6 +3259,19 @@ Additional properties: unknown.
|
|
|
3174
3259
|
|
|
3175
3260
|
No additional properties.
|
|
3176
3261
|
|
|
3262
|
+
## Mentionable
|
|
3263
|
+
|
|
3264
|
+
### Fields
|
|
3265
|
+
|
|
3266
|
+
| Name | Required | Type | Description |
|
|
3267
|
+
|---|---:|---|---|
|
|
3268
|
+
| `debounceDelay` | no | number | Suggestion debounce delay in milliseconds. Defaults to 300. |
|
|
3269
|
+
| `options` | yes | [RichTextEditorOption](./types.md#richtexteditoroption)[] | JSON-only replacement for the React callback: options are filtered by case-insensitive label/caption substring search. |
|
|
3270
|
+
| `trigger` | yes | string | One custom trigger character, such as #, ! or $. @, : and / are reserved; regex character-class metacharacters are excluded. |
|
|
3271
|
+
| `triggerMatchOptions` | no | [TriggerMatchOption](./types.md#triggermatchoption) | Custom mention query matching settings. Maximum defaults to 75 and must be at least the minimum. |
|
|
3272
|
+
|
|
3273
|
+
No additional properties.
|
|
3274
|
+
|
|
3177
3275
|
## MenuListList
|
|
3178
3276
|
|
|
3179
3277
|
### Fields
|
|
@@ -3833,6 +3931,18 @@ _No fields._
|
|
|
3833
3931
|
|
|
3834
3932
|
Additional properties: string.
|
|
3835
3933
|
|
|
3934
|
+
## RichTextEditorOption
|
|
3935
|
+
|
|
3936
|
+
### Fields
|
|
3937
|
+
|
|
3938
|
+
| Name | Required | Type | Description |
|
|
3939
|
+
|---|---:|---|---|
|
|
3940
|
+
| `caption` | no | string | Secondary text shown in the suggestions. |
|
|
3941
|
+
| `label` | yes | string | Mention option label and inserted token label. |
|
|
3942
|
+
| `value` | yes | string | Stable identifier stored in the mention token. |
|
|
3943
|
+
|
|
3944
|
+
No additional properties.
|
|
3945
|
+
|
|
3836
3946
|
## Role
|
|
3837
3947
|
|
|
3838
3948
|
### Fields
|
|
@@ -4507,6 +4617,19 @@ Badge to display on the tab
|
|
|
4507
4617
|
|
|
4508
4618
|
No additional properties.
|
|
4509
4619
|
|
|
4620
|
+
## TabBreadcrumb
|
|
4621
|
+
|
|
4622
|
+
### Fields
|
|
4623
|
+
|
|
4624
|
+
| Name | Required | Type | Description |
|
|
4625
|
+
|---|---:|---|---|
|
|
4626
|
+
| `href` | no | string | URL to navigate to when clicked |
|
|
4627
|
+
| `isDisabled` | no | boolean | Disables the breadcrumb item |
|
|
4628
|
+
| `title` | yes | string | Display label for the breadcrumb item |
|
|
4629
|
+
| `value` | yes | string | Unique value identifier for the item |
|
|
4630
|
+
|
|
4631
|
+
No additional properties.
|
|
4632
|
+
|
|
4510
4633
|
## TabItem
|
|
4511
4634
|
|
|
4512
4635
|
### Fields
|
|
@@ -4908,6 +5031,35 @@ No additional properties.
|
|
|
4908
5031
|
|
|
4909
5032
|
Additional properties: unknown.
|
|
4910
5033
|
|
|
5034
|
+
## TriggerMatchOption
|
|
5035
|
+
|
|
5036
|
+
Custom mention query matching settings. Maximum defaults to 75 and must be at least the minimum.
|
|
5037
|
+
|
|
5038
|
+
### Fields
|
|
5039
|
+
|
|
5040
|
+
| Name | Required | Type | Description |
|
|
5041
|
+
|---|---:|---|---|
|
|
5042
|
+
| `allowWhitespace` | no | boolean | Allows spaces in the query. Defaults to true. |
|
|
5043
|
+
| `maxLength` | no | number | Maximum query length after the trigger. |
|
|
5044
|
+
| `minLength` | no | number | Minimum query length after the trigger. Defaults to 0. |
|
|
5045
|
+
| `punctuation` | no | string | Literal punctuation characters that end a query; regex escapes and character-class metacharacters are excluded. |
|
|
5046
|
+
|
|
5047
|
+
No additional properties.
|
|
5048
|
+
|
|
5049
|
+
## Upload
|
|
5050
|
+
|
|
5051
|
+
Local image upload configuration; requires features.fileUpload=true.
|
|
5052
|
+
|
|
5053
|
+
### Fields
|
|
5054
|
+
|
|
5055
|
+
| Name | Required | Type | Description |
|
|
5056
|
+
|---|---:|---|---|
|
|
5057
|
+
| `cloudStorage` | yes | false | Local images are embedded as base64 data URLs; cloud upload is not supported. |
|
|
5058
|
+
| `disableHistoricTag` | no | boolean | Forwards the editor upload-history setting; the local image path does not use cloud history. |
|
|
5059
|
+
| `imageCompression` | no | [ImageCompression](./types.md#imagecompression) | Optional local image compression settings. |
|
|
5060
|
+
|
|
5061
|
+
No additional properties.
|
|
5062
|
+
|
|
4911
5063
|
## User_cache
|
|
4912
5064
|
|
|
4913
5065
|
User cache data with smallPhoto fallback
|
|
@@ -4920,6 +5072,19 @@ User cache data with smallPhoto fallback
|
|
|
4920
5072
|
|
|
4921
5073
|
Additional properties: unknown.
|
|
4922
5074
|
|
|
5075
|
+
## Variable
|
|
5076
|
+
|
|
5077
|
+
Static variable configuration; function getters and custom search/sort callbacks are excluded.
|
|
5078
|
+
|
|
5079
|
+
### Fields
|
|
5080
|
+
|
|
5081
|
+
| Name | Required | Type | Description |
|
|
5082
|
+
|---|---:|---|---|
|
|
5083
|
+
| `noBlankSpace` | no | boolean | Suppresses the space appended after variable insertion. Defaults to false. |
|
|
5084
|
+
| `variables` | no | Record<string, unknown>[] | Static variable metadata; requires features.variables=true. Use four-brace tokens such as {{{{employee.firstName}}}} in initial content. |
|
|
5085
|
+
|
|
5086
|
+
No additional properties.
|
|
5087
|
+
|
|
4923
5088
|
## VStackMargin
|
|
4924
5089
|
|
|
4925
5090
|
### Fields
|