@luigi-project/container 1.7.0 → 1.7.2-dev.202508150038
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 +1 -0
- package/LuigiContainer.svelte.d.ts +1 -2
- package/bundle.js +1 -1
- package/bundle.js.map +1 -1
- package/constants/event-payloads.ts +71 -0
- package/constants/events.d.ts +248 -20
- package/constants/events.js +235 -19
- package/dist/custom-elements.json +48 -132
- package/index.d.ts +1 -1
- package/package.json +22 -22
|
@@ -229,210 +229,168 @@
|
|
|
229
229
|
"events": [
|
|
230
230
|
{
|
|
231
231
|
"name": "custom-message",
|
|
232
|
-
"description": "Event fired when the micro frontend sends a custom message.",
|
|
233
|
-
"type": {
|
|
234
|
-
"text": "Event"
|
|
235
|
-
}
|
|
236
|
-
},
|
|
237
|
-
{
|
|
238
|
-
"name": "get-context-request",
|
|
239
|
-
"description": "Event fired when the micro frontend requests the context data.",
|
|
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' }",
|
|
240
233
|
"type": {
|
|
241
234
|
"text": "Event"
|
|
242
235
|
}
|
|
243
236
|
},
|
|
244
237
|
{
|
|
245
238
|
"name": "navigation-request",
|
|
246
|
-
"description": "Event fired when a navigation has been requested by the micro frontend.",
|
|
239
|
+
"description": "Event fired when a navigation has been requested by the micro frontend. Payload: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|NavigationRequestPayload} @type {NavigationRequestPayload} @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, link: '/test/route', nodeParams: {} }",
|
|
247
240
|
"type": {
|
|
248
241
|
"text": "Event"
|
|
249
242
|
}
|
|
250
243
|
},
|
|
251
244
|
{
|
|
252
245
|
"name": "show-alert-request",
|
|
253
|
-
"description": "Event fired when the micro frontend requests to show an alert.",
|
|
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: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|AlertRequestPayload} @type {AlertRequestPayload} @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 }",
|
|
254
247
|
"type": {
|
|
255
248
|
"text": "Event"
|
|
256
249
|
}
|
|
257
250
|
},
|
|
258
251
|
{
|
|
259
252
|
"name": "initialized",
|
|
260
|
-
"description": "Event fired when the micro frontend has been initialized.",
|
|
253
|
+
"description": "Event fired when the micro frontend has been initialized. @type {unspecified} (type is not relevant in this case)",
|
|
261
254
|
"type": {
|
|
262
255
|
"text": "Event"
|
|
263
256
|
}
|
|
264
257
|
},
|
|
265
258
|
{
|
|
266
259
|
"name": "add-search-params-request",
|
|
267
|
-
"description": "Event fired when the micro frontend requests the addition of search parameters to the URL.",
|
|
260
|
+
"description": "Event fired when the micro frontend requests the addition of search parameters to the URL. Payload: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|ParamsRequestPayload} @type {ParamsRequestPayload} @example { data: {}, keepBrowserHistory: false }",
|
|
268
261
|
"type": {
|
|
269
262
|
"text": "Event"
|
|
270
263
|
}
|
|
271
264
|
},
|
|
272
265
|
{
|
|
273
266
|
"name": "add-node-params-request",
|
|
274
|
-
"description": "Event fired when the micro frontend requests the addition of node parameters to the URL.",
|
|
267
|
+
"description": "Event fired when the micro frontend requests the addition of node parameters to the URL. Payload: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|ParamsRequestPayload} @type {ParamsRequestPayload} @example { data: {}, keepBrowserHistory: false }",
|
|
275
268
|
"type": {
|
|
276
269
|
"text": "Event"
|
|
277
270
|
}
|
|
278
271
|
},
|
|
279
272
|
{
|
|
280
273
|
"name": "show-confirmation-modal-request",
|
|
281
|
-
"description": "Event fired when the micro frontend requests to show a confirmation modal.",
|
|
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: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|ConfirmationModalRequestPayload} @type {ConfirmationModalRequestPayload} @example { header: 'Confirmation', body: 'Are you sure you want to do this?', buttonConfirm: 'Yes', buttonDismiss: 'No' }",
|
|
282
275
|
"type": {
|
|
283
276
|
"text": "Event"
|
|
284
277
|
}
|
|
285
278
|
},
|
|
286
279
|
{
|
|
287
280
|
"name": "show-loading-indicator-request",
|
|
288
|
-
"description": "Event fired when the micro frontend requests to show a loading indicator.",
|
|
281
|
+
"description": "Event fired when the micro frontend requests to show a loading indicator. @type {unspecified} (type is not relevant in this case)",
|
|
289
282
|
"type": {
|
|
290
283
|
"text": "Event"
|
|
291
284
|
}
|
|
292
285
|
},
|
|
293
286
|
{
|
|
294
287
|
"name": "hide-loading-indicator-request",
|
|
295
|
-
"description": "Event fired when the micro frontend requests to hide the loading indicator.",
|
|
288
|
+
"description": "Event fired when the micro frontend requests to hide the loading indicator. @type {unspecified} (type is not relevant in this case)",
|
|
296
289
|
"type": {
|
|
297
290
|
"text": "Event"
|
|
298
291
|
}
|
|
299
292
|
},
|
|
300
293
|
{
|
|
301
294
|
"name": "set-current-locale-request",
|
|
302
|
-
"description": "Event fired when the micro frontend requests to set the current locale.",
|
|
295
|
+
"description": "Event fired when the micro frontend requests to set the current locale. @type {Object.<string, string>} @example { currentLocale: 'en' }",
|
|
303
296
|
"type": {
|
|
304
297
|
"text": "Event"
|
|
305
298
|
}
|
|
306
299
|
},
|
|
307
300
|
{
|
|
308
301
|
"name": "set-storage-request",
|
|
309
|
-
"description": "Event fired when the micro frontend requests to modify the local storage.",
|
|
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' }",
|
|
310
303
|
"type": {
|
|
311
304
|
"text": "Event"
|
|
312
305
|
}
|
|
313
306
|
},
|
|
314
307
|
{
|
|
315
308
|
"name": "runtime-error-handling-request",
|
|
316
|
-
"description": "Event fired when the micro frontend requests to handle errors that might happen during the runtime of the micro frontend.",
|
|
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)",
|
|
317
310
|
"type": {
|
|
318
311
|
"text": "Event"
|
|
319
312
|
}
|
|
320
313
|
},
|
|
321
314
|
{
|
|
322
315
|
"name": "set-anchor-request",
|
|
323
|
-
"description": "Event fired when the micro frontend requests to set the anchor of the URL.",
|
|
316
|
+
"description": "Event fired when the micro frontend requests to set the anchor of the URL. @type {string} @example 'some-anchor'",
|
|
324
317
|
"type": {
|
|
325
318
|
"text": "Event"
|
|
326
319
|
}
|
|
327
320
|
},
|
|
328
321
|
{
|
|
329
322
|
"name": "set-third-party-cookies-request",
|
|
330
|
-
"description": "Event fired when the micro frontend requests to set third-party cookies.",
|
|
323
|
+
"description": "Event fired when the micro frontend requests to set third-party cookies. @type {unspecified} (type is not relevant in this case)",
|
|
331
324
|
"type": {
|
|
332
325
|
"text": "Event"
|
|
333
326
|
}
|
|
334
327
|
},
|
|
335
328
|
{
|
|
336
329
|
"name": "get-current-route-request",
|
|
337
|
-
"description": "Event fired when the micro frontend requests the current app route.",
|
|
330
|
+
"description": "Event fired when the micro frontend requests the current app route. Payload: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|CurrentRouteRequestPayload} @type {CurrentRouteRequestPayload} @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, nodeParams: {} }",
|
|
338
331
|
"type": {
|
|
339
332
|
"text": "Event"
|
|
340
333
|
}
|
|
341
334
|
},
|
|
342
335
|
{
|
|
343
336
|
"name": "report-navigation-completed-request",
|
|
344
|
-
"description": "Event fired to report that the micro frontend's navigation has completed.",
|
|
337
|
+
"description": "Event fired to report that the micro frontend's navigation has completed. @type {unspecified} (type is not relevant in this case)",
|
|
345
338
|
"type": {
|
|
346
339
|
"text": "Event"
|
|
347
340
|
}
|
|
348
341
|
},
|
|
349
342
|
{
|
|
350
343
|
"name": "update-modal-path-data-request",
|
|
351
|
-
"description": "Event fired when the micro frontend requests to update the modal path parameters.",
|
|
344
|
+
"description": "Event fired when the micro frontend requests to update the modal path parameters. Payload: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|ModalPathDataRequestPayload} @type {ModalPathDataRequestPayload} @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, history: true, link: '/test/route', modal: { title: 'Some modal' }, nodeParams: {} }",
|
|
352
345
|
"type": {
|
|
353
346
|
"text": "Event"
|
|
354
347
|
}
|
|
355
348
|
},
|
|
356
349
|
{
|
|
357
350
|
"name": "update-modal-settings-request",
|
|
358
|
-
"description": "Event fired when the micro frontend requests to update the modal settings.",
|
|
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: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|ModalSettingsRequestPayload} @type {ModalSettingsRequestPayload} @example { addHistoryEntry: true, updatedModalSettings: {} }",
|
|
359
352
|
"type": {
|
|
360
353
|
"text": "Event"
|
|
361
354
|
}
|
|
362
355
|
},
|
|
363
356
|
{
|
|
364
357
|
"name": "check-path-exists-request",
|
|
365
|
-
"description": "Event fired when the micro frontend requests to check the validity of a path.",
|
|
358
|
+
"description": "Event fired when the micro frontend requests to check the validity of a path. @type {Object.<string, string>} @example { link: '/test/route' }",
|
|
366
359
|
"type": {
|
|
367
360
|
"text": "Event"
|
|
368
361
|
}
|
|
369
362
|
},
|
|
370
363
|
{
|
|
371
364
|
"name": "set-dirty-status-request",
|
|
372
|
-
"description": "Event fired when the micro frontend requests to set the 'dirty status' which, for example, avoids closing when there are any unsaved changes.",
|
|
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 }",
|
|
373
366
|
"type": {
|
|
374
367
|
"text": "Event"
|
|
375
368
|
}
|
|
376
369
|
},
|
|
377
370
|
{
|
|
378
371
|
"name": "set-viewgroup-data-request",
|
|
379
|
-
"description": "Event fired when the micro frontend requests to set the view group data.",
|
|
380
|
-
"type": {
|
|
381
|
-
"text": "Event"
|
|
382
|
-
}
|
|
383
|
-
},
|
|
384
|
-
{
|
|
385
|
-
"name": "open-user-settings-request",
|
|
386
|
-
"description": "Event fired when the micro frontend requests to open the user settings.",
|
|
387
|
-
"type": {
|
|
388
|
-
"text": "Event"
|
|
389
|
-
}
|
|
390
|
-
},
|
|
391
|
-
{
|
|
392
|
-
"name": "close-user-settings-request",
|
|
393
|
-
"description": "Event fired when the micro frontend requests to close the user settings.",
|
|
394
|
-
"type": {
|
|
395
|
-
"text": "Event"
|
|
396
|
-
}
|
|
397
|
-
},
|
|
398
|
-
{
|
|
399
|
-
"name": "collapse-leftnav-request",
|
|
400
|
-
"description": "Event fired when the micro frontend requests to collapse left side navigation.",
|
|
401
|
-
"type": {
|
|
402
|
-
"text": "Event"
|
|
403
|
-
}
|
|
404
|
-
},
|
|
405
|
-
{
|
|
406
|
-
"name": "update-top-navigation-request",
|
|
407
|
-
"description": "Event fired when the micro frontend requests to update the top navigation.",
|
|
372
|
+
"description": "Event fired when the micro frontend requests to set the view group data. @type {Object.<string, unknown>} @example { vg: 'some data' }",
|
|
408
373
|
"type": {
|
|
409
374
|
"text": "Event"
|
|
410
375
|
}
|
|
411
376
|
},
|
|
412
377
|
{
|
|
413
378
|
"name": "go-back-request",
|
|
414
|
-
"description": "Event fired when the micro frontend requests to navigate back.",
|
|
415
|
-
"type": {
|
|
416
|
-
"text": "Event"
|
|
417
|
-
}
|
|
418
|
-
},
|
|
419
|
-
{
|
|
420
|
-
"name": "has-back-request",
|
|
421
|
-
"description": "Event fired when the micro frontend requests to check if there are any preserved views.",
|
|
379
|
+
"description": "Event fired when the micro frontend requests to navigate back. @type {Object.<string, unknown>} @example { ctx: 'some context' }",
|
|
422
380
|
"type": {
|
|
423
381
|
"text": "Event"
|
|
424
382
|
}
|
|
425
383
|
},
|
|
426
384
|
{
|
|
427
385
|
"name": "add-backdrop-request",
|
|
428
|
-
"description": "Event fired when the micro frontend requests to display the backdrop.",
|
|
386
|
+
"description": "Event fired when the micro frontend requests to display the backdrop. @type {unspecified} (type is not relevant in this case)",
|
|
429
387
|
"type": {
|
|
430
388
|
"text": "Event"
|
|
431
389
|
}
|
|
432
390
|
},
|
|
433
391
|
{
|
|
434
392
|
"name": "remove-backdrop-request",
|
|
435
|
-
"description": "Event fired when the micro frontend requests to remove the backdrop.",
|
|
393
|
+
"description": "Event fired when the micro frontend requests to remove the backdrop. @type {unspecified} (type is not relevant in this case)",
|
|
436
394
|
"type": {
|
|
437
395
|
"text": "Event"
|
|
438
396
|
}
|
|
@@ -642,210 +600,168 @@
|
|
|
642
600
|
"events": [
|
|
643
601
|
{
|
|
644
602
|
"name": "custom-message",
|
|
645
|
-
"description": "Event fired when the micro frontend sends a custom message.",
|
|
646
|
-
"type": {
|
|
647
|
-
"text": "Event"
|
|
648
|
-
}
|
|
649
|
-
},
|
|
650
|
-
{
|
|
651
|
-
"name": "get-context-request",
|
|
652
|
-
"description": "Event fired when the micro frontend requests the context data.",
|
|
603
|
+
"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' }",
|
|
653
604
|
"type": {
|
|
654
605
|
"text": "Event"
|
|
655
606
|
}
|
|
656
607
|
},
|
|
657
608
|
{
|
|
658
609
|
"name": "navigation-request",
|
|
659
|
-
"description": "Event fired when a navigation has been requested by the micro frontend.",
|
|
610
|
+
"description": "Event fired when a navigation has been requested by the micro frontend. Payload: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|NavigationRequestPayload} @type {NavigationRequestPayload} @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, link: '/test/route', nodeParams: {} }",
|
|
660
611
|
"type": {
|
|
661
612
|
"text": "Event"
|
|
662
613
|
}
|
|
663
614
|
},
|
|
664
615
|
{
|
|
665
616
|
"name": "show-alert-request",
|
|
666
|
-
"description": "Event fired when the micro frontend requests to show an alert.",
|
|
617
|
+
"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: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|AlertRequestPayload} @type {AlertRequestPayload} @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 }",
|
|
667
618
|
"type": {
|
|
668
619
|
"text": "Event"
|
|
669
620
|
}
|
|
670
621
|
},
|
|
671
622
|
{
|
|
672
623
|
"name": "initialized",
|
|
673
|
-
"description": "Event fired when the micro frontend has been initialized.",
|
|
624
|
+
"description": "Event fired when the micro frontend has been initialized. @type {unspecified} (type is not relevant in this case)",
|
|
674
625
|
"type": {
|
|
675
626
|
"text": "Event"
|
|
676
627
|
}
|
|
677
628
|
},
|
|
678
629
|
{
|
|
679
630
|
"name": "add-search-params-request",
|
|
680
|
-
"description": "Event fired when the micro frontend requests the addition of search parameters to the URL.",
|
|
631
|
+
"description": "Event fired when the micro frontend requests the addition of search parameters to the URL. Payload: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|ParamsRequestPayload} @type {ParamsRequestPayload} @example { data: {}, keepBrowserHistory: false }",
|
|
681
632
|
"type": {
|
|
682
633
|
"text": "Event"
|
|
683
634
|
}
|
|
684
635
|
},
|
|
685
636
|
{
|
|
686
637
|
"name": "add-node-params-request",
|
|
687
|
-
"description": "Event fired when the micro frontend requests the addition of node parameters to the URL.",
|
|
638
|
+
"description": "Event fired when the micro frontend requests the addition of node parameters to the URL. Payload: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|ParamsRequestPayload} @type {ParamsRequestPayload} @example { data: {}, keepBrowserHistory: false }",
|
|
688
639
|
"type": {
|
|
689
640
|
"text": "Event"
|
|
690
641
|
}
|
|
691
642
|
},
|
|
692
643
|
{
|
|
693
644
|
"name": "show-confirmation-modal-request",
|
|
694
|
-
"description": "Event fired when the micro frontend requests to show a confirmation modal.",
|
|
645
|
+
"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: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|ConfirmationModalRequestPayload} @type {ConfirmationModalRequestPayload} @example { header: 'Confirmation', body: 'Are you sure you want to do this?', buttonConfirm: 'Yes', buttonDismiss: 'No' }",
|
|
695
646
|
"type": {
|
|
696
647
|
"text": "Event"
|
|
697
648
|
}
|
|
698
649
|
},
|
|
699
650
|
{
|
|
700
651
|
"name": "show-loading-indicator-request",
|
|
701
|
-
"description": "Event fired when the micro frontend requests to show a loading indicator.",
|
|
652
|
+
"description": "Event fired when the micro frontend requests to show a loading indicator. @type {unspecified} (type is not relevant in this case)",
|
|
702
653
|
"type": {
|
|
703
654
|
"text": "Event"
|
|
704
655
|
}
|
|
705
656
|
},
|
|
706
657
|
{
|
|
707
658
|
"name": "hide-loading-indicator-request",
|
|
708
|
-
"description": "Event fired when the micro frontend requests to hide the loading indicator.",
|
|
659
|
+
"description": "Event fired when the micro frontend requests to hide the loading indicator. @type {unspecified} (type is not relevant in this case)",
|
|
709
660
|
"type": {
|
|
710
661
|
"text": "Event"
|
|
711
662
|
}
|
|
712
663
|
},
|
|
713
664
|
{
|
|
714
665
|
"name": "set-current-locale-request",
|
|
715
|
-
"description": "Event fired when the micro frontend requests to set the current locale.",
|
|
666
|
+
"description": "Event fired when the micro frontend requests to set the current locale. @type {Object.<string, string>} @example { currentLocale: 'en' }",
|
|
716
667
|
"type": {
|
|
717
668
|
"text": "Event"
|
|
718
669
|
}
|
|
719
670
|
},
|
|
720
671
|
{
|
|
721
672
|
"name": "set-storage-request",
|
|
722
|
-
"description": "Event fired when the micro frontend requests to modify the local storage.",
|
|
673
|
+
"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' }",
|
|
723
674
|
"type": {
|
|
724
675
|
"text": "Event"
|
|
725
676
|
}
|
|
726
677
|
},
|
|
727
678
|
{
|
|
728
679
|
"name": "runtime-error-handling-request",
|
|
729
|
-
"description": "Event fired when the micro frontend requests to handle errors that might happen during the runtime of the micro frontend.",
|
|
680
|
+
"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)",
|
|
730
681
|
"type": {
|
|
731
682
|
"text": "Event"
|
|
732
683
|
}
|
|
733
684
|
},
|
|
734
685
|
{
|
|
735
686
|
"name": "set-anchor-request",
|
|
736
|
-
"description": "Event fired when the micro frontend requests to set the anchor of the URL.",
|
|
687
|
+
"description": "Event fired when the micro frontend requests to set the anchor of the URL. @type {string} @example 'some-anchor'",
|
|
737
688
|
"type": {
|
|
738
689
|
"text": "Event"
|
|
739
690
|
}
|
|
740
691
|
},
|
|
741
692
|
{
|
|
742
693
|
"name": "set-third-party-cookies-request",
|
|
743
|
-
"description": "Event fired when the micro frontend requests to set third-party cookies.",
|
|
694
|
+
"description": "Event fired when the micro frontend requests to set third-party cookies. @type {unspecified} (type is not relevant in this case)",
|
|
744
695
|
"type": {
|
|
745
696
|
"text": "Event"
|
|
746
697
|
}
|
|
747
698
|
},
|
|
748
699
|
{
|
|
749
700
|
"name": "get-current-route-request",
|
|
750
|
-
"description": "Event fired when the micro frontend requests the current app route.",
|
|
701
|
+
"description": "Event fired when the micro frontend requests the current app route. Payload: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|CurrentRouteRequestPayload} @type {CurrentRouteRequestPayload} @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, nodeParams: {} }",
|
|
751
702
|
"type": {
|
|
752
703
|
"text": "Event"
|
|
753
704
|
}
|
|
754
705
|
},
|
|
755
706
|
{
|
|
756
707
|
"name": "report-navigation-completed-request",
|
|
757
|
-
"description": "Event fired to report that the micro frontend's navigation has completed.",
|
|
708
|
+
"description": "Event fired to report that the micro frontend's navigation has completed. @type {unspecified} (type is not relevant in this case)",
|
|
758
709
|
"type": {
|
|
759
710
|
"text": "Event"
|
|
760
711
|
}
|
|
761
712
|
},
|
|
762
713
|
{
|
|
763
714
|
"name": "update-modal-path-data-request",
|
|
764
|
-
"description": "Event fired when the micro frontend requests to update the modal path parameters.",
|
|
715
|
+
"description": "Event fired when the micro frontend requests to update the modal path parameters. Payload: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|ModalPathDataRequestPayload} @type {ModalPathDataRequestPayload} @example { fromClosestContext: false, fromContext: null, fromParent: true, fromVirtualTreeRoot: false, history: true, link: '/test/route', modal: { title: 'Some modal' }, nodeParams: {} }",
|
|
765
716
|
"type": {
|
|
766
717
|
"text": "Event"
|
|
767
718
|
}
|
|
768
719
|
},
|
|
769
720
|
{
|
|
770
721
|
"name": "update-modal-settings-request",
|
|
771
|
-
"description": "Event fired when the micro frontend requests to update the modal settings.",
|
|
722
|
+
"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: {@link https://github.com/luigi-project/luigi/blob/main/container/typings/constants/event-payloads.ts|ModalSettingsRequestPayload} @type {ModalSettingsRequestPayload} @example { addHistoryEntry: true, updatedModalSettings: {} }",
|
|
772
723
|
"type": {
|
|
773
724
|
"text": "Event"
|
|
774
725
|
}
|
|
775
726
|
},
|
|
776
727
|
{
|
|
777
728
|
"name": "check-path-exists-request",
|
|
778
|
-
"description": "Event fired when the micro frontend requests to check the validity of a path.",
|
|
729
|
+
"description": "Event fired when the micro frontend requests to check the validity of a path. @type {Object.<string, string>} @example { link: '/test/route' }",
|
|
779
730
|
"type": {
|
|
780
731
|
"text": "Event"
|
|
781
732
|
}
|
|
782
733
|
},
|
|
783
734
|
{
|
|
784
735
|
"name": "set-dirty-status-request",
|
|
785
|
-
"description": "Event fired when the micro frontend requests to set the 'dirty status' which, for example, avoids closing when there are any unsaved changes.",
|
|
736
|
+
"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 }",
|
|
786
737
|
"type": {
|
|
787
738
|
"text": "Event"
|
|
788
739
|
}
|
|
789
740
|
},
|
|
790
741
|
{
|
|
791
742
|
"name": "set-viewgroup-data-request",
|
|
792
|
-
"description": "Event fired when the micro frontend requests to set the view group data.",
|
|
793
|
-
"type": {
|
|
794
|
-
"text": "Event"
|
|
795
|
-
}
|
|
796
|
-
},
|
|
797
|
-
{
|
|
798
|
-
"name": "open-user-settings-request",
|
|
799
|
-
"description": "Event fired when the micro frontend requests to open the user settings.",
|
|
800
|
-
"type": {
|
|
801
|
-
"text": "Event"
|
|
802
|
-
}
|
|
803
|
-
},
|
|
804
|
-
{
|
|
805
|
-
"name": "close-user-settings-request",
|
|
806
|
-
"description": "Event fired when the micro frontend requests to close the user settings.",
|
|
807
|
-
"type": {
|
|
808
|
-
"text": "Event"
|
|
809
|
-
}
|
|
810
|
-
},
|
|
811
|
-
{
|
|
812
|
-
"name": "collapse-leftnav-request",
|
|
813
|
-
"description": "Event fired when the micro frontend requests to collapse left side navigation.",
|
|
814
|
-
"type": {
|
|
815
|
-
"text": "Event"
|
|
816
|
-
}
|
|
817
|
-
},
|
|
818
|
-
{
|
|
819
|
-
"name": "update-top-navigation-request",
|
|
820
|
-
"description": "Event fired when the micro frontend requests to update the top navigation.",
|
|
743
|
+
"description": "Event fired when the micro frontend requests to set the view group data. @type {Object.<string, unknown>} @example { vg: 'some data' }",
|
|
821
744
|
"type": {
|
|
822
745
|
"text": "Event"
|
|
823
746
|
}
|
|
824
747
|
},
|
|
825
748
|
{
|
|
826
749
|
"name": "go-back-request",
|
|
827
|
-
"description": "Event fired when the micro frontend requests to navigate back.",
|
|
828
|
-
"type": {
|
|
829
|
-
"text": "Event"
|
|
830
|
-
}
|
|
831
|
-
},
|
|
832
|
-
{
|
|
833
|
-
"name": "has-back-request",
|
|
834
|
-
"description": "Event fired when the micro frontend requests to check if there are any preserved views.",
|
|
750
|
+
"description": "Event fired when the micro frontend requests to navigate back. @type {Object.<string, unknown>} @example { ctx: 'some context' }",
|
|
835
751
|
"type": {
|
|
836
752
|
"text": "Event"
|
|
837
753
|
}
|
|
838
754
|
},
|
|
839
755
|
{
|
|
840
756
|
"name": "add-backdrop-request",
|
|
841
|
-
"description": "Event fired when the micro frontend requests to display the backdrop.",
|
|
757
|
+
"description": "Event fired when the micro frontend requests to display the backdrop. @type {unspecified} (type is not relevant in this case)",
|
|
842
758
|
"type": {
|
|
843
759
|
"text": "Event"
|
|
844
760
|
}
|
|
845
761
|
},
|
|
846
762
|
{
|
|
847
763
|
"name": "remove-backdrop-request",
|
|
848
|
-
"description": "Event fired when the micro frontend requests to remove the backdrop.",
|
|
764
|
+
"description": "Event fired when the micro frontend requests to remove the backdrop. @type {unspecified} (type is not relevant in this case)",
|
|
849
765
|
"type": {
|
|
850
766
|
"text": "Event"
|
|
851
767
|
}
|
package/index.d.ts
CHANGED
|
@@ -2,4 +2,4 @@ export { default as LuigiContainer } from './LuigiContainer.svelte';
|
|
|
2
2
|
export { default as LuigiCompoundContainer } from './LuigiCompoundContainer.svelte';
|
|
3
3
|
import { Events } from './constants/events';
|
|
4
4
|
export default Events;
|
|
5
|
-
export type { PathExistsEvent } from './constants/event-type';
|
|
5
|
+
export type { PathExistsEvent } from './constants/event-type';
|
package/package.json
CHANGED
|
@@ -1,24 +1,24 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
2
|
+
"name": "@luigi-project/container",
|
|
3
|
+
"description": "Javascript library enabling creation of microfrontends",
|
|
4
|
+
"license": "Apache-2.0",
|
|
5
|
+
"main": "bundle.js",
|
|
6
|
+
"types": "index.d.ts",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "ssh://github.com/luigi-project/luigi.git"
|
|
10
|
+
},
|
|
11
|
+
"customElements": "./dist/custom-elements.json",
|
|
12
|
+
"publishConfig": {
|
|
13
|
+
"tag": "luigi-container"
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"luigi",
|
|
17
|
+
"core",
|
|
18
|
+
"UI",
|
|
19
|
+
"extensibility",
|
|
20
|
+
"micro-frontends",
|
|
21
|
+
"microfrontends"
|
|
22
|
+
],
|
|
23
|
+
"version": "1.7.2-dev.202508150038"
|
|
24
24
|
}
|