@luigi-project/container 1.7.5-dev.202512120038 → 1.7.5-dev.202512130036
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/LuigiCompoundContainer.svelte.d.ts +151 -85
- package/LuigiContainer.svelte.d.ts +178 -104
- package/bundle.js +1 -1
- package/bundle.js.map +1 -1
- package/constants/events.d.ts +407 -399
- package/constants/events.js +370 -365
- package/dist/custom-elements.json +50 -50
- package/package.json +1 -1
|
@@ -4,172 +4,217 @@ export declare interface WebComponentSettings {
|
|
|
4
4
|
tagName?: string;
|
|
5
5
|
}
|
|
6
6
|
|
|
7
|
+
/**
|
|
8
|
+
* @summary Base class for Luigi container.
|
|
9
|
+
* @augments HTMLElement
|
|
10
|
+
* @class
|
|
11
|
+
*/
|
|
7
12
|
export default class LuigiContainer extends HTMLElement {
|
|
8
13
|
/**
|
|
9
|
-
* The URL of the microfrontend to be rendered.
|
|
14
|
+
* The URL of the microfrontend to be rendered. <br><br>
|
|
15
|
+
* Type: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
10
16
|
* @since 1.0.0
|
|
11
|
-
*
|
|
17
|
+
* @type {String}
|
|
18
|
+
* @kind member
|
|
19
|
+
* @memberof LuigiContainer
|
|
12
20
|
* @example <luigi-container viewurl="/index.html"></luigi-container>
|
|
13
21
|
* @example myContainer.viewurl = "/index.html"
|
|
14
22
|
*/
|
|
15
23
|
viewurl: string;
|
|
16
24
|
|
|
17
25
|
/**
|
|
18
|
-
* If set to true defers from initializing the microfronted automatically. In that case init() can be used.
|
|
26
|
+
* If set to true defers from initializing the microfronted automatically. In that case init() can be used. <br><br>
|
|
27
|
+
* Type: [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
19
28
|
* @since 1.0.0
|
|
20
|
-
*
|
|
29
|
+
* @type {Boolean}
|
|
30
|
+
* @kind member
|
|
31
|
+
* @memberof LuigiContainer
|
|
21
32
|
* @example <luigi-container viewurl="/index.html" defer-init></luigi-container>
|
|
22
33
|
* @example myContainer.deferInit = true
|
|
23
34
|
*/
|
|
24
35
|
deferInit: boolean;
|
|
25
36
|
|
|
26
37
|
/**
|
|
27
|
-
* The stringified context object to be passed to the microfrontend.
|
|
38
|
+
* The stringified context object to be passed to the microfrontend. <br><br>
|
|
39
|
+
* Type: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
28
40
|
* @since 1.0.0
|
|
29
|
-
*
|
|
30
|
-
*
|
|
41
|
+
* @type {String}
|
|
42
|
+
* @kind member
|
|
43
|
+
* @memberof LuigiContainer
|
|
31
44
|
* @example <luigi-container viewurl="/index.html" context='{"label": "Dashboard"}'></luigi-container>
|
|
32
45
|
* @example myContainer.context = {label: "Dashboard"}
|
|
33
46
|
*/
|
|
34
47
|
context: string;
|
|
35
48
|
|
|
36
49
|
/**
|
|
37
|
-
* Label information for the microfrontend.
|
|
50
|
+
* Label information for the microfrontend. <br><br>
|
|
51
|
+
* Type: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
38
52
|
* @since 1.0.0
|
|
39
|
-
*
|
|
53
|
+
* @type {String}
|
|
54
|
+
* @kind member
|
|
55
|
+
* @memberof LuigiContainer
|
|
40
56
|
* @example <luigi-container viewurl="/index.html" label="Dashboard"></luigi-container>
|
|
41
57
|
* @example myContainer.label = "Dashboard"
|
|
42
58
|
*/
|
|
43
59
|
label: string;
|
|
44
60
|
|
|
45
61
|
/**
|
|
46
|
-
* Predicate that sets whether the microfrontend is to be rendered in a web component or not. It can also be an object with the
|
|
47
|
-
* @
|
|
48
|
-
* @param {
|
|
49
|
-
* @param {
|
|
50
|
-
* @param {
|
|
51
|
-
* @param {
|
|
52
|
-
* @param {string}
|
|
53
|
-
*
|
|
54
|
-
* </br></br>
|
|
55
|
-
* <blockquote class="warning">
|
|
56
|
-
* <p>
|
|
57
|
-
* <strong>Note:</strong> If you have to use the mechanism of `selfRegistered`, we recommend using the following code in your web component:
|
|
58
|
-
* </p>
|
|
59
|
-
* </blockquote>
|
|
60
|
-
* <pre><code>
|
|
61
|
-
* window.Luigi._registerWebcomponent(new URL(document.currentScript?.getAttribute('src'), location), <YOUR_WEBCOMPONENT_CLASS>);
|
|
62
|
-
* </code></pre>
|
|
63
|
-
* The advantage of this line of code is: you don't have to specify a tag name, thus avoiding the duplication of self-defined tag names.
|
|
64
|
-
* </br>
|
|
62
|
+
* @description Predicate that sets whether the microfrontend is to be rendered in a web component or not. It can also be an object with the attributes shown in a table below. <br><br>Type: [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | WebComponentSettings | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
63
|
+
* @summary <blockquote class="warning"><p><strong>Note:</strong> If you have to use the mechanism of `selfRegistered`, we recommend using the following code in your web component:</p></blockquote> <pre><code>window.Luigi._registerWebcomponent(new URL(document.currentScript?.getAttribute('src'), location), <YOUR_WEBCOMPONENT_CLASS>);</code></pre> The advantage of this line of code is: you don't have to specify a tag name, thus avoiding the duplication of self-defined tag names. <br><br>
|
|
64
|
+
* @param {boolean} specifies - if a microfrontend is a webcomponent or not without any other settings
|
|
65
|
+
* @param {Object} [WebComponentSettings] - specifies that the microfrontend is a webcomponent with addtional settings
|
|
66
|
+
* @param {string} WebComponentSettings.type - a string, like module
|
|
67
|
+
* @param {boolean} WebComponentSettings.selfRegistered - if it is true, the web component bundle will be added via script tag
|
|
68
|
+
* @param {string} WebComponentSettings.tagName - tag name where web component is added to DOM
|
|
69
|
+
* @param {string} string - must be a stringified boolean or JSON object from type `WebComponentSettings`
|
|
65
70
|
* @since 1.0.0
|
|
66
|
-
* @
|
|
71
|
+
* @type {Boolean|WebComponentSettings|String}
|
|
72
|
+
* @kind member
|
|
73
|
+
* @memberof LuigiContainer
|
|
74
|
+
* @example <luigi-container webcomponent='{"type": "module", "selfRegistered": true, "tagName": "my-webcomponent"}'></luigi-container>
|
|
67
75
|
* @example myContainer.webcomponent = { type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}
|
|
68
76
|
*/
|
|
69
77
|
webcomponent: boolean | WebComponentSettings | string;
|
|
70
78
|
|
|
71
79
|
/**
|
|
72
|
-
* The locale to be passed to the web-component-based micro frontend.
|
|
80
|
+
* The locale to be passed to the web-component-based micro frontend. <br><br>
|
|
81
|
+
* Type: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
73
82
|
* @since 1.0.0
|
|
74
|
-
*
|
|
83
|
+
* @type {String}
|
|
84
|
+
* @kind member
|
|
85
|
+
* @memberof LuigiContainer
|
|
75
86
|
* @example <luigi-container locale="en_us"></luigi-container>
|
|
76
87
|
* @example myContainer.locale = "en_us"
|
|
77
88
|
*/
|
|
78
89
|
locale: string;
|
|
79
90
|
|
|
80
91
|
/**
|
|
81
|
-
* The theme to be passed to the web-component-based micro frontend.
|
|
92
|
+
* The theme to be passed to the web-component-based micro frontend. <br><br>
|
|
93
|
+
* Type: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
82
94
|
* @since 1.0.0
|
|
83
|
-
*
|
|
95
|
+
* @type {String}
|
|
96
|
+
* @kind member
|
|
97
|
+
* @memberof LuigiContainer
|
|
84
98
|
* @example <luigi-container viewurl="/index.html" theme='sap_horizon'></luigi-container>
|
|
85
99
|
* @example myContainer.theme = 'sap_horizon'
|
|
86
100
|
*/
|
|
87
101
|
theme: string;
|
|
88
102
|
|
|
89
103
|
/**
|
|
90
|
-
* The list of active feature toggles to be passed to the web-component-based micro frontend.
|
|
104
|
+
* The list of active feature toggles to be passed to the web-component-based micro frontend. <br><br>
|
|
105
|
+
* Type: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>
|
|
91
106
|
* @since 1.0.0
|
|
92
|
-
*
|
|
107
|
+
* @type {Array<string>}
|
|
108
|
+
* @kind member
|
|
109
|
+
* @memberof LuigiContainer
|
|
93
110
|
* @example myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"]
|
|
94
111
|
* @example <luigi-container viewurl="/index.html" active-feature-toggle-list='["enable-foo", "allow-bar"]'></luigi-container>
|
|
95
112
|
*/
|
|
96
113
|
activeFeatureToggleList: string[];
|
|
97
114
|
|
|
98
115
|
/**
|
|
99
|
-
* If set to true, skips third party cookie check
|
|
116
|
+
* If set to true, skips third party cookie check. <br><br>
|
|
117
|
+
* Type: [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
100
118
|
* @since 1.4.0
|
|
101
|
-
*
|
|
119
|
+
* @type {Boolean}
|
|
120
|
+
* @kind member
|
|
121
|
+
* @memberof LuigiContainer
|
|
102
122
|
* @example <luigi-container viewurl="/index.html" skipCookieCheck></luigi-container>
|
|
103
123
|
* @example myContainer.skipCookieCheck = true
|
|
104
124
|
*/
|
|
105
125
|
skipCookieCheck: boolean;
|
|
106
126
|
|
|
107
127
|
/**
|
|
108
|
-
* If set to true, skips handshake and ready event is fired immediately.
|
|
128
|
+
* If set to true, skips handshake and ready event is fired immediately. <br><br>
|
|
129
|
+
* Type: [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
109
130
|
* @since 1.0.0
|
|
131
|
+
* @type {Boolean}
|
|
132
|
+
* @kind member
|
|
133
|
+
* @memberof LuigiContainer
|
|
110
134
|
* @example <luigi-container viewurl="/index.html" skipInitCheck></luigi-container>
|
|
111
135
|
* @example myContainer.skipInitCheck = true
|
|
112
136
|
*/
|
|
113
137
|
skipInitCheck: boolean;
|
|
114
138
|
|
|
115
139
|
/**
|
|
116
|
-
* The parameters to be passed to the web-component-based micro frontend.
|
|
140
|
+
* The parameters to be passed to the web-component-based micro frontend. <br><br>
|
|
141
|
+
* Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
117
142
|
* @since 1.0.0
|
|
118
|
-
*
|
|
143
|
+
* @type {Object}
|
|
144
|
+
* @kind member
|
|
145
|
+
* @memberof LuigiContainer
|
|
119
146
|
* @example <luigi-container viewurl="/index.html" node-params='{"node":"param"}'></luigi-container>
|
|
120
147
|
* @example myContainer.nodeParams = {foo: bar}
|
|
121
148
|
*/
|
|
122
|
-
nodeParams:
|
|
149
|
+
nodeParams: object;
|
|
123
150
|
|
|
124
151
|
/**
|
|
125
|
-
* If set to true, the Luigi container webcomponent will not use the shadow DOM for rendering.
|
|
152
|
+
* If set to true, the Luigi container webcomponent will not use the shadow DOM for rendering. <br><br>
|
|
153
|
+
* Type: [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
126
154
|
* @since 1.2.0
|
|
127
|
-
*
|
|
155
|
+
* @type {Boolean}
|
|
156
|
+
* @kind member
|
|
157
|
+
* @memberof LuigiContainer
|
|
128
158
|
* @example <luigi-container viewurl="/index.html" no-shadow></luigi-container>
|
|
129
159
|
* @example myContainer.noShadow = true
|
|
130
160
|
*/
|
|
131
161
|
noShadow: boolean;
|
|
132
162
|
|
|
133
163
|
/**
|
|
134
|
-
* The search parameters to be passed to the web-component-based micro frontend.
|
|
164
|
+
* The search parameters to be passed to the web-component-based micro frontend. <br><br>
|
|
165
|
+
* Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
135
166
|
* @since 1.0.0
|
|
136
|
-
*
|
|
167
|
+
* @type {Object}
|
|
168
|
+
* @kind member
|
|
169
|
+
* @memberof LuigiContainer
|
|
137
170
|
* @example <luigi-container viewurl="/index.html" search-params='{"search":"param"}'></luigi-container>
|
|
138
171
|
* @example myContainer.searchParams = {foo: bar}
|
|
139
172
|
*/
|
|
140
|
-
searchParams:
|
|
173
|
+
searchParams: object;
|
|
141
174
|
|
|
142
175
|
/**
|
|
143
|
-
* The path parameters to be passed to the web-component-based micro frontend.
|
|
176
|
+
* The path parameters to be passed to the web-component-based micro frontend. <br><br>
|
|
177
|
+
* Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
144
178
|
* @since 1.0.0
|
|
145
|
-
*
|
|
179
|
+
* @type {Object}
|
|
180
|
+
* @kind member
|
|
181
|
+
* @memberof LuigiContainer
|
|
146
182
|
* @example <luigi-container viewurl="/index.html" path-params='{"path":"param"}'></luigi-container>
|
|
147
183
|
* @example myContainer.pathParams = {foo: "bar"}
|
|
148
184
|
*/
|
|
149
|
-
pathParams:
|
|
185
|
+
pathParams: object;
|
|
150
186
|
|
|
151
187
|
/**
|
|
152
|
-
* The clientPermissions to be passed to the web-component-based micro frontend.
|
|
188
|
+
* The clientPermissions to be passed to the web-component-based micro frontend. <br><br>
|
|
189
|
+
* Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
153
190
|
* @since 1.0.0
|
|
154
|
-
*
|
|
191
|
+
* @type {Object}
|
|
192
|
+
* @kind member
|
|
193
|
+
* @memberof LuigiContainer
|
|
155
194
|
* @example <luigi-container viewurl="/index.html" client-permissions='{"permission": "adminGroup"}'></luigi-container>
|
|
156
195
|
* @example myContainer.clientPermissions = {permission: "adminGroup"}
|
|
157
196
|
*/
|
|
158
|
-
clientPermissions:
|
|
197
|
+
clientPermissions: object;
|
|
159
198
|
|
|
160
199
|
/**
|
|
161
|
-
* The user settings to be passed to the web-component-based micro frontend.
|
|
200
|
+
* The user settings to be passed to the web-component-based micro frontend. <br><br>
|
|
201
|
+
* Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
162
202
|
* @since 1.0.0
|
|
163
|
-
*
|
|
203
|
+
* @type {Object}
|
|
204
|
+
* @kind member
|
|
205
|
+
* @memberof LuigiContainer
|
|
164
206
|
* @example <luigi-container viewurl="/index.html" user-settings='{"language": "de", "theme":"sap_horizon"}'></luigi-container>
|
|
165
207
|
* @example myContainer.userSettings = {language: 'de', theme: 'sap_horizon'}
|
|
166
208
|
*/
|
|
167
|
-
userSettings:
|
|
209
|
+
userSettings: object;
|
|
168
210
|
|
|
169
211
|
/**
|
|
170
|
-
* The anchor value to be passed to the web-component-based micro frontend.
|
|
212
|
+
* The anchor value to be passed to the web-component-based micro frontend. <br><br>
|
|
213
|
+
* Type: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
171
214
|
* @since 1.0.0
|
|
172
|
-
*
|
|
215
|
+
* @type {String}
|
|
216
|
+
* @kind member
|
|
217
|
+
* @memberof LuigiContainer
|
|
173
218
|
* @example <luigi-container viewurl="/index.html" anchor='#foo'></luigi-container>
|
|
174
219
|
* @example myContainer.anchor = '#foo'
|
|
175
220
|
*/
|
|
@@ -177,26 +222,37 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
177
222
|
|
|
178
223
|
/**
|
|
179
224
|
* The list of rules for the content in the iframe, managed by the HTML `allow` attribute.
|
|
180
|
-
* You can use one or more rules by adding them to the array, for example allowRules: ["microphone", "camera"].
|
|
225
|
+
* You can use one or more rules by adding them to the array, for example allowRules: ["microphone", "camera"]. <br><br>
|
|
226
|
+
* Type: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>
|
|
227
|
+
* @since 1.2.0
|
|
228
|
+
* @type {Array<string>}
|
|
229
|
+
* @kind member
|
|
230
|
+
* @memberof LuigiContainer
|
|
181
231
|
* @example <luigi-container viewurl="/index.html" allow-rules='["microphone", "camera"]'></luigi-container>
|
|
182
232
|
* @example containerElement.allowRules = ['microphone', 'camera']
|
|
183
|
-
* @since 1.2.0
|
|
184
233
|
*/
|
|
185
234
|
allowRules: string[];
|
|
186
235
|
|
|
187
236
|
/**
|
|
188
237
|
* The list of rules for the content in the iframe, managed by the HTML `sandbox` attribute.
|
|
189
|
-
* You can use one or more rules by adding them to the array, for example sandboxRules: ["allow-scripts", "allow-same-origin"].
|
|
238
|
+
* You can use one or more rules by adding them to the array, for example sandboxRules: ["allow-scripts", "allow-same-origin"]. <br><br>
|
|
239
|
+
* Type: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>
|
|
240
|
+
* @since 1.2.0
|
|
241
|
+
* @type {Array<string>}
|
|
242
|
+
* @kind member
|
|
243
|
+
* @memberof LuigiContainer
|
|
190
244
|
* @example <luigi-container viewurl="/index.html" sandbox-rules='["allow-scripts", "allow-same-origin"]'></luigi-container>
|
|
191
245
|
* @example containerElement.sandboxRules = ['allow-modals', 'allow-popups']
|
|
192
|
-
* @since 1.2.0
|
|
193
246
|
*/
|
|
194
247
|
sandboxRules: string[];
|
|
195
248
|
|
|
196
249
|
/**
|
|
197
|
-
* The document title value to be passed to the web-component-based micro frontend.
|
|
250
|
+
* The document title value to be passed to the web-component-based micro frontend. <br><br>
|
|
251
|
+
* Type: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
198
252
|
* @since 1.2.0
|
|
199
|
-
*
|
|
253
|
+
* @type {String}
|
|
254
|
+
* @kind member
|
|
255
|
+
* @memberof LuigiContainer
|
|
200
256
|
* @example <luigi-container viewurl="/index.html" document-title='Luigi App'></luigi-container>
|
|
201
257
|
* @example myContainer.documentTitle = 'Luigi App'
|
|
202
258
|
*/
|
|
@@ -204,9 +260,12 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
204
260
|
|
|
205
261
|
/**
|
|
206
262
|
* The hasBack value to be passed to the web-component-based micro frontend.
|
|
207
|
-
* It indicates that there is one or more preserved views. Useful when you need to show a back button.
|
|
263
|
+
* It indicates that there is one or more preserved views. Useful when you need to show a back button. <br><br>
|
|
264
|
+
* Type: [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
208
265
|
* @since 1.2.0
|
|
209
|
-
*
|
|
266
|
+
* @type {Boolean}
|
|
267
|
+
* @kind member
|
|
268
|
+
* @memberof LuigiContainer
|
|
210
269
|
* @example <luigi-container viewurl="/index.html" has-back></luigi-container>
|
|
211
270
|
* @example myContainer.hasBack = true
|
|
212
271
|
*/
|
|
@@ -214,84 +273,99 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
214
273
|
|
|
215
274
|
/**
|
|
216
275
|
* The dirty status value to be passed to the web-component-based micro frontend.
|
|
217
|
-
* It's used to indicate that there are unsaved changes when navigating away.
|
|
276
|
+
* It's used to indicate that there are unsaved changes when navigating away. <br><br>
|
|
277
|
+
* Type: [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
218
278
|
* @since 1.2.0
|
|
219
|
-
*
|
|
279
|
+
* @type {Boolean}
|
|
280
|
+
* @kind member
|
|
281
|
+
* @memberof LuigiContainer
|
|
220
282
|
* @example <luigi-container viewurl="/index.html" dirty-status></luigi-container>
|
|
221
283
|
* @example myContainer.dirtyStatus = true
|
|
222
284
|
*/
|
|
223
285
|
dirtyStatus: boolean;
|
|
224
286
|
|
|
287
|
+
/**
|
|
288
|
+
* The authData value to be passed to the iframe-based micro frontend. <br><br>
|
|
289
|
+
* Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
290
|
+
* @since 1.2.0
|
|
291
|
+
* @type {Object}
|
|
292
|
+
* @kind member
|
|
293
|
+
* @memberof LuigiContainer
|
|
294
|
+
*/
|
|
295
|
+
authData: object;
|
|
296
|
+
|
|
225
297
|
/**
|
|
226
298
|
* Function that updates the context of the microfrontend.
|
|
227
|
-
* @param {Object} contextObj
|
|
228
|
-
* @param {Object} internal internal luigi legacy data used for iframes
|
|
229
|
-
* @example
|
|
230
|
-
* containerElement.updateContext({newContextData: 'some data'})
|
|
299
|
+
* @param {Object} contextObj - the context data
|
|
300
|
+
* @param {Object} internal - internal luigi legacy data used for iframes
|
|
231
301
|
* @since 1.0.0
|
|
302
|
+
* @memberof LuigiContainer
|
|
303
|
+
* @example containerElement.updateContext({newContextData: 'some data'})
|
|
304
|
+
* @returns {void} no explicit return type
|
|
232
305
|
*/
|
|
233
|
-
updateContext(contextObj:
|
|
306
|
+
updateContext(contextObj: object, internal?: object): void {};
|
|
234
307
|
|
|
235
308
|
/**
|
|
236
309
|
* Send a custom message to the microfronted.
|
|
237
|
-
* @param id a string containing the message id
|
|
238
|
-
* @param data data to be sent alongside the custom message
|
|
239
|
-
* @example
|
|
240
|
-
* containerElement.sendCustomMessage('my-message-id', {dataToSend: 'some data'})
|
|
310
|
+
* @param {String} id - a string containing the message id
|
|
311
|
+
* @param {Object} data - data to be sent alongside the custom message
|
|
241
312
|
* @since 1.0.0
|
|
313
|
+
* @memberof LuigiContainer
|
|
314
|
+
* @example containerElement.sendCustomMessage('my-message-id', {dataToSend: 'some data'})
|
|
315
|
+
* @returns {void} no explicit return type
|
|
242
316
|
*/
|
|
243
|
-
sendCustomMessage(id: string, data?:
|
|
317
|
+
sendCustomMessage(id: string, data?: object): void {};
|
|
244
318
|
|
|
245
319
|
/**
|
|
246
320
|
* A function that notifies the microfrontend that the opened alert has been closed.
|
|
247
321
|
* This function is deprecated, please use `notifyAlertClosed`.
|
|
248
|
-
* @param id the id of the opened alert
|
|
249
|
-
* @param dismissKey the key specifying which dismiss link was clicked on the alert message (optional)
|
|
250
|
-
* @example
|
|
251
|
-
* containerElement.closeAlert('my-alert-id', 'my-dismiss-key')
|
|
322
|
+
* @param {String} id - the id of the opened alert
|
|
323
|
+
* @param {String} dismissKey - the key specifying which dismiss link was clicked on the alert message (optional)
|
|
252
324
|
* @since 1.0.0
|
|
253
|
-
* @
|
|
325
|
+
* @memberof LuigiContainer
|
|
326
|
+
* @example containerElement.closeAlert('my-alert-id', 'my-dismiss-key')
|
|
327
|
+
* @returns {void} no explicit return type
|
|
328
|
+
* @deprecated this is deprecated
|
|
254
329
|
*/
|
|
255
|
-
closeAlert(id: string, dismissKey?: string): void;
|
|
330
|
+
closeAlert(id: string, dismissKey?: string): void {};
|
|
256
331
|
|
|
257
332
|
/**
|
|
258
333
|
* A function that notifies the microfrontend that the opened alert has been closed.
|
|
259
|
-
* @param id the id of the opened alert
|
|
260
|
-
* @param dismissKey the key specifying which dismiss link was clicked on the alert message (optional)
|
|
261
|
-
* @example
|
|
262
|
-
* containerElement.notifyAlertClosed('my-alert-id', 'my-dismiss-key')
|
|
334
|
+
* @param {String} id - the id of the opened alert
|
|
335
|
+
* @param {String} dismissKey - the key specifying which dismiss link was clicked on the alert message (optional)
|
|
263
336
|
* @since 1.6.0
|
|
337
|
+
* @memberof LuigiContainer
|
|
338
|
+
* @example containerElement.notifyAlertClosed('my-alert-id', 'my-dismiss-key')
|
|
339
|
+
* @returns {void} no explicit return type
|
|
264
340
|
*/
|
|
265
|
-
notifyAlertClosed(id: string, dismissKey?: string): void;
|
|
341
|
+
notifyAlertClosed(id: string, dismissKey?: string): void {};
|
|
266
342
|
|
|
267
343
|
/**
|
|
268
344
|
* A function that notifies the microfrontend that the opened confirmation modal has been closed.
|
|
269
|
-
* @param {boolean} result the output of the opened confirmation modal (true/false)
|
|
270
|
-
* @example
|
|
271
|
-
* containerElement.notifyConfirmationModalClosed(true)
|
|
345
|
+
* @param {boolean} result - the output of the opened confirmation modal (true/false)
|
|
272
346
|
* @since 1.7.0
|
|
347
|
+
* @memberof LuigiContainer
|
|
348
|
+
* @example containerElement.notifyConfirmationModalClosed(true)
|
|
349
|
+
* @returns {void} no explicit return type
|
|
273
350
|
*/
|
|
274
|
-
notifyConfirmationModalClosed(result: boolean): void;
|
|
351
|
+
notifyConfirmationModalClosed(result: boolean): void {};
|
|
275
352
|
|
|
276
353
|
/**
|
|
277
354
|
* Updates route of the microfrontend by sending a message to the iframe that sets new view URL.
|
|
278
|
-
* @param {string} viewurl new view URL
|
|
279
|
-
* @param {Object} internal Luigi legacy data (optional)
|
|
355
|
+
* @param {string} viewurl - new view URL
|
|
356
|
+
* @param {Object} internal - Luigi legacy data (optional)
|
|
280
357
|
* @since 1.5.0
|
|
358
|
+
* @memberof LuigiContainer
|
|
359
|
+
* @returns {void} no explicit return type
|
|
281
360
|
*/
|
|
282
|
-
updateViewUrl(viewurl: string, internal?:
|
|
361
|
+
updateViewUrl(viewurl: string, internal?: object): void {};
|
|
283
362
|
|
|
284
363
|
/**
|
|
285
364
|
* Manually triggers the micro frontend rendering process when using defer-init attribute.
|
|
286
|
-
* @example
|
|
287
|
-
* containerElement.init()
|
|
288
365
|
* @since 1.0.0
|
|
366
|
+
* @memberof LuigiContainer
|
|
367
|
+
* @example containerElement.init()
|
|
368
|
+
* @returns {void} no explicit return type
|
|
289
369
|
*/
|
|
290
|
-
init(): void;
|
|
291
|
-
|
|
292
|
-
/**
|
|
293
|
-
* The authData value to be passed to the iframe-based micro frontend.
|
|
294
|
-
* @since 1.2.0
|
|
295
|
-
*/
|
|
296
|
-
authData: Object;
|
|
370
|
+
init(): void {};
|
|
297
371
|
}
|