@luigi-project/container 1.2.0-rc4 → 1.2.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.
|
@@ -12,9 +12,9 @@ export default class LuigiCompoundContainer extends HTMLElement {
|
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
14
|
* The configuration for the compound microfrontend
|
|
15
|
-
* Take a look at the [compound parameter](https://docs.luigi-project.io/docs/navigation-parameters-reference/?section=compound) for details.
|
|
15
|
+
* Take a look at the [compound parameter](https://docs.luigi-project.io/docs/navigation-parameters-reference/?section=compound) for details.
|
|
16
16
|
* @since 1.0.0
|
|
17
|
-
*
|
|
17
|
+
*
|
|
18
18
|
*/
|
|
19
19
|
compoundConfig: Object;
|
|
20
20
|
|
|
@@ -26,7 +26,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
|
|
|
26
26
|
|
|
27
27
|
/**
|
|
28
28
|
* If set to true, the Luigi compound container webcomponent will not use the shadow DOM for rendering.
|
|
29
|
-
* @since
|
|
29
|
+
* @since 1.2.0
|
|
30
30
|
*/
|
|
31
31
|
noShadow: boolean;
|
|
32
32
|
|
|
@@ -68,21 +68,21 @@ export default class LuigiCompoundContainer extends HTMLElement {
|
|
|
68
68
|
|
|
69
69
|
/**
|
|
70
70
|
* The document title value to be passed to the compound micro frontend.
|
|
71
|
-
* @since
|
|
71
|
+
* @since 1.2.0
|
|
72
72
|
*/
|
|
73
73
|
documentTitle: string;
|
|
74
74
|
|
|
75
75
|
/**
|
|
76
76
|
* The hasBack value to be passed to the compound micro frontend.
|
|
77
|
-
* It indicates that there is one or more preserved views. Useful when you need to show a back button.
|
|
78
|
-
* @since
|
|
77
|
+
* It indicates that there is one or more preserved views. Useful when you need to show a back button.
|
|
78
|
+
* @since 1.2.0
|
|
79
79
|
*/
|
|
80
80
|
hasBack: string;
|
|
81
81
|
|
|
82
82
|
/**
|
|
83
83
|
* The dirty status value to be passed to the compound micro frontend.
|
|
84
84
|
* It's used to indicate that there are unsaved changes when navigating away.
|
|
85
|
-
* @since
|
|
85
|
+
* @since 1.2.0
|
|
86
86
|
*/
|
|
87
87
|
dirtyStatus: boolean;
|
|
88
88
|
|
|
@@ -100,7 +100,6 @@ export default class LuigiCompoundContainer extends HTMLElement {
|
|
|
100
100
|
/**
|
|
101
101
|
* Function that updates the context of the compound microfrontend.
|
|
102
102
|
* @param contextObj The context data
|
|
103
|
-
*
|
|
104
103
|
* @example
|
|
105
104
|
* containerElement.updateContext({newContextData: 'some data'})
|
|
106
105
|
* @since 1.0.0
|
|
@@ -7,14 +7,12 @@ export declare interface WebComponentSettings {
|
|
|
7
7
|
export default class LuigiContainer extends HTMLElement {
|
|
8
8
|
/**
|
|
9
9
|
* The URL of the microfrontend to be rendered
|
|
10
|
-
*
|
|
11
10
|
* @since 1.0.0
|
|
12
11
|
*/
|
|
13
12
|
viewurl: string;
|
|
14
13
|
|
|
15
14
|
/**
|
|
16
15
|
* If set to true defers from initializing the microfronted automatically. In that case init() can be used
|
|
17
|
-
*
|
|
18
16
|
* @since 1.0.0
|
|
19
17
|
*/
|
|
20
18
|
deferInit: boolean;
|
|
@@ -39,7 +37,7 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
39
37
|
* @param {boolean} WebComponentSettings.selfRegistered: if it is true, the web component bundle will be added via script tag.
|
|
40
38
|
* @param {string} WebComponentSettings.tagName: tag name where web component is added to DOM.
|
|
41
39
|
* @param {string} string must be a stringified boolean or JSON object from type `WebComponentSettings`.
|
|
42
|
-
*
|
|
40
|
+
*
|
|
43
41
|
* </br></br>
|
|
44
42
|
* <blockquote class="warning">
|
|
45
43
|
* <p>
|
|
@@ -74,7 +72,7 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
74
72
|
activeFeatureToggleList: string[];
|
|
75
73
|
|
|
76
74
|
/**
|
|
77
|
-
* If set to true, skips handshake and ready event is fired immediately
|
|
75
|
+
* If set to true, skips handshake and ready event is fired immediately
|
|
78
76
|
* @since 1.0.0
|
|
79
77
|
*/
|
|
80
78
|
skipInitCheck: boolean;
|
|
@@ -87,7 +85,7 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
87
85
|
|
|
88
86
|
/**
|
|
89
87
|
* If set to true, the Luigi container webcomponent will not use the shadow DOM for rendering.
|
|
90
|
-
* @since
|
|
88
|
+
* @since 1.2.0
|
|
91
89
|
*/
|
|
92
90
|
noShadow: boolean;
|
|
93
91
|
|
|
@@ -124,34 +122,34 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
124
122
|
/**
|
|
125
123
|
* The list of rules for the content in the iframe, managed by the HTML `allow` attribute.
|
|
126
124
|
* You can use one or more rules by adding them to the array, for example allowRules: ["microphone", "camera"].
|
|
127
|
-
* @since
|
|
125
|
+
* @since 1.2.0
|
|
128
126
|
*/
|
|
129
127
|
allowRules: string[];
|
|
130
128
|
|
|
131
129
|
/**
|
|
132
130
|
* The list of rules for the content in the iframe, managed by the HTML `sandbox` attribute.
|
|
133
131
|
* You can use one or more rules by adding them to the array, for example sandboxRules: ["allow-scripts", "allow-same-origin"].
|
|
134
|
-
* @since
|
|
132
|
+
* @since 1.2.0
|
|
135
133
|
*/
|
|
136
134
|
sandboxRules: string[];
|
|
137
135
|
|
|
138
136
|
/**
|
|
139
137
|
* The document title value to be passed to the web-component-based micro frontend.
|
|
140
|
-
* @since
|
|
138
|
+
* @since 1.2.0
|
|
141
139
|
*/
|
|
142
140
|
documentTitle: string;
|
|
143
141
|
|
|
144
142
|
/**
|
|
145
143
|
* The hasBack value to be passed to the web-component-based micro frontend.
|
|
146
|
-
* It indicates that there is one or more preserved views. Useful when you need to show a back button.
|
|
147
|
-
* @since
|
|
144
|
+
* It indicates that there is one or more preserved views. Useful when you need to show a back button.
|
|
145
|
+
* @since 1.2.0
|
|
148
146
|
*/
|
|
149
147
|
hasBack: string;
|
|
150
148
|
|
|
151
149
|
/**
|
|
152
150
|
* The dirty status value to be passed to the web-component-based micro frontend.
|
|
153
151
|
* It's used to indicate that there are unsaved changes when navigating away.
|
|
154
|
-
* @since
|
|
152
|
+
* @since 1.2.0
|
|
155
153
|
*/
|
|
156
154
|
dirtyStatus: boolean;
|
|
157
155
|
|
|
@@ -159,7 +157,6 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
159
157
|
* Function that updates the context of the microfrontend
|
|
160
158
|
* @param {Object} contextObj The context data
|
|
161
159
|
* @param {Object} internal internal luigi legacy data used for iframes
|
|
162
|
-
*
|
|
163
160
|
* @example
|
|
164
161
|
* containerElement.updateContext({newContextData: 'some data'})
|
|
165
162
|
* @since 1.0.0
|
|
@@ -170,7 +167,6 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
170
167
|
* Send a custom message to the microfronted
|
|
171
168
|
* @param id a string containing the message id
|
|
172
169
|
* @param data data to be sent alongside the custom message
|
|
173
|
-
*
|
|
174
170
|
* @example
|
|
175
171
|
* containerElement.sendCustomMessage('my-message-id', {dataToSend: 'some data'})
|
|
176
172
|
* @since 1.0.0
|
|
@@ -181,7 +177,6 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
181
177
|
* A function that notifies the microfrontend that the opened alert has been closed
|
|
182
178
|
* @param id the id of the opened alert
|
|
183
179
|
* @param dismissKey the key specifying which dismiss link was clicked on the alert message
|
|
184
|
-
*
|
|
185
180
|
* @example
|
|
186
181
|
* containerElement.closeAlert('my-alert-id', 'my-dismiss-key')
|
|
187
182
|
* @since 1.0.0
|
|
@@ -190,7 +185,6 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
190
185
|
|
|
191
186
|
/**
|
|
192
187
|
* Manually triggers the micro frontend rendering process when using defer-init attribute
|
|
193
|
-
*
|
|
194
188
|
* @example
|
|
195
189
|
* containerElement.init()
|
|
196
190
|
* @since 1.0.0
|
|
@@ -199,7 +193,7 @@ export default class LuigiContainer extends HTMLElement {
|
|
|
199
193
|
|
|
200
194
|
/**
|
|
201
195
|
* The authData value to be passed to the iframe-based micro frontend.
|
|
202
|
-
* @since
|
|
196
|
+
* @since 1.2.0
|
|
203
197
|
*/
|
|
204
|
-
|
|
198
|
+
authData: Object;
|
|
205
199
|
}
|
package/package.json
CHANGED