@rippling/pebble-sdui-web 0.22.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.
@@ -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
@@ -1222,6 +1266,16 @@ Additional properties: unknown.
1222
1266
 
1223
1267
  Additional properties: unknown.
1224
1268
 
1269
+ ## DropdownListVariant3
1270
+
1271
+ ### Fields
1272
+
1273
+ | Name | Required | Type | Description |
1274
+ |---|---:|---|---|
1275
+ | `isSeparator` | yes | true | Render a visual separator |
1276
+
1277
+ No additional properties.
1278
+
1225
1279
  ## DropdownTag
1226
1280
 
1227
1281
  ### Fields
@@ -1308,6 +1362,32 @@ Toggle icon layout options
1308
1362
 
1309
1363
  No additional properties.
1310
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
+
1311
1391
  ## FileAllowCameraCapture
1312
1392
 
1313
1393
  ### Fields
@@ -2704,6 +2784,19 @@ No additional properties.
2704
2784
 
2705
2785
  No additional properties.
2706
2786
 
2787
+ ## GridListVariant3
2788
+
2789
+ ### Fields
2790
+
2791
+ | Name | Required | Type | Description |
2792
+ |---|---:|---|---|
2793
+ | `label` | yes | string \| number | Label displayed in the cell header. String or number value |
2794
+ | `props` | yes | Record<string, unknown> | Props for a linked cell: { value, href, target?, rel?, color? }. Uses Anchor navigation; HTTP(S) links open in a new tab with noopener noreferrer. Color must be a Pebble text/icon color token. |
2795
+ | `renderer` | yes | "LINK" | Renderer type for the cell value. LINK renders an Anchor. |
2796
+ | `tip` | no | string \| [GridTip](./types.md#gridtip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
2797
+
2798
+ No additional properties.
2799
+
2707
2800
  ## GridProp
2708
2801
 
2709
2802
  Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
@@ -2841,6 +2934,21 @@ No additional properties.
2841
2934
 
2842
2935
  No additional properties.
2843
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
+
2844
2952
  ## ImageProp
2845
2953
 
2846
2954
  ### Fields
@@ -3079,16 +3187,6 @@ No additional properties.
3079
3187
 
3080
3188
  No additional properties.
3081
3189
 
3082
- ## ListVariant3
3083
-
3084
- ### Fields
3085
-
3086
- | Name | Required | Type | Description |
3087
- |---|---:|---|---|
3088
- | `isSeparator` | yes | true | Render a visual separator |
3089
-
3090
- No additional properties.
3091
-
3092
3190
  ## LoadConfig
3093
3191
 
3094
3192
  Semantic Lottie load configuration object
@@ -3161,6 +3259,19 @@ Additional properties: unknown.
3161
3259
 
3162
3260
  No additional properties.
3163
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
+
3164
3275
  ## MenuListList
3165
3276
 
3166
3277
  ### Fields
@@ -3258,6 +3369,19 @@ Avatar configuration for the header
3258
3369
 
3259
3370
  No additional properties.
3260
3371
 
3372
+ ## ObjectUIHeaderAction
3373
+
3374
+ Responsive action list. Clicking an item emits action and updates actionClickedId
3375
+
3376
+ ### Fields
3377
+
3378
+ | Name | Required | Type | Description |
3379
+ |---|---:|---|---|
3380
+ | `limit` | yes | number | Maximum visible actions before remaining actions move into an overflow menu |
3381
+ | `list` | yes | [ObjectUIHeaderList](./types.md#objectuiheaderlist) \| [ObjectUIHeaderListVariant2](./types.md#objectuiheaderlistvariant2)[] | Responsive button and icon actions shown in the header |
3382
+
3383
+ No additional properties.
3384
+
3261
3385
  ## ObjectUIHeaderAvatarProp
3262
3386
 
3263
3387
  Avatar configuration for the header
@@ -3290,6 +3414,30 @@ No additional properties.
3290
3414
 
3291
3415
  No additional properties.
3292
3416
 
3417
+ ## ObjectUIHeaderList
3418
+
3419
+ ### Fields
3420
+
3421
+ | Name | Required | Type | Description |
3422
+ |---|---:|---|---|
3423
+ | `id` | yes | string | JSON-only action identifier written to actionClickedId before the action event |
3424
+ | `props` | yes | Record<string, unknown> | |
3425
+ | `type` | yes | "BUTTON" | |
3426
+
3427
+ No additional properties.
3428
+
3429
+ ## ObjectUIHeaderListVariant2
3430
+
3431
+ ### Fields
3432
+
3433
+ | Name | Required | Type | Description |
3434
+ |---|---:|---|---|
3435
+ | `id` | yes | string | JSON-only action identifier written to actionClickedId before the action event |
3436
+ | `props` | yes | Record<string, unknown> | |
3437
+ | `type` | yes | "ICON" | |
3438
+
3439
+ No additional properties.
3440
+
3293
3441
  ## ObjectUIHeaderPrimaryAction
3294
3442
 
3295
3443
  Primary action button. Clicking it emits the primaryAction event
@@ -3374,6 +3522,19 @@ No additional properties.
3374
3522
 
3375
3523
  No additional properties.
3376
3524
 
3525
+ ## ObjectUIStatsListVariant3
3526
+
3527
+ ### Fields
3528
+
3529
+ | Name | Required | Type | Description |
3530
+ |---|---:|---|---|
3531
+ | `label` | yes | string \| number | Label displayed in the cell header. String or number value |
3532
+ | `props` | yes | Record<string, unknown> | Props for a linked cell: { value, href, target?, rel?, color? }. Uses Anchor navigation; HTTP(S) links open in a new tab with noopener noreferrer. Color must be a Pebble text/icon color token. |
3533
+ | `renderer` | yes | "LINK" | Renderer type for the cell value. LINK renders an Anchor. |
3534
+ | `tip` | no | string \| [ObjectUIStatsTip](./types.md#objectuistatstip) | Tooltip for the cell label. Can be a simple string or tooltip configuration object |
3535
+
3536
+ No additional properties.
3537
+
3377
3538
  ## ObjectUIStatsProp
3378
3539
 
3379
3540
  Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens.
@@ -3770,6 +3931,18 @@ _No fields._
3770
3931
 
3771
3932
  Additional properties: string.
3772
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
+
3773
3946
  ## Role
3774
3947
 
3775
3948
  ### Fields
@@ -4444,6 +4617,19 @@ Badge to display on the tab
4444
4617
 
4445
4618
  No additional properties.
4446
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
+
4447
4633
  ## TabItem
4448
4634
 
4449
4635
  ### Fields
@@ -4845,6 +5031,35 @@ No additional properties.
4845
5031
 
4846
5032
  Additional properties: unknown.
4847
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
+
4848
5063
  ## User_cache
4849
5064
 
4850
5065
  User cache data with smallPhoto fallback
@@ -4857,6 +5072,19 @@ User cache data with smallPhoto fallback
4857
5072
 
4858
5073
  Additional properties: unknown.
4859
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
+
4860
5088
  ## VStackMargin
4861
5089
 
4862
5090
  ### Fields
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rippling/pebble-sdui-web",
3
- "version": "0.22.0",
3
+ "version": "0.24.0",
4
4
  "description": "Type-safe TypeScript web SDK for authoring json-render specs",
5
5
  "repository": {
6
6
  "type": "git",