@luigi-project/container 1.7.5 → 1.7.6
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
|
@@ -229,175 +229,175 @@
|
|
|
229
229
|
"events": [
|
|
230
230
|
{
|
|
231
231
|
"name": "custom-message",
|
|
232
|
-
"description": "Event fired when the micro frontend sends a custom message. @type {Object} @property {object} data - event data @property {string} id - event ID @example { data: {}, id: 'some-id' }",
|
|
232
|
+
"description": "Event fired when the micro frontend sends a custom message. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object} @memberof Events @property {object} data - event data @property {string} id - event ID @example { data: {}, id: 'some-id' }",
|
|
233
233
|
"type": {
|
|
234
234
|
"text": "Event"
|
|
235
235
|
}
|
|
236
236
|
},
|
|
237
237
|
{
|
|
238
238
|
"name": "navigation-request",
|
|
239
|
-
"description": "Event fired when a navigation has been requested by the micro frontend. Payload:
|
|
239
|
+
"description": "Event fired when a navigation has been requested by the micro frontend. Payload: [NavigationRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {NavigationRequestPayload} @memberof Events @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, link: '/test/route', nodeParams: {} }",
|
|
240
240
|
"type": {
|
|
241
241
|
"text": "Event"
|
|
242
242
|
}
|
|
243
243
|
},
|
|
244
244
|
{
|
|
245
245
|
"name": "show-alert-request",
|
|
246
|
-
"description": "Event fired when the micro frontend requests to show an alert. Read more about `showAlert` params [here](https://docs.luigi-project.io/docs/luigi-core-api?section=showalert). Payload:
|
|
246
|
+
"description": "Event fired when the micro frontend requests to show an alert. Read more about `showAlert` params [here](https://docs.luigi-project.io/docs/luigi-core-api?section=showalert). Payload: [AlertRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {AlertRequestPayload} @memberof Events @example { text: 'Custom alert message', type: 'info', links: { goToHome: { text: 'Homepage', url: '/overview' }, goToOtherProject: { text: 'Other project', url: '/projects/pr2' }, relativePath: { text: 'Hide side nav', url: 'hideSideNav' }, neverShowItAgain: { text: 'Never show it again', dismissKey: 'neverShowItAgain' } }, closeAfter: 3000 }",
|
|
247
247
|
"type": {
|
|
248
248
|
"text": "Event"
|
|
249
249
|
}
|
|
250
250
|
},
|
|
251
251
|
{
|
|
252
252
|
"name": "initialized",
|
|
253
|
-
"description": "Event fired when the micro frontend has been initialized. @type {unspecified} (type is not relevant in this case)",
|
|
253
|
+
"description": "Event fired when the micro frontend has been initialized. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
254
254
|
"type": {
|
|
255
255
|
"text": "Event"
|
|
256
256
|
}
|
|
257
257
|
},
|
|
258
258
|
{
|
|
259
259
|
"name": "add-search-params-request",
|
|
260
|
-
"description": "Event fired when the micro frontend requests the addition of search parameters to the URL. Payload:
|
|
260
|
+
"description": "Event fired when the micro frontend requests the addition of search parameters to the URL. Payload: [ParamsRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {ParamsRequestPayload} @memberof Events @example { data: {}, keepBrowserHistory: false }",
|
|
261
261
|
"type": {
|
|
262
262
|
"text": "Event"
|
|
263
263
|
}
|
|
264
264
|
},
|
|
265
265
|
{
|
|
266
266
|
"name": "add-node-params-request",
|
|
267
|
-
"description": "Event fired when the micro frontend requests the addition of node parameters to the URL. Payload:
|
|
267
|
+
"description": "Event fired when the micro frontend requests the addition of node parameters to the URL. Payload: [ParamsRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {ParamsRequestPayload} @memberof Events @example { data: {}, keepBrowserHistory: false }",
|
|
268
268
|
"type": {
|
|
269
269
|
"text": "Event"
|
|
270
270
|
}
|
|
271
271
|
},
|
|
272
272
|
{
|
|
273
273
|
"name": "show-confirmation-modal-request",
|
|
274
|
-
"description": "Event fired when the micro frontend requests to show a confirmation modal. Read more about `showConfirmationModal` params [here](https://docs.luigi-project.io/docs/luigi-core-api?section=showconfirmationmodal). Payload:
|
|
274
|
+
"description": "Event fired when the micro frontend requests to show a confirmation modal. Read more about `showConfirmationModal` params [here](https://docs.luigi-project.io/docs/luigi-core-api?section=showconfirmationmodal). Payload: [ConfirmationModalRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {ConfirmationModalRequestPayload} @memberof Events @example { header: 'Confirmation', body: 'Are you sure you want to do this?', buttonConfirm: 'Yes', buttonDismiss: 'No' }",
|
|
275
275
|
"type": {
|
|
276
276
|
"text": "Event"
|
|
277
277
|
}
|
|
278
278
|
},
|
|
279
279
|
{
|
|
280
280
|
"name": "show-loading-indicator-request",
|
|
281
|
-
"description": "Event fired when the micro frontend requests to show a loading indicator. @type {unspecified} (type is not relevant in this case)",
|
|
281
|
+
"description": "Event fired when the micro frontend requests to show a loading indicator. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
282
282
|
"type": {
|
|
283
283
|
"text": "Event"
|
|
284
284
|
}
|
|
285
285
|
},
|
|
286
286
|
{
|
|
287
287
|
"name": "hide-loading-indicator-request",
|
|
288
|
-
"description": "Event fired when the micro frontend requests to hide the loading indicator. @type {unspecified} (type is not relevant in this case)",
|
|
288
|
+
"description": "Event fired when the micro frontend requests to hide the loading indicator. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
289
289
|
"type": {
|
|
290
290
|
"text": "Event"
|
|
291
291
|
}
|
|
292
292
|
},
|
|
293
293
|
{
|
|
294
294
|
"name": "set-current-locale-request",
|
|
295
|
-
"description": "Event fired when the micro frontend requests to set the current locale. @type {Object.<string, string>} @example { currentLocale: 'en' }",
|
|
295
|
+
"description": "Event fired when the micro frontend requests to set the current locale. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, string>} @memberof Events @example { currentLocale: 'en' }",
|
|
296
296
|
"type": {
|
|
297
297
|
"text": "Event"
|
|
298
298
|
}
|
|
299
299
|
},
|
|
300
300
|
{
|
|
301
301
|
"name": "set-storage-request",
|
|
302
|
-
"description": "Event fired when the micro frontend requests to modify the local storage. @type {Object.<string, string>} @example { key: 'luigi-version', value: '2.21.0' }",
|
|
302
|
+
"description": "Event fired when the micro frontend requests to modify the local storage. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, string>} @memberof Events @example { key: 'luigi-version', value: '2.21.0' }",
|
|
303
303
|
"type": {
|
|
304
304
|
"text": "Event"
|
|
305
305
|
}
|
|
306
306
|
},
|
|
307
307
|
{
|
|
308
308
|
"name": "runtime-error-handling-request",
|
|
309
|
-
"description": "Event fired when the micro frontend requests to handle errors that might happen during the runtime of the micro frontend. @type {unspecified} (type is not relevant in this case)",
|
|
309
|
+
"description": "Event fired when the micro frontend requests to handle errors that might happen during the runtime of the micro frontend. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
310
310
|
"type": {
|
|
311
311
|
"text": "Event"
|
|
312
312
|
}
|
|
313
313
|
},
|
|
314
314
|
{
|
|
315
315
|
"name": "set-anchor-request",
|
|
316
|
-
"description": "Event fired when the micro frontend requests to set the anchor of the URL. @type {
|
|
316
|
+
"description": "Event fired when the micro frontend requests to set the anchor of the URL. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) @type {String} @memberof Events @example 'some-anchor'",
|
|
317
317
|
"type": {
|
|
318
318
|
"text": "Event"
|
|
319
319
|
}
|
|
320
320
|
},
|
|
321
321
|
{
|
|
322
322
|
"name": "set-third-party-cookies-request",
|
|
323
|
-
"description": "Event fired when the micro frontend requests to set third-party cookies. @type {unspecified} (type is not relevant in this case)",
|
|
323
|
+
"description": "Event fired when the micro frontend requests to set third-party cookies. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
324
324
|
"type": {
|
|
325
325
|
"text": "Event"
|
|
326
326
|
}
|
|
327
327
|
},
|
|
328
328
|
{
|
|
329
329
|
"name": "get-current-route-request",
|
|
330
|
-
"description": "Event fired when the micro frontend requests the current app route. Payload:
|
|
330
|
+
"description": "Event fired when the micro frontend requests the current app route. Payload: [CurrentRouteRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {CurrentRouteRequestPayload} @memberof Events @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, nodeParams: {} }",
|
|
331
331
|
"type": {
|
|
332
332
|
"text": "Event"
|
|
333
333
|
}
|
|
334
334
|
},
|
|
335
335
|
{
|
|
336
336
|
"name": "report-navigation-completed-request",
|
|
337
|
-
"description": "Event fired to report that the micro frontend's navigation has completed. @type {unspecified} (type is not relevant in this case)",
|
|
337
|
+
"description": "Event fired to report that the micro frontend's navigation has completed. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
338
338
|
"type": {
|
|
339
339
|
"text": "Event"
|
|
340
340
|
}
|
|
341
341
|
},
|
|
342
342
|
{
|
|
343
343
|
"name": "update-modal-path-data-request",
|
|
344
|
-
"description": "Event fired when the micro frontend requests to update the modal path parameters. Payload:
|
|
344
|
+
"description": "Event fired when the micro frontend requests to update the modal path parameters. Payload: [ModalPathDataRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {ModalPathDataRequestPayload} @memberof Events @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, history: true, link: '/test/route', modal: { title: 'Some modal' }, nodeParams: {} }",
|
|
345
345
|
"type": {
|
|
346
346
|
"text": "Event"
|
|
347
347
|
}
|
|
348
348
|
},
|
|
349
349
|
{
|
|
350
350
|
"name": "update-modal-settings-request",
|
|
351
|
-
"description": "Event fired when the micro frontend requests to update the modal settings. Read more about `updateModalSettings` params [here](https://docs.luigi-project.io/docs/luigi-client-api?section=updatemodalsettings). Payload:
|
|
351
|
+
"description": "Event fired when the micro frontend requests to update the modal settings. Read more about `updateModalSettings` params [here](https://docs.luigi-project.io/docs/luigi-client-api?section=updatemodalsettings). Payload: [ModalSettingsRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {ModalSettingsRequestPayload} @memberof Events @example { addHistoryEntry: true, updatedModalSettings: {} }",
|
|
352
352
|
"type": {
|
|
353
353
|
"text": "Event"
|
|
354
354
|
}
|
|
355
355
|
},
|
|
356
356
|
{
|
|
357
357
|
"name": "check-path-exists-request",
|
|
358
|
-
"description": "Event fired when the micro frontend requests to check the validity of a path. @type {Object.<string, string>} @example { link: '/test/route' }",
|
|
358
|
+
"description": "Event fired when the micro frontend requests to check the validity of a path. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, string>} @memberof Events @example { link: '/test/route' }",
|
|
359
359
|
"type": {
|
|
360
360
|
"text": "Event"
|
|
361
361
|
}
|
|
362
362
|
},
|
|
363
363
|
{
|
|
364
364
|
"name": "set-dirty-status-request",
|
|
365
|
-
"description": "Event fired when the micro frontend requests to set the 'dirty status' which, for example, avoids closing when there are any unsaved changes. @type {Object.<string, boolean>} @example { dirty: true }",
|
|
365
|
+
"description": "Event fired when the micro frontend requests to set the 'dirty status' which, for example, avoids closing when there are any unsaved changes. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, boolean>} @memberof Events @example { dirty: true }",
|
|
366
366
|
"type": {
|
|
367
367
|
"text": "Event"
|
|
368
368
|
}
|
|
369
369
|
},
|
|
370
370
|
{
|
|
371
371
|
"name": "set-viewgroup-data-request",
|
|
372
|
-
"description": "Event fired when the micro frontend requests to set the view group data. @type {Object.<string, unknown>} @example { vg: 'some data' }",
|
|
372
|
+
"description": "Event fired when the micro frontend requests to set the view group data. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, unknown>} @memberof Events @example { vg: 'some data' }",
|
|
373
373
|
"type": {
|
|
374
374
|
"text": "Event"
|
|
375
375
|
}
|
|
376
376
|
},
|
|
377
377
|
{
|
|
378
378
|
"name": "go-back-request",
|
|
379
|
-
"description": "Event fired when the micro frontend requests to navigate back. @type {Object.<string, unknown>} @example { ctx: 'some context' }",
|
|
379
|
+
"description": "Event fired when the micro frontend requests to navigate back. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, unknown>} @memberof Events @example { ctx: 'some context' }",
|
|
380
380
|
"type": {
|
|
381
381
|
"text": "Event"
|
|
382
382
|
}
|
|
383
383
|
},
|
|
384
384
|
{
|
|
385
385
|
"name": "add-backdrop-request",
|
|
386
|
-
"description": "Event fired when the micro frontend requests to display the backdrop. @type {unspecified} (type is not relevant in this case)",
|
|
386
|
+
"description": "Event fired when the micro frontend requests to display the backdrop. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
387
387
|
"type": {
|
|
388
388
|
"text": "Event"
|
|
389
389
|
}
|
|
390
390
|
},
|
|
391
391
|
{
|
|
392
392
|
"name": "remove-backdrop-request",
|
|
393
|
-
"description": "Event fired when the micro frontend requests to remove the backdrop. @type {unspecified} (type is not relevant in this case)",
|
|
393
|
+
"description": "Event fired when the micro frontend requests to remove the backdrop. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
394
394
|
"type": {
|
|
395
395
|
"text": "Event"
|
|
396
396
|
}
|
|
397
397
|
},
|
|
398
398
|
{
|
|
399
399
|
"name": "close-current-modal-request",
|
|
400
|
-
"description": "Event fired when the micro frontend requests to close the current modal. @type {unspecified} (type is not relevant in this case)",
|
|
400
|
+
"description": "Event fired when the micro frontend requests to close the current modal. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
401
401
|
"type": {
|
|
402
402
|
"text": "Event"
|
|
403
403
|
}
|
|
@@ -607,175 +607,175 @@
|
|
|
607
607
|
"events": [
|
|
608
608
|
{
|
|
609
609
|
"name": "custom-message",
|
|
610
|
-
"description": "Event fired when the micro frontend sends a custom message. @type {Object} @property {object} data - event data @property {string} id - event ID @example { data: {}, id: 'some-id' }",
|
|
610
|
+
"description": "Event fired when the micro frontend sends a custom message. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object} @memberof Events @property {object} data - event data @property {string} id - event ID @example { data: {}, id: 'some-id' }",
|
|
611
611
|
"type": {
|
|
612
612
|
"text": "Event"
|
|
613
613
|
}
|
|
614
614
|
},
|
|
615
615
|
{
|
|
616
616
|
"name": "navigation-request",
|
|
617
|
-
"description": "Event fired when a navigation has been requested by the micro frontend. Payload:
|
|
617
|
+
"description": "Event fired when a navigation has been requested by the micro frontend. Payload: [NavigationRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {NavigationRequestPayload} @memberof Events @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, link: '/test/route', nodeParams: {} }",
|
|
618
618
|
"type": {
|
|
619
619
|
"text": "Event"
|
|
620
620
|
}
|
|
621
621
|
},
|
|
622
622
|
{
|
|
623
623
|
"name": "show-alert-request",
|
|
624
|
-
"description": "Event fired when the micro frontend requests to show an alert. Read more about `showAlert` params [here](https://docs.luigi-project.io/docs/luigi-core-api?section=showalert). Payload:
|
|
624
|
+
"description": "Event fired when the micro frontend requests to show an alert. Read more about `showAlert` params [here](https://docs.luigi-project.io/docs/luigi-core-api?section=showalert). Payload: [AlertRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {AlertRequestPayload} @memberof Events @example { text: 'Custom alert message', type: 'info', links: { goToHome: { text: 'Homepage', url: '/overview' }, goToOtherProject: { text: 'Other project', url: '/projects/pr2' }, relativePath: { text: 'Hide side nav', url: 'hideSideNav' }, neverShowItAgain: { text: 'Never show it again', dismissKey: 'neverShowItAgain' } }, closeAfter: 3000 }",
|
|
625
625
|
"type": {
|
|
626
626
|
"text": "Event"
|
|
627
627
|
}
|
|
628
628
|
},
|
|
629
629
|
{
|
|
630
630
|
"name": "initialized",
|
|
631
|
-
"description": "Event fired when the micro frontend has been initialized. @type {unspecified} (type is not relevant in this case)",
|
|
631
|
+
"description": "Event fired when the micro frontend has been initialized. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
632
632
|
"type": {
|
|
633
633
|
"text": "Event"
|
|
634
634
|
}
|
|
635
635
|
},
|
|
636
636
|
{
|
|
637
637
|
"name": "add-search-params-request",
|
|
638
|
-
"description": "Event fired when the micro frontend requests the addition of search parameters to the URL. Payload:
|
|
638
|
+
"description": "Event fired when the micro frontend requests the addition of search parameters to the URL. Payload: [ParamsRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {ParamsRequestPayload} @memberof Events @example { data: {}, keepBrowserHistory: false }",
|
|
639
639
|
"type": {
|
|
640
640
|
"text": "Event"
|
|
641
641
|
}
|
|
642
642
|
},
|
|
643
643
|
{
|
|
644
644
|
"name": "add-node-params-request",
|
|
645
|
-
"description": "Event fired when the micro frontend requests the addition of node parameters to the URL. Payload:
|
|
645
|
+
"description": "Event fired when the micro frontend requests the addition of node parameters to the URL. Payload: [ParamsRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {ParamsRequestPayload} @memberof Events @example { data: {}, keepBrowserHistory: false }",
|
|
646
646
|
"type": {
|
|
647
647
|
"text": "Event"
|
|
648
648
|
}
|
|
649
649
|
},
|
|
650
650
|
{
|
|
651
651
|
"name": "show-confirmation-modal-request",
|
|
652
|
-
"description": "Event fired when the micro frontend requests to show a confirmation modal. Read more about `showConfirmationModal` params [here](https://docs.luigi-project.io/docs/luigi-core-api?section=showconfirmationmodal). Payload:
|
|
652
|
+
"description": "Event fired when the micro frontend requests to show a confirmation modal. Read more about `showConfirmationModal` params [here](https://docs.luigi-project.io/docs/luigi-core-api?section=showconfirmationmodal). Payload: [ConfirmationModalRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {ConfirmationModalRequestPayload} @memberof Events @example { header: 'Confirmation', body: 'Are you sure you want to do this?', buttonConfirm: 'Yes', buttonDismiss: 'No' }",
|
|
653
653
|
"type": {
|
|
654
654
|
"text": "Event"
|
|
655
655
|
}
|
|
656
656
|
},
|
|
657
657
|
{
|
|
658
658
|
"name": "show-loading-indicator-request",
|
|
659
|
-
"description": "Event fired when the micro frontend requests to show a loading indicator. @type {unspecified} (type is not relevant in this case)",
|
|
659
|
+
"description": "Event fired when the micro frontend requests to show a loading indicator. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
660
660
|
"type": {
|
|
661
661
|
"text": "Event"
|
|
662
662
|
}
|
|
663
663
|
},
|
|
664
664
|
{
|
|
665
665
|
"name": "hide-loading-indicator-request",
|
|
666
|
-
"description": "Event fired when the micro frontend requests to hide the loading indicator. @type {unspecified} (type is not relevant in this case)",
|
|
666
|
+
"description": "Event fired when the micro frontend requests to hide the loading indicator. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
667
667
|
"type": {
|
|
668
668
|
"text": "Event"
|
|
669
669
|
}
|
|
670
670
|
},
|
|
671
671
|
{
|
|
672
672
|
"name": "set-current-locale-request",
|
|
673
|
-
"description": "Event fired when the micro frontend requests to set the current locale. @type {Object.<string, string>} @example { currentLocale: 'en' }",
|
|
673
|
+
"description": "Event fired when the micro frontend requests to set the current locale. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, string>} @memberof Events @example { currentLocale: 'en' }",
|
|
674
674
|
"type": {
|
|
675
675
|
"text": "Event"
|
|
676
676
|
}
|
|
677
677
|
},
|
|
678
678
|
{
|
|
679
679
|
"name": "set-storage-request",
|
|
680
|
-
"description": "Event fired when the micro frontend requests to modify the local storage. @type {Object.<string, string>} @example { key: 'luigi-version', value: '2.21.0' }",
|
|
680
|
+
"description": "Event fired when the micro frontend requests to modify the local storage. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, string>} @memberof Events @example { key: 'luigi-version', value: '2.21.0' }",
|
|
681
681
|
"type": {
|
|
682
682
|
"text": "Event"
|
|
683
683
|
}
|
|
684
684
|
},
|
|
685
685
|
{
|
|
686
686
|
"name": "runtime-error-handling-request",
|
|
687
|
-
"description": "Event fired when the micro frontend requests to handle errors that might happen during the runtime of the micro frontend. @type {unspecified} (type is not relevant in this case)",
|
|
687
|
+
"description": "Event fired when the micro frontend requests to handle errors that might happen during the runtime of the micro frontend. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
688
688
|
"type": {
|
|
689
689
|
"text": "Event"
|
|
690
690
|
}
|
|
691
691
|
},
|
|
692
692
|
{
|
|
693
693
|
"name": "set-anchor-request",
|
|
694
|
-
"description": "Event fired when the micro frontend requests to set the anchor of the URL. @type {
|
|
694
|
+
"description": "Event fired when the micro frontend requests to set the anchor of the URL. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) @type {String} @memberof Events @example 'some-anchor'",
|
|
695
695
|
"type": {
|
|
696
696
|
"text": "Event"
|
|
697
697
|
}
|
|
698
698
|
},
|
|
699
699
|
{
|
|
700
700
|
"name": "set-third-party-cookies-request",
|
|
701
|
-
"description": "Event fired when the micro frontend requests to set third-party cookies. @type {unspecified} (type is not relevant in this case)",
|
|
701
|
+
"description": "Event fired when the micro frontend requests to set third-party cookies. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
702
702
|
"type": {
|
|
703
703
|
"text": "Event"
|
|
704
704
|
}
|
|
705
705
|
},
|
|
706
706
|
{
|
|
707
707
|
"name": "get-current-route-request",
|
|
708
|
-
"description": "Event fired when the micro frontend requests the current app route. Payload:
|
|
708
|
+
"description": "Event fired when the micro frontend requests the current app route. Payload: [CurrentRouteRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {CurrentRouteRequestPayload} @memberof Events @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, nodeParams: {} }",
|
|
709
709
|
"type": {
|
|
710
710
|
"text": "Event"
|
|
711
711
|
}
|
|
712
712
|
},
|
|
713
713
|
{
|
|
714
714
|
"name": "report-navigation-completed-request",
|
|
715
|
-
"description": "Event fired to report that the micro frontend's navigation has completed. @type {unspecified} (type is not relevant in this case)",
|
|
715
|
+
"description": "Event fired to report that the micro frontend's navigation has completed. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
716
716
|
"type": {
|
|
717
717
|
"text": "Event"
|
|
718
718
|
}
|
|
719
719
|
},
|
|
720
720
|
{
|
|
721
721
|
"name": "update-modal-path-data-request",
|
|
722
|
-
"description": "Event fired when the micro frontend requests to update the modal path parameters. Payload:
|
|
722
|
+
"description": "Event fired when the micro frontend requests to update the modal path parameters. Payload: [ModalPathDataRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {ModalPathDataRequestPayload} @memberof Events @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, history: true, link: '/test/route', modal: { title: 'Some modal' }, nodeParams: {} }",
|
|
723
723
|
"type": {
|
|
724
724
|
"text": "Event"
|
|
725
725
|
}
|
|
726
726
|
},
|
|
727
727
|
{
|
|
728
728
|
"name": "update-modal-settings-request",
|
|
729
|
-
"description": "Event fired when the micro frontend requests to update the modal settings. Read more about `updateModalSettings` params [here](https://docs.luigi-project.io/docs/luigi-client-api?section=updatemodalsettings). Payload:
|
|
729
|
+
"description": "Event fired when the micro frontend requests to update the modal settings. Read more about `updateModalSettings` params [here](https://docs.luigi-project.io/docs/luigi-client-api?section=updatemodalsettings). Payload: [ModalSettingsRequestPayload](https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts) @type {ModalSettingsRequestPayload} @memberof Events @example { addHistoryEntry: true, updatedModalSettings: {} }",
|
|
730
730
|
"type": {
|
|
731
731
|
"text": "Event"
|
|
732
732
|
}
|
|
733
733
|
},
|
|
734
734
|
{
|
|
735
735
|
"name": "check-path-exists-request",
|
|
736
|
-
"description": "Event fired when the micro frontend requests to check the validity of a path. @type {Object.<string, string>} @example { link: '/test/route' }",
|
|
736
|
+
"description": "Event fired when the micro frontend requests to check the validity of a path. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, string>} @memberof Events @example { link: '/test/route' }",
|
|
737
737
|
"type": {
|
|
738
738
|
"text": "Event"
|
|
739
739
|
}
|
|
740
740
|
},
|
|
741
741
|
{
|
|
742
742
|
"name": "set-dirty-status-request",
|
|
743
|
-
"description": "Event fired when the micro frontend requests to set the 'dirty status' which, for example, avoids closing when there are any unsaved changes. @type {Object.<string, boolean>} @example { dirty: true }",
|
|
743
|
+
"description": "Event fired when the micro frontend requests to set the 'dirty status' which, for example, avoids closing when there are any unsaved changes. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, boolean>} @memberof Events @example { dirty: true }",
|
|
744
744
|
"type": {
|
|
745
745
|
"text": "Event"
|
|
746
746
|
}
|
|
747
747
|
},
|
|
748
748
|
{
|
|
749
749
|
"name": "set-viewgroup-data-request",
|
|
750
|
-
"description": "Event fired when the micro frontend requests to set the view group data. @type {Object.<string, unknown>} @example { vg: 'some data' }",
|
|
750
|
+
"description": "Event fired when the micro frontend requests to set the view group data. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, unknown>} @memberof Events @example { vg: 'some data' }",
|
|
751
751
|
"type": {
|
|
752
752
|
"text": "Event"
|
|
753
753
|
}
|
|
754
754
|
},
|
|
755
755
|
{
|
|
756
756
|
"name": "go-back-request",
|
|
757
|
-
"description": "Event fired when the micro frontend requests to navigate back. @type {Object.<string, unknown>} @example { ctx: 'some context' }",
|
|
757
|
+
"description": "Event fired when the micro frontend requests to navigate back. Payload: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) @type {Object.<string, unknown>} @memberof Events @example { ctx: 'some context' }",
|
|
758
758
|
"type": {
|
|
759
759
|
"text": "Event"
|
|
760
760
|
}
|
|
761
761
|
},
|
|
762
762
|
{
|
|
763
763
|
"name": "add-backdrop-request",
|
|
764
|
-
"description": "Event fired when the micro frontend requests to display the backdrop. @type {unspecified} (type is not relevant in this case)",
|
|
764
|
+
"description": "Event fired when the micro frontend requests to display the backdrop. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
765
765
|
"type": {
|
|
766
766
|
"text": "Event"
|
|
767
767
|
}
|
|
768
768
|
},
|
|
769
769
|
{
|
|
770
770
|
"name": "remove-backdrop-request",
|
|
771
|
-
"description": "Event fired when the micro frontend requests to remove the backdrop. @type {unspecified} (type is not relevant in this case)",
|
|
771
|
+
"description": "Event fired when the micro frontend requests to remove the backdrop. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
772
772
|
"type": {
|
|
773
773
|
"text": "Event"
|
|
774
774
|
}
|
|
775
775
|
},
|
|
776
776
|
{
|
|
777
777
|
"name": "close-current-modal-request",
|
|
778
|
-
"description": "Event fired when the micro frontend requests to close the current modal. @type {unspecified} (type is not relevant in this case)",
|
|
778
|
+
"description": "Event fired when the micro frontend requests to close the current modal. @type {unspecified} (type is not relevant in this case) @memberof Events",
|
|
779
779
|
"type": {
|
|
780
780
|
"text": "Event"
|
|
781
781
|
}
|
package/package.json
CHANGED