@coveo/platform-client 40.9.1 → 40.9.3
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.
|
@@ -37,7 +37,86 @@ export interface IPXResultTemplate extends HostedInterfaceResultTemplate {
|
|
|
37
37
|
details: IPXResultTemplateDetail[];
|
|
38
38
|
}
|
|
39
39
|
export interface IPXButton {
|
|
40
|
-
|
|
40
|
+
/**
|
|
41
|
+
* The label appearing on the IPX button.
|
|
42
|
+
*/
|
|
43
|
+
label?: string;
|
|
44
|
+
/**
|
|
45
|
+
* The icon appearing on the IPX button when the IPX is open.
|
|
46
|
+
*/
|
|
47
|
+
closeIcon?: string;
|
|
48
|
+
/**
|
|
49
|
+
* The icon appearing on the IPX button when the IPX is close.
|
|
50
|
+
*/
|
|
51
|
+
openIcon?: string;
|
|
52
|
+
}
|
|
53
|
+
export interface IPXContainer {
|
|
54
|
+
/**
|
|
55
|
+
* Whether the IPX is using a target selector.
|
|
56
|
+
*/
|
|
57
|
+
usesTargetSelector?: boolean;
|
|
58
|
+
/**
|
|
59
|
+
* The IPX button information.
|
|
60
|
+
*/
|
|
61
|
+
button?: IPXButton;
|
|
62
|
+
/**
|
|
63
|
+
* The CSS selector used to target the host component of the IPX when usesTargetSelector is true.
|
|
64
|
+
*/
|
|
65
|
+
targetSelector?: string;
|
|
66
|
+
}
|
|
67
|
+
export interface IPXColors {
|
|
68
|
+
/**
|
|
69
|
+
* Primary color.
|
|
70
|
+
*/
|
|
71
|
+
primary: string;
|
|
72
|
+
/**
|
|
73
|
+
* The background color.
|
|
74
|
+
*/
|
|
75
|
+
background: string;
|
|
76
|
+
/**
|
|
77
|
+
* The neutral color.
|
|
78
|
+
*/
|
|
79
|
+
neutral: string;
|
|
80
|
+
/**
|
|
81
|
+
* The visited link color.
|
|
82
|
+
*/
|
|
83
|
+
visitedLink: string;
|
|
84
|
+
/**
|
|
85
|
+
* The titles color.
|
|
86
|
+
*/
|
|
87
|
+
titles: string;
|
|
88
|
+
/**
|
|
89
|
+
* The button color.
|
|
90
|
+
*/
|
|
91
|
+
button: string;
|
|
92
|
+
/**
|
|
93
|
+
* The button label color.
|
|
94
|
+
*/
|
|
95
|
+
buttonLabel: string;
|
|
96
|
+
}
|
|
97
|
+
export interface IPXStyle {
|
|
98
|
+
/**
|
|
99
|
+
* The colors of the IPX.
|
|
100
|
+
*/
|
|
101
|
+
colors: IPXColors;
|
|
102
|
+
/**
|
|
103
|
+
* The font-family of the IPX.
|
|
104
|
+
*/
|
|
105
|
+
fontFamily: string;
|
|
106
|
+
}
|
|
107
|
+
export interface IPXFooter {
|
|
108
|
+
/**
|
|
109
|
+
* The footer's label.
|
|
110
|
+
*/
|
|
111
|
+
label?: string;
|
|
112
|
+
/**
|
|
113
|
+
* The footer's icon.
|
|
114
|
+
*/
|
|
115
|
+
icon?: string;
|
|
116
|
+
/**
|
|
117
|
+
* The footer's link.
|
|
118
|
+
*/
|
|
119
|
+
link?: string;
|
|
41
120
|
}
|
|
42
121
|
export interface IPXInterfaceConfiguration extends HostedInterfaceConfiguration {
|
|
43
122
|
/**
|
|
@@ -51,12 +130,17 @@ export interface IPXInterfaceConfiguration extends HostedInterfaceConfiguration
|
|
|
51
130
|
/**
|
|
52
131
|
* The list of result templates defined for the ipx.
|
|
53
132
|
*/
|
|
133
|
+
resultTemplates: IPXResultTemplate[];
|
|
54
134
|
/**
|
|
55
|
-
* The list of
|
|
135
|
+
* The list of 0 to 3 footers to display.
|
|
56
136
|
*/
|
|
57
|
-
|
|
137
|
+
footer: IPXFooter[];
|
|
138
|
+
/**
|
|
139
|
+
* The container information.
|
|
140
|
+
*/
|
|
141
|
+
container: IPXContainer;
|
|
58
142
|
/**
|
|
59
|
-
* The
|
|
143
|
+
* The style configuration.
|
|
60
144
|
*/
|
|
61
|
-
|
|
145
|
+
style: IPXStyle;
|
|
62
146
|
}
|
|
@@ -324,4 +324,10 @@ export interface IPXButtonModel {
|
|
|
324
324
|
*/
|
|
325
325
|
verticalPosition: ButtonPositionVerticalResponseModel;
|
|
326
326
|
};
|
|
327
|
+
/**
|
|
328
|
+
* The button host's CSS selector, which defines where the button is rendered.
|
|
329
|
+
* If unset, it defaults to "" and renders a floating button in the `<body>`.
|
|
330
|
+
* @default `""`
|
|
331
|
+
*/
|
|
332
|
+
buttonTargetSelector: string;
|
|
327
333
|
}
|