@pexip-engage-public/plugin 1.1.26 → 1.1.27-canary-20250729141417

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.
@@ -1,211 +0,0 @@
1
- declare module "iframe-resizer/js/iframeResizer.js" {
2
- export interface IFrameObject {
3
- /**
4
- * Remove the iFrame from the page.
5
- */
6
- close(): void;
7
- /**
8
- * Detach event listeners from iFrame. This is option allows Virtual DOMs to remove an iFrame tag. It should not normally be required.
9
- */
10
- removeListeners(): void;
11
-
12
- /**
13
- * Move to anchor in iFrame.
14
- */
15
- moveToAnchor(anchor: string): void;
16
- /**
17
- * Tell the iFrame to resize itself.
18
- */
19
- resize(): void;
20
- /**
21
- *
22
- * Send data to the containing page, message can be any data type that can be serialized into JSON. The targetOrigin option is used to restrict where the message is sent to, in case your iFrame navigates away to another domain.
23
- */
24
- sendMessage(
25
- message: import("../events/event-types.js").IFrameObjectMessage,
26
- targetOrigin?: string,
27
- ): void;
28
- }
29
-
30
- export interface IFrameComponent extends HTMLIFrameElement {
31
- iFrameResizer: IFrameObject;
32
- }
33
-
34
- export interface IFrameOptions {
35
- /**
36
- * When enabled changes to the Window size or the DOM will cause the iFrame to resize to the new content size.
37
- * Disable if using size method with custom dimensions.
38
- */
39
- autoResize?: boolean | undefined;
40
- /**
41
- * Override the body background style in the iFrame.
42
- */
43
- bodyBackground?: string | undefined;
44
- /**
45
- * Override the default body margin style in the iFrame. A string can be any valid value for the
46
- * CSS margin attribute, for example '8px 3em'. A number value is converted into px.
47
- */
48
- bodyMargin?: number | string | undefined;
49
- /**
50
- * Override the default body padding style in the iFrame. A string can be any valid value for the
51
- * CSS margin attribute, for example '8px 3em'. A number value is converted into px.
52
- */
53
- bodyPadding?: number | string | undefined;
54
- /**
55
- * When set to true, only allow incoming messages from the domain listed in the src property of the iFrame tag.
56
- * If your iFrame navigates between different domains, ports or protocols; then you will need to
57
- * provide an array of URLs or disable this option.
58
- */
59
- checkOrigin?: boolean | string[] | undefined;
60
- /**
61
- * When enabled in page linking inside the iFrame and from the iFrame to the parent page will be enabled.
62
- */
63
- inPageLinks?: boolean | undefined;
64
- /**
65
- * Height calculation method.
66
- */
67
- heightCalculationMethod?: HeightCalculationMethod | undefined;
68
- /**
69
- * Setting the log option to true will make the scripts in both the host page and the iFrame output
70
- * everything they do to the JavaScript console so you can see the communication between the two scripts.
71
- */
72
- log?: boolean | undefined;
73
- /**
74
- * Set maximum height of iFrame.
75
- */
76
- maxHeight?: number | undefined;
77
- /**
78
- * Set maximum width of iFrame.
79
- */
80
- maxWidth?: number | undefined;
81
- /**
82
- * Set minimum height of iFrame.
83
- */
84
- minHeight?: number | undefined;
85
- /**
86
- * Set minimum width of iFrame.
87
- */
88
- minWidth?: number | undefined;
89
- /**
90
- * Listen for resize events from the parent page, or the iFrame. Select the 'child' value if the iFrame
91
- * can be resized independently of the browser window. Selecting this value can cause issues with some
92
- * height calculation methods on mobile devices.
93
- */
94
- resizeFrom?: "parent" | "child" | undefined;
95
- /**
96
- * Enable scroll bars in iFrame.
97
- */
98
- scrolling?: boolean | "omit" | undefined;
99
- /**
100
- * Resize iFrame to content height.
101
- */
102
- sizeHeight?: boolean | undefined;
103
- /**
104
- * Resize iFrame to content width.
105
- */
106
- sizeWidth?: boolean | undefined;
107
- /**
108
- * Set the number of pixels the iFrame content size has to change by, before triggering a resize of the iFrame.
109
- */
110
- tolerance?: number | undefined;
111
- /**
112
- * Width calculation method.
113
- */
114
- widthCalculationMethod?: WidthCalculationMethod | undefined;
115
-
116
- /**
117
- * Called when iFrame is closed via parentIFrame.close() or iframe.iframeResizer.close() methods.
118
- * Returning false will prevent the iFrame from closing.
119
- */
120
- onClose?(iframeId: string): boolean;
121
- /**
122
- *
123
- * Called after iFrame is closed via parentIFrame.close() or iframe.iFrameResizer.close() methods.
124
- */
125
- onClosed?(iframeId: string): void;
126
- /**
127
- * Initial setup callback function.
128
- */
129
- onInit?(iframe: IFrameComponent): void;
130
- /**
131
- * Receive message posted from iFrame with the parentIFrame.sendMessage() method.
132
- */
133
- onMessage?(data: IFrameMessageData): void;
134
- /**
135
- *
136
- * Function called after the mouse enters the iframe. Passes messageData object containing the iFrame, screenX, screenY and the type of event that triggered the callback.
137
- */
138
- onMouseEnter?(data: {
139
- iframe: IFrameComponent;
140
- height: number;
141
- width: number;
142
- type: string;
143
- }): void;
144
- /**
145
- *
146
- * Function called after the mouse leaves the iframe. Passes messageData object containing the iFrame, screenX, screenY and the type of event that triggered the callback.
147
- */
148
- onMouseLeave?(data: {
149
- iframe: IFrameComponent;
150
- height: number;
151
- width: number;
152
- type: string;
153
- }): void;
154
- /**
155
- * Function called after iFrame resized. Passes in messageData object containing the iFrame, height, width
156
- * and the type of event that triggered the iFrame to resize.
157
- */
158
- onResized?(data: IFrameResizedData): void;
159
-
160
- /**
161
- * Called before the page is repositioned after a request from the iFrame, due to either an in page link,
162
- * or a direct request from either parentIFrame.scrollTo() or parentIFrame.scrollToOffset().
163
- * If this callback function returns false, it will stop the library from repositioning the page, so that
164
- * you can implement your own animated page scrolling instead.
165
- */
166
- onScroll?(data: IFrameScrollData): boolean;
167
- }
168
-
169
- type HeightCalculationMethod =
170
- | "bodyOffset"
171
- | "bodyScroll"
172
- | "documentElementOffset"
173
- | "documentElementScroll"
174
- | "max"
175
- | "min"
176
- | "grow"
177
- | "lowestElement"
178
- | "taggedElement";
179
-
180
- type WidthCalculationMethod =
181
- | "bodyOffset"
182
- | "bodyScroll"
183
- | "documentElementOffset"
184
- | "documentElementScroll"
185
- | "max"
186
- | "min"
187
- | "scroll"
188
- | "rightMostElement"
189
- | "taggedElement";
190
-
191
- export interface IFrameResizedData {
192
- iframe: IFrameComponent;
193
- height: number;
194
- width: number;
195
- type: string;
196
- }
197
-
198
- export interface IFrameMessageData {
199
- iframe: IFrameComponent;
200
- message: import("../events/event-types.js").IFrameMessage;
201
- }
202
-
203
- export interface IFrameScrollData {
204
- x: number;
205
- y: number;
206
- }
207
-
208
- function iframeResizer(options: IFrameOptions, target: string | HTMLElement): IFrameComponent[];
209
-
210
- export default iframeResizer;
211
- }