@rippling/pebble-sdui-web 0.9.2 → 0.13.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 +3 -3
- package/dist/catalogs/custom-apps/component-props.d.ts +126 -31
- 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 +1 -1
- package/dist/catalogs/custom-apps/index.js +715 -156
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +65 -96
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +185 -31
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +60 -49
- package/dist/sdk-docs.cjs +41 -10
- package/dist/sdk-docs.cjs.map +1 -1
- package/dist/sdk-docs.js +41 -10
- package/dist/sdk-docs.js.map +1 -1
- package/package.json +1 -6
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* action definitions, directive definitions, and spec validation.
|
|
8
8
|
*/
|
|
9
9
|
export declare const CATALOG_NAME = "custom-apps";
|
|
10
|
-
export declare const CATALOG_VERSION = "1.
|
|
10
|
+
export declare const CATALOG_VERSION = "1.5.2";
|
|
11
11
|
/** Return component descriptions keyed by component name. */
|
|
12
12
|
export declare function getComponents(): Record<string, string>;
|
|
13
13
|
/** Return action descriptions keyed by action name. */
|
|
@@ -104,7 +104,7 @@ export type IconButtonEvents = 'press' | 'pressWhileDisabled' | 'mouseEnter' | '
|
|
|
104
104
|
export type ImageEvents = 'press' | 'load' | 'error';
|
|
105
105
|
export type ImageViewerEvents = never;
|
|
106
106
|
export type InputGroupEvents = never;
|
|
107
|
-
export type ItemNavigatorEvents = 'next' | 'previous';
|
|
107
|
+
export type ItemNavigatorEvents = 'next' | 'previous' | 'select';
|
|
108
108
|
export type LabelEvents = never;
|
|
109
109
|
export type LabelGroupEvents = never;
|
|
110
110
|
export type LayoutEvents = never;
|
|
@@ -133,7 +133,7 @@ export type PageFooterEvents = 'continue';
|
|
|
133
133
|
export type PageHeaderEvents = 'action';
|
|
134
134
|
export type PaginateEvents = 'change';
|
|
135
135
|
export type PaginateListEvents = 'change';
|
|
136
|
-
export type PaneEvents = 'collapsedChange' | '
|
|
136
|
+
export type PaneEvents = 'collapsedChange' | 'dismissedChange' | 'committedSizeChange' | 'presentationChange' | 'headerAction' | 'footerAction';
|
|
137
137
|
export type PasswordEvents = 'change' | 'blur' | 'focus' | 'click' | 'keydown' | 'keyup' | 'paste' | 'mouseenter' | 'mouseleave' | 'revealChange';
|
|
138
138
|
export type PercentageEvents = 'change' | 'blur';
|
|
139
139
|
export type PhoneEvents = 'change' | 'blur' | 'focus' | 'click' | 'keydown' | 'keyup' | 'paste' | 'mouseenter' | 'mouseleave' | 'countryCodeChange';
|
|
@@ -160,7 +160,7 @@ export type SliderEvents = 'change' | 'blur' | 'beforeChange' | 'afterChange';
|
|
|
160
160
|
export type SnackBarEvents = 'dismiss';
|
|
161
161
|
export type SpinnerEvents = never;
|
|
162
162
|
export type SplitButtonEvents = 'press' | 'dropdownChange';
|
|
163
|
-
export type SplitPaneEvents =
|
|
163
|
+
export type SplitPaneEvents = 'activePaneChange';
|
|
164
164
|
export type SsnEvents = 'change' | 'blur';
|
|
165
165
|
export type StatusEvents = never;
|
|
166
166
|
export type StepperEvents = 'click';
|
|
@@ -29,6 +29,74 @@ export interface NestedListItem {
|
|
|
29
29
|
label: string;
|
|
30
30
|
value?: string;
|
|
31
31
|
}
|
|
32
|
+
export interface PaneAdaptationRule {
|
|
33
|
+
below: 'breakpoint2xl' | 'breakpointLg' | 'breakpointMd' | 'breakpointSm' | 'breakpointXl';
|
|
34
|
+
presentation: 'bottomDock' | 'overlay' | 'hidden';
|
|
35
|
+
}
|
|
36
|
+
export interface PaneBodyDescriptor {
|
|
37
|
+
noPadding?: boolean;
|
|
38
|
+
scroll?: 'auto' | 'none';
|
|
39
|
+
}
|
|
40
|
+
export interface PaneCommittedSize {
|
|
41
|
+
horizontal?: number;
|
|
42
|
+
vertical?: number;
|
|
43
|
+
}
|
|
44
|
+
export interface PaneControlTips {
|
|
45
|
+
collapse?: string | null;
|
|
46
|
+
dismiss?: string | null;
|
|
47
|
+
hide?: string | null;
|
|
48
|
+
restore?: string | null;
|
|
49
|
+
show?: string | null;
|
|
50
|
+
}
|
|
51
|
+
export type PaneDimension = number | PaneDimensionValue;
|
|
52
|
+
export interface PaneFooterActionDescriptor {
|
|
53
|
+
appearance?: 'ACCENT' | 'ACTIVE' | 'PRIMARY' | 'DESTRUCTIVE' | 'SUCCESS' | 'INFO' | 'WARNING' | 'OUTLINE' | 'SOLID' | 'GHOST';
|
|
54
|
+
icon?: string;
|
|
55
|
+
id: string;
|
|
56
|
+
isDisabled?: boolean;
|
|
57
|
+
label: string;
|
|
58
|
+
placement?: 'start' | 'end';
|
|
59
|
+
shouldShowSpinner?: boolean;
|
|
60
|
+
}
|
|
61
|
+
export interface PaneFooterDescriptor {
|
|
62
|
+
actions: PaneFooterActionDescriptor[];
|
|
63
|
+
}
|
|
64
|
+
export interface PaneHeaderActionDescriptor {
|
|
65
|
+
appearance?: 'ACCENT' | 'ACTIVE' | 'PRIMARY' | 'DESTRUCTIVE' | 'SUCCESS' | 'INFO' | 'WARNING' | 'OUTLINE' | 'SOLID' | 'GHOST';
|
|
66
|
+
ariaLabel: string;
|
|
67
|
+
icon: string;
|
|
68
|
+
id: string;
|
|
69
|
+
isDisabled?: boolean;
|
|
70
|
+
placement?: 'start' | 'end';
|
|
71
|
+
tip?: string | null;
|
|
72
|
+
}
|
|
73
|
+
export interface PaneHeaderDescriptor {
|
|
74
|
+
actions?: PaneHeaderActionDescriptor[];
|
|
75
|
+
leadingIcon?: string;
|
|
76
|
+
title: string;
|
|
77
|
+
}
|
|
78
|
+
export type PaneSizing = PaneSizingValue | PaneSizingValueVariant2 | PaneSizingValueVariant3;
|
|
79
|
+
export interface SplitPaneAdaptation {
|
|
80
|
+
collapseBelow?: SplitPaneCollapseBelow;
|
|
81
|
+
overflow?: 'horizontal';
|
|
82
|
+
reflow?: SplitPaneReflow;
|
|
83
|
+
}
|
|
84
|
+
export interface SplitPaneCollapseBelow {
|
|
85
|
+
SECONDARY?: 'breakpoint2xl' | 'breakpointLg' | 'breakpointMd' | 'breakpointSm' | 'breakpointXl';
|
|
86
|
+
TERTIARY?: 'breakpoint2xl' | 'breakpointLg' | 'breakpointMd' | 'breakpointSm' | 'breakpointXl';
|
|
87
|
+
}
|
|
88
|
+
export interface SplitPaneDivider {
|
|
89
|
+
resizeGrip?: 'visible' | 'hidden';
|
|
90
|
+
visibility?: 'visible' | 'hidden';
|
|
91
|
+
}
|
|
92
|
+
export interface SplitPanePersistence {
|
|
93
|
+
fields: ('committedSize' | 'collapsed' | 'dismissed' | 'activePaneId')[];
|
|
94
|
+
key: string;
|
|
95
|
+
}
|
|
96
|
+
export interface SplitPaneReflow {
|
|
97
|
+
below: 'breakpoint2xl' | 'breakpointLg' | 'breakpointMd' | 'breakpointSm' | 'breakpointXl';
|
|
98
|
+
mode: 'stack' | 'single';
|
|
99
|
+
}
|
|
32
100
|
/** Override container padding per side using Pebble spacing tokens */
|
|
33
101
|
export interface ActionCardPadding {
|
|
34
102
|
bottom?: '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';
|
|
@@ -333,10 +401,6 @@ export interface ClickedFile {
|
|
|
333
401
|
type?: string;
|
|
334
402
|
url?: string;
|
|
335
403
|
}
|
|
336
|
-
/** Configure when each priority level auto-collapses based on container width. Keys are priority numbers, values are breakpoint tokens. Use false to disable auto-collapse for a priority level */
|
|
337
|
-
export interface CollapseBelow {
|
|
338
|
-
[key: string]: 'breakpoint2xl' | 'breakpointLg' | 'breakpointMd' | 'breakpointSm' | 'breakpointXl' | false;
|
|
339
|
-
}
|
|
340
404
|
export interface ColorPickerArg {
|
|
341
405
|
[key: string]: unknown;
|
|
342
406
|
}
|
|
@@ -1600,6 +1664,27 @@ export interface PaginateListList {
|
|
|
1600
1664
|
id: string | number;
|
|
1601
1665
|
label: string;
|
|
1602
1666
|
}
|
|
1667
|
+
export interface PaneDimensionValue {
|
|
1668
|
+
unit: 'percent';
|
|
1669
|
+
value: number;
|
|
1670
|
+
}
|
|
1671
|
+
export interface PaneSizingValue {
|
|
1672
|
+
mode: 'fixed';
|
|
1673
|
+
size: PaneDimension;
|
|
1674
|
+
}
|
|
1675
|
+
export interface PaneSizingValueVariant2 {
|
|
1676
|
+
maxSize?: PaneDimension;
|
|
1677
|
+
minSize?: PaneDimension;
|
|
1678
|
+
mode: 'content';
|
|
1679
|
+
}
|
|
1680
|
+
export interface PaneSizingValueVariant3 {
|
|
1681
|
+
growWeight?: number;
|
|
1682
|
+
maxSize?: PaneDimension;
|
|
1683
|
+
minSize?: PaneDimension;
|
|
1684
|
+
mode: 'fill' | 'resizable';
|
|
1685
|
+
preferredSize: PaneDimension;
|
|
1686
|
+
shrinkWeight?: number;
|
|
1687
|
+
}
|
|
1603
1688
|
/** Partner company data for profile URL routing */
|
|
1604
1689
|
export interface PartnerCompany {
|
|
1605
1690
|
[key: string]: unknown;
|
|
@@ -1885,12 +1970,6 @@ export interface SinCheck {
|
|
|
1885
1970
|
message: string;
|
|
1886
1971
|
type: string;
|
|
1887
1972
|
}
|
|
1888
|
-
/** Horizontal size constraints for desktop layout. Object with optional default/min/max properties as CSS strings */
|
|
1889
|
-
export interface Size {
|
|
1890
|
-
default?: string;
|
|
1891
|
-
max?: string;
|
|
1892
|
-
min?: string;
|
|
1893
|
-
}
|
|
1894
1973
|
/** Secondary skip action. Click emits the skip event. */
|
|
1895
1974
|
export interface SkipButton {
|
|
1896
1975
|
label?: string;
|
|
@@ -2176,12 +2255,6 @@ export interface User_cache {
|
|
|
2176
2255
|
smallPhoto?: string;
|
|
2177
2256
|
[key: string]: unknown | string | undefined;
|
|
2178
2257
|
}
|
|
2179
|
-
/** Vertical size constraints for mobile stacked layout. Object with optional default/min/max properties as CSS strings */
|
|
2180
|
-
export interface VerticalSize {
|
|
2181
|
-
default?: string;
|
|
2182
|
-
max?: string;
|
|
2183
|
-
min?: string;
|
|
2184
|
-
}
|
|
2185
2258
|
export interface VStackMargin {
|
|
2186
2259
|
bottom?: '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';
|
|
2187
2260
|
left?: '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';
|
|
@@ -2369,6 +2442,7 @@ export interface BoxProps {
|
|
|
2369
2442
|
grow?: number | string;
|
|
2370
2443
|
height?: number | string;
|
|
2371
2444
|
id?: string;
|
|
2445
|
+
inset?: number | string;
|
|
2372
2446
|
isInline?: boolean;
|
|
2373
2447
|
justify?: string;
|
|
2374
2448
|
margin?: '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' | BoxMargin;
|
|
@@ -2378,6 +2452,7 @@ export interface BoxProps {
|
|
|
2378
2452
|
minWidth?: number | string;
|
|
2379
2453
|
overflow?: string;
|
|
2380
2454
|
padding?: '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' | BoxPadding;
|
|
2455
|
+
pointerEvents?: string;
|
|
2381
2456
|
position?: string;
|
|
2382
2457
|
radius?: 'shapeCornerNone' | 'shapeCornerXs' | 'shapeCornerSm' | 'shapeCornerMd' | 'shapeCornerLg' | 'shapeCornerXl' | 'shapeCorner2xl' | 'shapeCorner3xl' | 'shapeCorner4xl' | 'shapeCornerFull' | BoxRadiu;
|
|
2383
2458
|
reverse?: boolean;
|
|
@@ -2411,6 +2486,7 @@ export interface ButtonProps {
|
|
|
2411
2486
|
'aria-labelledby'?: string;
|
|
2412
2487
|
'aria-pressed'?: boolean | 'mixed';
|
|
2413
2488
|
badge?: string;
|
|
2489
|
+
contentAlignment?: 'CENTER' | 'START';
|
|
2414
2490
|
fontInherit?: boolean;
|
|
2415
2491
|
icon?: string | ButtonIcon;
|
|
2416
2492
|
id?: string;
|
|
@@ -2453,7 +2529,7 @@ export interface CardProps {
|
|
|
2453
2529
|
content?: string;
|
|
2454
2530
|
isAddCard?: boolean;
|
|
2455
2531
|
isDisabled?: boolean;
|
|
2456
|
-
minCardHeight?: number;
|
|
2532
|
+
minCardHeight?: number | string;
|
|
2457
2533
|
padding?: 0 | 8 | 16 | 24 | 32 | string;
|
|
2458
2534
|
selectedActionId?: string;
|
|
2459
2535
|
showDelete?: boolean;
|
|
@@ -2464,7 +2540,7 @@ export interface CardProps {
|
|
|
2464
2540
|
value?: unknown;
|
|
2465
2541
|
}
|
|
2466
2542
|
export interface CardGroupProps {
|
|
2467
|
-
minCardHeight?: number;
|
|
2543
|
+
minCardHeight?: number | string;
|
|
2468
2544
|
placement?: 'HORIZONTALLY_LEFT' | 'HORIZONTALLY_CENTER' | 'HORIZONTALLY_RIGHT' | 'HORIZONTALLY_SPACE_BETWEEN';
|
|
2469
2545
|
}
|
|
2470
2546
|
export interface CarouselProps {
|
|
@@ -3862,6 +3938,7 @@ export interface ItemNavigatorProps {
|
|
|
3862
3938
|
prevDisabled?: boolean;
|
|
3863
3939
|
prevTip?: string;
|
|
3864
3940
|
totalItems: number;
|
|
3941
|
+
variant?: 'LABEL' | 'DOTS';
|
|
3865
3942
|
}
|
|
3866
3943
|
export interface LabelProps {
|
|
3867
3944
|
appearance?: 'PRIMARY' | 'NEUTRAL' | 'WARNING' | 'INFO' | 'ERROR' | 'SUCCESS' | 'TRANSPARENT' | 'DISABLED';
|
|
@@ -3938,7 +4015,7 @@ export interface LoaderCardProps {
|
|
|
3938
4015
|
export interface LocationCardProps {
|
|
3939
4016
|
actions?: LocationCardAction[];
|
|
3940
4017
|
location: Location;
|
|
3941
|
-
minCardHeight?: number;
|
|
4018
|
+
minCardHeight?: number | string;
|
|
3942
4019
|
selectedActionId?: string;
|
|
3943
4020
|
showDelete?: boolean;
|
|
3944
4021
|
showEdit?: boolean;
|
|
@@ -4128,21 +4205,31 @@ export interface PaginateListProps {
|
|
|
4128
4205
|
pageSize?: number;
|
|
4129
4206
|
}
|
|
4130
4207
|
export interface PaneProps {
|
|
4131
|
-
|
|
4208
|
+
adaptation?: PaneAdaptationRule[];
|
|
4209
|
+
ariaLabel?: string;
|
|
4210
|
+
ariaLabelledBy?: string;
|
|
4211
|
+
body?: PaneBodyDescriptor;
|
|
4212
|
+
collapseControl?: 'auto' | 'header' | 'divider';
|
|
4132
4213
|
collapsed?: boolean;
|
|
4133
4214
|
collapsible?: boolean;
|
|
4134
|
-
|
|
4215
|
+
committedSize?: PaneCommittedSize;
|
|
4216
|
+
controlTips?: PaneControlTips;
|
|
4135
4217
|
defaultCollapsed?: boolean;
|
|
4218
|
+
defaultCommittedSize?: PaneCommittedSize;
|
|
4136
4219
|
defaultDismissed?: boolean;
|
|
4220
|
+
dismissControl?: 'auto' | 'header' | 'divider';
|
|
4137
4221
|
dismissed?: boolean;
|
|
4138
4222
|
dismissible?: boolean;
|
|
4139
|
-
|
|
4140
|
-
|
|
4141
|
-
|
|
4142
|
-
|
|
4143
|
-
|
|
4144
|
-
|
|
4145
|
-
|
|
4223
|
+
footer?: PaneFooterDescriptor;
|
|
4224
|
+
footerActionId?: string;
|
|
4225
|
+
header?: PaneHeaderDescriptor;
|
|
4226
|
+
headerActionId?: string;
|
|
4227
|
+
id: string;
|
|
4228
|
+
pin?: 'start' | 'end';
|
|
4229
|
+
presentation?: 'docked' | 'collapsed' | 'hidden' | 'bottomDock' | 'overlay';
|
|
4230
|
+
priority: 'PRIMARY' | 'SECONDARY' | 'TERTIARY';
|
|
4231
|
+
reflowSizing?: PaneSizing;
|
|
4232
|
+
sizing?: PaneSizing;
|
|
4146
4233
|
}
|
|
4147
4234
|
export interface PasswordProps {
|
|
4148
4235
|
name?: string;
|
|
@@ -4562,10 +4649,18 @@ export interface SplitButtonProps {
|
|
|
4562
4649
|
startIcon?: string;
|
|
4563
4650
|
}
|
|
4564
4651
|
export interface SplitPaneProps {
|
|
4565
|
-
|
|
4566
|
-
|
|
4652
|
+
activePaneId?: string | null;
|
|
4653
|
+
adaptation?: SplitPaneAdaptation;
|
|
4654
|
+
ariaLabel?: string;
|
|
4655
|
+
ariaLabelledBy?: string;
|
|
4656
|
+
defaultActivePaneId?: string;
|
|
4657
|
+
disableAnimation?: boolean;
|
|
4658
|
+
divider?: SplitPaneDivider;
|
|
4567
4659
|
gap?: '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';
|
|
4568
|
-
|
|
4660
|
+
id: string;
|
|
4661
|
+
orientation?: 'horizontal' | 'vertical';
|
|
4662
|
+
persistence?: SplitPanePersistence;
|
|
4663
|
+
showGutter?: boolean;
|
|
4569
4664
|
}
|
|
4570
4665
|
export interface SsnProps {
|
|
4571
4666
|
name?: string;
|