@rippling/pebble-sdui-web 0.22.0 → 0.23.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 -1
- package/dist/catalogs/custom-apps/component-props.d.ts +62 -6
- package/dist/catalogs/custom-apps/components.d.ts +1 -1
- 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 +440 -28
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +26 -8
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +73 -10
- package/package.json +1 -1
|
@@ -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.14.0";
|
|
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. */
|
|
@@ -129,7 +129,7 @@ export type NumberEvents = 'change' | 'blur' | 'changeRaw' | 'changeCalculationS
|
|
|
129
129
|
export type ObjectListViewEvents = never;
|
|
130
130
|
export type ObjectUIEvents = never;
|
|
131
131
|
export type ObjectUIContentEvents = never;
|
|
132
|
-
export type ObjectUIHeaderEvents = 'primaryAction';
|
|
132
|
+
export type ObjectUIHeaderEvents = 'primaryAction' | 'action';
|
|
133
133
|
export type ObjectUIStatsEvents = 'actionClick';
|
|
134
134
|
export type ObjectUITemplateEvents = never;
|
|
135
135
|
export type PageAppLogoEvents = never;
|
|
@@ -20,12 +20,39 @@ export interface CheckListItem {
|
|
|
20
20
|
showMoreSize?: number;
|
|
21
21
|
value: string;
|
|
22
22
|
}
|
|
23
|
+
/** 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. */
|
|
24
|
+
export interface GridLinkRendererProps {
|
|
25
|
+
color?: 'colorOnPrimary' | 'colorOnSecondary' | 'colorOnTertiary' | 'colorOnPrimaryContainer' | 'colorOnSecondaryContainer' | 'colorOnTertiaryContainer' | 'colorError' | 'colorOnError' | 'colorOnErrorContainer' | 'colorOnSurface' | 'colorOnSurfaceVariant' | 'colorOnSurfaceInverse' | 'colorSuccess' | 'colorOnSuccess' | 'colorOnSuccessContainer' | 'colorInfo' | 'colorOnInfo' | 'colorOnInfoContainer' | 'colorWarning' | 'colorOnWarning' | 'colorOnWarningContainer' | 'colorDisabled' | 'colorOnDisabledSurface' | 'colorOnDisabledSurfaceInverse' | 'colorOnSecondaryVariant' | 'colorOnPrimaryVariant' | 'colorOnTertiaryVariant' | 'colorDisabledInverse';
|
|
26
|
+
href: string;
|
|
27
|
+
rel?: string;
|
|
28
|
+
target?: '_blank' | '_self';
|
|
29
|
+
value: string;
|
|
30
|
+
}
|
|
23
31
|
export interface NestedListItem {
|
|
24
32
|
branches?: NestedListItem[];
|
|
25
33
|
isDefaultOpen?: boolean;
|
|
26
34
|
label: string;
|
|
27
35
|
value?: string;
|
|
28
36
|
}
|
|
37
|
+
export interface ObjectUIHeaderButtonActionProps {
|
|
38
|
+
appearance?: 'PRIMARY' | 'DESTRUCTIVE' | 'OUTLINE' | 'GHOST' | 'ACCENT' | 'SUCCESS' | 'INFO' | 'WARNING' | 'SOLID' | 'ACTIVE';
|
|
39
|
+
description?: string;
|
|
40
|
+
icon?: string;
|
|
41
|
+
isDisabled?: boolean;
|
|
42
|
+
label: string;
|
|
43
|
+
shouldShowSpinner?: boolean;
|
|
44
|
+
size?: 'L' | 'M' | 'S' | 'XS';
|
|
45
|
+
}
|
|
46
|
+
export interface ObjectUIHeaderIconActionProps {
|
|
47
|
+
appearance?: 'PRIMARY' | 'DESTRUCTIVE' | 'OUTLINE' | 'GHOST' | 'ACCENT' | 'SUCCESS' | 'INFO' | 'WARNING' | 'SOLID' | 'ACTIVE';
|
|
48
|
+
'aria-label'?: string;
|
|
49
|
+
description?: string;
|
|
50
|
+
isDisabled?: boolean;
|
|
51
|
+
label?: string;
|
|
52
|
+
shouldShowSpinner?: boolean;
|
|
53
|
+
size?: 'L' | 'M' | 'S' | 'XS';
|
|
54
|
+
type: string;
|
|
55
|
+
}
|
|
29
56
|
export interface PaneAdaptationRule {
|
|
30
57
|
below: 'breakpoint2xl' | 'breakpointLg' | 'breakpointMd' | 'breakpointSm' | 'breakpointXl';
|
|
31
58
|
presentation: 'bottomDock' | 'overlay' | 'hidden';
|
|
@@ -675,6 +702,9 @@ export interface DropdownListVariant2 {
|
|
|
675
702
|
value?: unknown;
|
|
676
703
|
[key: string]: unknown | boolean | string | DropdownList2[] | string | DropdownTag | undefined;
|
|
677
704
|
}
|
|
705
|
+
export interface DropdownListVariant3 {
|
|
706
|
+
isSeparator: true;
|
|
707
|
+
}
|
|
678
708
|
export interface DropdownTag {
|
|
679
709
|
appearance?: 'PRIMARY' | 'NEUTRAL' | 'WARNING' | 'INFO' | 'ERROR' | 'SUCCESS' | 'TRANSPARENT' | 'DISABLED';
|
|
680
710
|
text: string;
|
|
@@ -1370,6 +1400,12 @@ export interface GridListVariant2 {
|
|
|
1370
1400
|
renderer?: 'TEXT';
|
|
1371
1401
|
tip?: string | GridTip;
|
|
1372
1402
|
}
|
|
1403
|
+
export interface GridListVariant3 {
|
|
1404
|
+
label: string | number;
|
|
1405
|
+
props: GridLinkRendererProps;
|
|
1406
|
+
renderer: 'LINK';
|
|
1407
|
+
tip?: string | GridTip;
|
|
1408
|
+
}
|
|
1373
1409
|
/** Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens. */
|
|
1374
1410
|
export interface GridProp {
|
|
1375
1411
|
appearance?: 'PRIMARY' | 'NEUTRAL' | 'WARNING' | 'INFO' | 'ERROR' | 'SUCCESS' | 'TRANSPARENT' | 'DISABLED';
|
|
@@ -1553,9 +1589,6 @@ export interface LinkValue {
|
|
|
1553
1589
|
badge?: TabBadge;
|
|
1554
1590
|
title: string;
|
|
1555
1591
|
}
|
|
1556
|
-
export interface ListVariant3 {
|
|
1557
|
-
isSeparator: true;
|
|
1558
|
-
}
|
|
1559
1592
|
/** Semantic Lottie load configuration object */
|
|
1560
1593
|
export interface LoadConfig {
|
|
1561
1594
|
animationData?: AnimationData;
|
|
@@ -1634,6 +1667,11 @@ export interface ObjectUIAvatarProp {
|
|
|
1634
1667
|
placeholderIcon?: string;
|
|
1635
1668
|
type?: 'USER' | 'ICON' | 'TEXT' | 'NUMBER' | 'RIPPLING' | 'LOGO';
|
|
1636
1669
|
}
|
|
1670
|
+
/** Responsive action list. Clicking an item emits action and updates actionClickedId */
|
|
1671
|
+
export interface ObjectUIHeaderAction {
|
|
1672
|
+
limit: number;
|
|
1673
|
+
list: (ObjectUIHeaderList | ObjectUIHeaderListVariant2)[];
|
|
1674
|
+
}
|
|
1637
1675
|
/** Avatar configuration for the header */
|
|
1638
1676
|
export interface ObjectUIHeaderAvatarProp {
|
|
1639
1677
|
icon?: string;
|
|
@@ -1651,6 +1689,16 @@ export interface ObjectUIHeaderLeftIcon {
|
|
|
1651
1689
|
color?: string;
|
|
1652
1690
|
type: string;
|
|
1653
1691
|
}
|
|
1692
|
+
export interface ObjectUIHeaderList {
|
|
1693
|
+
id: string;
|
|
1694
|
+
props: ObjectUIHeaderButtonActionProps;
|
|
1695
|
+
type: 'BUTTON';
|
|
1696
|
+
}
|
|
1697
|
+
export interface ObjectUIHeaderListVariant2 {
|
|
1698
|
+
id: string;
|
|
1699
|
+
props: ObjectUIHeaderIconActionProps;
|
|
1700
|
+
type: 'ICON';
|
|
1701
|
+
}
|
|
1654
1702
|
/** Primary action button. Clicking it emits the primaryAction event */
|
|
1655
1703
|
export interface ObjectUIHeaderPrimaryAction {
|
|
1656
1704
|
icon?: string;
|
|
@@ -1692,6 +1740,12 @@ export interface ObjectUIStatsListVariant2 {
|
|
|
1692
1740
|
renderer?: 'TEXT';
|
|
1693
1741
|
tip?: string | ObjectUIStatsTip;
|
|
1694
1742
|
}
|
|
1743
|
+
export interface ObjectUIStatsListVariant3 {
|
|
1744
|
+
label: string | number;
|
|
1745
|
+
props: GridLinkRendererProps;
|
|
1746
|
+
renderer: 'LINK';
|
|
1747
|
+
tip?: string | ObjectUIStatsTip;
|
|
1748
|
+
}
|
|
1695
1749
|
/** Props passed to LabelRenderer. Icon colors must be Pebble text/icon color tokens. */
|
|
1696
1750
|
export interface ObjectUIStatsProp {
|
|
1697
1751
|
appearance?: 'PRIMARY' | 'NEUTRAL' | 'WARNING' | 'INFO' | 'ERROR' | 'SUCCESS' | 'TRANSPARENT' | 'DISABLED';
|
|
@@ -2969,7 +3023,7 @@ export interface DropdownProps {
|
|
|
2969
3023
|
footer?: DropdownFooter;
|
|
2970
3024
|
isCompact?: boolean;
|
|
2971
3025
|
isDisabled?: boolean;
|
|
2972
|
-
list: (DropdownList2 | DropdownListVariant2 |
|
|
3026
|
+
list: (DropdownList2 | DropdownListVariant2 | DropdownListVariant3)[];
|
|
2973
3027
|
maxHeight?: number;
|
|
2974
3028
|
placement?: 'bottom-start' | 'bottom' | 'bottom-end' | 'top-start' | 'top' | 'top-end' | 'left-start' | 'left' | 'left-end' | 'right-start' | 'right' | 'right-end';
|
|
2975
3029
|
searchable?: boolean;
|
|
@@ -3997,7 +4051,7 @@ export interface FormWorkEmailProps {
|
|
|
3997
4051
|
export interface GridProps {
|
|
3998
4052
|
actionClickedId?: string;
|
|
3999
4053
|
actions?: GridAction[];
|
|
4000
|
-
list: (GridList | GridListVariant2)[];
|
|
4054
|
+
list: (GridList | GridListVariant2 | GridListVariant3)[];
|
|
4001
4055
|
theme?: 'NO_CARD' | 'TRANSPARENT' | 'NO_PADDING';
|
|
4002
4056
|
}
|
|
4003
4057
|
export interface HeadingProps {
|
|
@@ -4334,6 +4388,8 @@ export interface ObjectUIProps {
|
|
|
4334
4388
|
export interface ObjectUIContentProps {
|
|
4335
4389
|
}
|
|
4336
4390
|
export interface ObjectUIHeaderProps {
|
|
4391
|
+
actionClickedId?: string;
|
|
4392
|
+
actions?: ObjectUIHeaderAction;
|
|
4337
4393
|
avatarProps?: ObjectUIHeaderAvatarProp;
|
|
4338
4394
|
caption?: string;
|
|
4339
4395
|
label?: LabelValue;
|
|
@@ -4344,7 +4400,7 @@ export interface ObjectUIHeaderProps {
|
|
|
4344
4400
|
export interface ObjectUIStatsProps {
|
|
4345
4401
|
actionClickedId?: string;
|
|
4346
4402
|
actions?: ObjectUIStatsAction[];
|
|
4347
|
-
list: (ObjectUIStatsList | ObjectUIStatsListVariant2)[];
|
|
4403
|
+
list: (ObjectUIStatsList | ObjectUIStatsListVariant2 | ObjectUIStatsListVariant3)[];
|
|
4348
4404
|
}
|
|
4349
4405
|
export interface ObjectUITemplateProps {
|
|
4350
4406
|
}
|
|
@@ -129,7 +129,7 @@ export declare const Number: (input: ComponentInputs<NumberProps, NumberEvents>)
|
|
|
129
129
|
export declare const ObjectListView: (input: ComponentInputs<ObjectListViewProps, ObjectListViewEvents>) => CatalogElementNode;
|
|
130
130
|
export declare const ObjectUI: (input: ComponentInputs<ObjectUIProps, ObjectUIEvents, true, "default">) => CatalogElementNode;
|
|
131
131
|
export declare const ObjectUIContent: (input: ComponentInputs<ObjectUIContentProps, ObjectUIContentEvents, true, "default">) => CatalogElementNode;
|
|
132
|
-
export declare const ObjectUIHeader: (input: ComponentInputs<ObjectUIHeaderProps, ObjectUIHeaderEvents>) => CatalogElementNode;
|
|
132
|
+
export declare const ObjectUIHeader: (input: ComponentInputs<ObjectUIHeaderProps, ObjectUIHeaderEvents, false, "title" | "caption">) => CatalogElementNode;
|
|
133
133
|
export declare const ObjectUIStats: (input: ComponentInputs<ObjectUIStatsProps, ObjectUIStatsEvents>) => CatalogElementNode;
|
|
134
134
|
export declare const ObjectUITemplate: (input: ComponentInputs<ObjectUITemplateProps, ObjectUITemplateEvents, true, "default">) => CatalogElementNode;
|
|
135
135
|
export declare const PageAppLogo: (input: ComponentInputs<PageAppLogoProps, PageAppLogoEvents>) => CatalogElementNode;
|