@luigi-project/container
Advanced tools
Comparing version 1.3.0-dev.202410140909 to 1.3.0-dev.202410141937
@@ -218,2 +218,10 @@ { | ||
"name": "getNoShadow" | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "init" | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "addEventListener" | ||
} | ||
@@ -445,184 +453,642 @@ ], | ||
} | ||
} | ||
], | ||
"attributes": [ | ||
{ | ||
"description": "The list of active feature toggles to be passed to the web-component-based micro frontend.", | ||
"name": "active-feature-toggle-list", | ||
"default": "undefined", | ||
"fieldName": "activeFeatureToggleList", | ||
"type": { | ||
"text": "Array | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "The list of rules for the content in the iframe, managed by the HTML `allow` attribute. You can use one or more rules by adding them to the array, for example allowRules: ['microphone', 'camera']", | ||
"name": "allow-rules", | ||
"default": "undefined", | ||
"fieldName": "allowRules", | ||
"type": { | ||
"text": "Array | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "The anchor value to be passed to the web-component-based micro frontend.", | ||
"name": "anchor", | ||
"default": "undefined", | ||
"fieldName": "anchor", | ||
"type": { | ||
"text": "string | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "The authData value to be passed to the iframe-based micro frontend.", | ||
"name": "auth-data", | ||
"default": "undefined", | ||
"fieldName": "authData", | ||
"type": { | ||
"text": "object | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "The clientPermissions to be passed to the web-component-based micro frontend.", | ||
"name": "client-permissions", | ||
"default": "undefined", | ||
"fieldName": "clientPermissions", | ||
"type": { | ||
"text": "object | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "Context", | ||
"name": "context", | ||
"default": "undefined", | ||
"fieldName": "context", | ||
"type": { | ||
"text": "string | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "If set to true defers from initializing the microfronted automatically. In that case init() can be used.", | ||
"name": "defer-init", | ||
"default": "undefined", | ||
"fieldName": "deferInit", | ||
"type": { | ||
"text": "string | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "The dirty status value to be passed to the web-component-based micro frontend. It's used to indicate that there are unsaved changes when navigating away.", | ||
"name": "dirtyStatus", | ||
"default": "undefined", | ||
"fieldName": "dirty-status", | ||
"type": { | ||
"text": "boolean" | ||
} | ||
}, | ||
{ | ||
"description": "The document title value to be passed to the web-component-based micro frontend.", | ||
"name": "document-title", | ||
"default": "undefined", | ||
"fieldName": "documentTitle", | ||
"type": { | ||
"text": "string | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "The hasBack value to be passed to the web-component-based micro frontend. It indicates that there is one or more preserved views. Useful when you need to show a back button.", | ||
"name": "has-back", | ||
"default": "undefined", | ||
"fieldName": "hasBack", | ||
"type": { | ||
"text": "boolean" | ||
} | ||
}, | ||
{ | ||
"description": "Label information for the microfrontend.", | ||
"name": "label", | ||
"default": "undefined", | ||
"fieldName": "label", | ||
"type": { | ||
"text": "string | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "The locale to be passed to the web-component-based micro frontend.", | ||
"name": "locale", | ||
"default": "undefined", | ||
"fieldName": "locale", | ||
"type": { | ||
"text": "string | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "If set to true, the Luigi container webcomponent will not use the shadow DOM for rendering.", | ||
"name": "no-shadow", | ||
"default": "undefined", | ||
"fieldName": "noShadow", | ||
"type": { | ||
"text": "boolean" | ||
} | ||
}, | ||
{ | ||
"description": "The parameters to be passed to the web-component-based micro frontend. Will not be passed to the compound children.", | ||
"name": "node-params", | ||
"default": "undefined", | ||
"fieldName": "nodeParams", | ||
"type": { | ||
"text": "object | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "The path parameters to be passed to the web-component-based micro frontend.", | ||
"name": "path-params", | ||
"default": "undefined", | ||
"fieldName": "pathParams", | ||
"type": { | ||
"text": "object | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "The list of rules for the content in the iframe, managed by the HTML `sandbox` attribute. You can use one or more rules by adding them to the array.", | ||
"name": "sandbox-rules", | ||
"default": "undefined", | ||
"fieldName": "sandboxRules", | ||
"type": { | ||
"text": "Array" | ||
} | ||
}, | ||
{ | ||
"description": "The search parameters to be passed to the web-component-based micro frontend.", | ||
"name": "search-params", | ||
"default": "undefined", | ||
"fieldName": "searchParams", | ||
"type": { | ||
"text": "object | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "If set to true, skips third party cookie check.", | ||
"name": "skip-cookie-check", | ||
"default": "undefined", | ||
"fieldName": "skipCookieCheck", | ||
"type": { | ||
"text": "string | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "If set to true, skips handshake and ready event is fired immediately.", | ||
"name": "skip-init-check", | ||
"default": "undefined", | ||
"fieldName": "skipInitCheck", | ||
"type": { | ||
"text": "boolean" | ||
} | ||
}, | ||
{ | ||
"description": "The theme to be passed to the web-component-based micro frontend.", | ||
"name": "theme", | ||
"default": "undefined", | ||
"fieldName": "theme", | ||
"type": { | ||
"text": "string | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "The user settings to be passed to the web-component-based micro frontend.", | ||
"name": "user-settings", | ||
"default": "undefined", | ||
"fieldName": "userSettings", | ||
"type": { | ||
"text": "string | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "Url to the microfrontend", | ||
"name": "viewurl", | ||
"default": "undefined", | ||
"fieldName": "viewurl", | ||
"type": { | ||
"text": "string | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "Predicate that sets whether the microfrontend is to be rendered in a web component or not. It can be a boolean or an object.", | ||
"name": "webcomponent", | ||
"default": "undefined", | ||
"fieldName": "webcomponent", | ||
"type": { | ||
"text": "boolean | WebComponentSettings | string" | ||
} | ||
} | ||
], | ||
"slots": [] | ||
} | ||
], | ||
"exports": [ | ||
{ | ||
"kind": "js", | ||
"name": "LuigiContainer", | ||
"declaration": { | ||
"name": "LuigiContainer", | ||
"module": "LuigiContainer.js" | ||
} | ||
}, | ||
{ | ||
"kind": "custom-element-definition", | ||
"name": "luigi-container", | ||
"declaration": { | ||
"name": "LuigiContainer", | ||
"module": "LuigiContainer.js" | ||
} | ||
} | ||
] | ||
}, | ||
{ | ||
"kind": "javascript-module", | ||
"path": "dist/bundle.js", | ||
"declarations": [ | ||
{ | ||
"kind": "class", | ||
"description": "LuigiCompoundContainer", | ||
"name": "LuigiCompoundContainer", | ||
"tagName": "luigi-compound-container", | ||
"customElement": true, | ||
"members": [ | ||
{ | ||
"kind":"field", | ||
"name":"activeFeatureToggleList", | ||
"type":{ | ||
"text":"Array | undefined" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"anchor", | ||
"type":{ | ||
"text":"string | undefined" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"clientPermissions", | ||
"type":{ | ||
"text":"Object | undefined" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"compoundConfig", | ||
"type":{ | ||
"text":"Object | undefined" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "context", | ||
"type": { | ||
"text": "Object | string | undefined" | ||
}, | ||
"default": "undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"deferInit", | ||
"type":{ | ||
"text":"boolean" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"dirtyStatus", | ||
"type":{ | ||
"text":"boolean" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"documentTitle", | ||
"type":{ | ||
"text":"string | undefined" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"hasBack", | ||
"type":{ | ||
"text":"boolean" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"locale", | ||
"type":{ | ||
"text":"string | undefined" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"noShadow", | ||
"type":{ | ||
"text":"boolean" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"nodeParams", | ||
"type":{ | ||
"text":"Object" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"pathParams", | ||
"type":{ | ||
"text":"Object" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"searchParams", | ||
"type":{ | ||
"text":"Object" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"skipInitCheck", | ||
"type":{ | ||
"text":"boolean" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"theme", | ||
"type":{ | ||
"text":"string" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind":"field", | ||
"name":"userSettings", | ||
"type":{ | ||
"text":"Object" | ||
}, | ||
"default":"undefined" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "viewurl", | ||
"type": { | ||
"text": "string" | ||
}, | ||
"default": "undefined" | ||
}, | ||
{ | ||
"kind": "field", | ||
"name": "webcomponent", | ||
"type": { | ||
"text": "WebComponentSettings | string" | ||
} | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "updateContext" | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "attributeChangedCallback" | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "getNoShadow" | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "init" | ||
}, | ||
{ | ||
"kind": "method", | ||
"name": "addEventListener" | ||
} | ||
], | ||
"events": [ | ||
{ | ||
"name": "custom-message", | ||
"description": "A message emitted from the micro frontend when a custom message is sent.", | ||
"type": { | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "custom", | ||
"description": "A message emitted from the Microfrontend when a custom message is sent.", | ||
"name": "get-context-request", | ||
"description": "A message emitted from the micro frontend when the context data is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.get-context", | ||
"description": "A message emitted from the Microfrontend when the context data is sent.", | ||
"name": "navigation-request", | ||
"description": "A message emitted from the micro frontend when a navigation request is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.init", | ||
"description": "A message sent to the Microfrontend from parent with the context upon init.", | ||
"name": "show-alert-request", | ||
"description": "A message emitted from the micro frontend when a request to show an alert is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.init.ok", | ||
"description": "A message sent from the Microfrontend when the context data has been received properly.", | ||
"name": "close-alert-request", | ||
"description": "A message emitted from the micro frontend when a request to close an alert is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.navigation.open", | ||
"description": "A message emitted from the Microfrontend when a navigation request is sent.", | ||
"name": "initialized", | ||
"description": "A message emitted from the micro frontend when it is first initialized.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.ux.alert.show", | ||
"description": "A message emitted from the Microfrontend when a request to show an alert is sent.", | ||
"name": "add-search-params-request", | ||
"description": "A message emitted from the micro frontend to request adding search parameters to the URL.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.ux.alert.hide", | ||
"description": "A message sent to the Microfrontend to notify closing of a particular alert.", | ||
"name": "add-node-params-request", | ||
"description": "A message emitted from the micro frontend to request adding node parameters to the URL.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.init.ok", | ||
"description": "A message emitted from the Microfrontend when it is first initialized.", | ||
"name": "show-confirmation-modal-request", | ||
"description": "A message emitted from the micro frontend when a request to show a confirmation modal is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.addSearchParams", | ||
"description": "A message emitted from the Microfrontend to request adding search parameters to the URL.", | ||
"name": "show-loading-indicator-request", | ||
"description": "A message emitted from the micro frontend when a request to show a loading indicator is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.addNodeParams", | ||
"description": "A message emitted from the Microfrontend to request adding node parameters to the URL.", | ||
"name": "hide-loading-indicator-request", | ||
"description": "A message emitted from the micro frontend when a request to hide the loading indicator is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.ux.confirmationModal.show", | ||
"description": "A message emitted from the Microfrontend when a request to show a confirmation modal is sent.", | ||
"name": "set-current-locale-request", | ||
"description": "A message emitted from the micro frontend when a request to set the current locale is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.show-loading-indicator", | ||
"description": "A message emitted from the Microfrontend when a request to show loading indicator is sent.", | ||
"name": "set-storage-request", | ||
"description": "A message emitted from the micro frontend when a request to modify the local storage is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.hide-loading-indicator", | ||
"description": "A message emitted from the Microfrontend when a request to hide the loading indicator is sent.", | ||
"name": "runtime-error-handling-request", | ||
"description": "A message emitted from the micro frontend when a request to handle an error during runtime is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.ux.set-current-locale", | ||
"description": "A message emitted from the Microfrontend when a request to set the current locale is sent.", | ||
"name": "set-anchor-request", | ||
"description": "A message emitted from the micro frontend when a request to set the anchor of the URL is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "storage", | ||
"description": "A message emitted from the Microfrontend when a request to modify the local storage is sent.", | ||
"name": "set-third-party-cookies-request", | ||
"description": "A message emitted from the micro frontend when a request to set third-party cookies is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi-runtime-error-handling", | ||
"description": "A message emitted from the Microfrontend when a request to handle an error during runtime is sent.", | ||
"name": "navigate-back-request", | ||
"description": "A message emitted from the micro frontend when a request to navigate back is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.setAnchor", | ||
"description": "A message emitted from the Microfrontend when a request to set the anchor of the URL is sent.", | ||
"name": "get-current-route-request", | ||
"description": "A message emitted from the micro frontend when a request to receive the current app route is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.third-party-cookie", | ||
"description": "A message emitted from the Microfrontend when a request to set third-party cookies is sent.", | ||
"name": "report-navigation-completed-request", | ||
"description": "A message emitted from the micro frontend to report that the navigation is completed.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.navigation.back", | ||
"description": "A message emitted from the Microfrontend when a request to navigate back is sent.", | ||
"name": "update-modal-path-data-request", | ||
"description": "A message emitted from the micro frontend when a request to update the modal path parameters is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.navigation.currentRoute", | ||
"description": "A message emitted from the Microfrontend when a request to receive the current app route is sent.", | ||
"name": "check-path-exists-request", | ||
"description": "A message emitted from the micro frontend when a request to check the validity of a path is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.navigate", | ||
"description": "A message sent to the Microfrontend with the payload being the context sent.", | ||
"name": "set-dirty-status-request", | ||
"description": "A message emitted from the micro frontend when a request to set the 'dirty status' is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.navigate.ok", | ||
"description": "A message emitted from the Microfrontend to report that the navigation is completed.", | ||
"name": "set-viewgroup-data-request", | ||
"description": "A message emitted from the micro frontend when a request to set the view group data is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.navigation.updateModalDataPath", | ||
"description": "A message emitted from the Microfrontend when a request to update the modal path parameters is sent.", | ||
"name": "set-document-title-request", | ||
"description": "A message emitted from the micro frontend when a request to set the document title is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.navigation.pathExists", | ||
"description": "A message emitted from the Microfrontend when a request to check the validity of a path is sent.", | ||
"name": "open-user-settings-request", | ||
"description": "A message emitted from the micro frontend when a request to open user settings is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.set-page-dirty", | ||
"description": "A message emitted from the Microfrontend when a request to set the 'dirty status' is sent.", | ||
"name": "close-user-settings-request", | ||
"description": "A message emitted from the micro frontend when a request to close user settings is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "luigi.auth.tokenIssued", | ||
"description": "A message emitted from the Microfrontend when a request to set the 'token auth' is sent.", | ||
"name": "collapse-leftnav-request", | ||
"description": "A message emitted from the micro frontend when a request to collapse the left side navigation is sent.", | ||
"type": { | ||
"text": "LuigiInternalMessageID" | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "update-top-navigation-request", | ||
"description": "A message emitted from the micro frontend when a request to update the top navigation is sent.", | ||
"type": { | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "path-exists-request", | ||
"description": "A message emitted from the micro frontend when a request to check if a path exists is sent.", | ||
"type": { | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "go-back-request", | ||
"description": "A message emitted from the micro frontend when a request to navigate back is sent.", | ||
"type": { | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "has-back-request", | ||
"description": "A message emitted from the micro frontend to check if there is a back navigation option.", | ||
"type": { | ||
"text": "Event" | ||
} | ||
}, | ||
{ | ||
"name": "remove-backdrop-request", | ||
"description": "A message emitted from the micro frontend when a request to remove the backdrop is sent.", | ||
"type": { | ||
"text": "Event" | ||
} | ||
} | ||
@@ -632,3 +1098,3 @@ ], | ||
{ | ||
"description": "The list of active feature toggles to be passed to the web-component-based micro frontend.", | ||
"description": "The list of active feature toggles to be passed to the compound microfrontend.", | ||
"name": "active-feature-toggle-list", | ||
@@ -638,11 +1104,2 @@ "default": "undefined", | ||
"type": { | ||
"text": "string | undefined" | ||
} | ||
}, | ||
{ | ||
"description": "The list of rules for the content in the iframe, managed by the HTML `allow` attribute. You can use one or more rules by adding them to the array, for example allowRules: ['microphone', 'camera']", | ||
"name": "allow-rules", | ||
"default": "undefined", | ||
"fieldName": "allowRules", | ||
"type": { | ||
"text": "Array | undefined" | ||
@@ -652,3 +1109,3 @@ } | ||
{ | ||
"description": "The anchor value to be passed to the web-component-based micro frontend.", | ||
"description": "The anchor value to be passed to the compound micro frontend.", | ||
"name": "anchor", | ||
@@ -662,6 +1119,6 @@ "default": "undefined", | ||
{ | ||
"description": "The authData value to be passed to the iframe-based micro frontend.", | ||
"name": "auth-data", | ||
"description": "The clientPermissions to be passed to the compound micro frontend.", | ||
"name": "client-permissions", | ||
"default": "undefined", | ||
"fieldName": "authData", | ||
"fieldName": "clientPermissions", | ||
"type": { | ||
@@ -672,6 +1129,6 @@ "text": "object | undefined" | ||
{ | ||
"description": "The clientPermissions to be passed to the web-component-based micro frontend.", | ||
"name": "client-permissions", | ||
"description": "The configuration for the compound microfrontend", | ||
"name": "compound-config", | ||
"default": "undefined", | ||
"fieldName": "clientPermissions", | ||
"fieldName": "compoundConfig", | ||
"type": { | ||
@@ -682,3 +1139,3 @@ "text": "object | undefined" | ||
{ | ||
"description": "Context", | ||
"description": "The stringified context to be passed to the compound microfrontend.", | ||
"name": "context", | ||
@@ -701,3 +1158,3 @@ "default": "undefined", | ||
{ | ||
"description": "The dirty status value to be passed to the web-component-based micro frontend. It's used to indicate that there are unsaved changes when navigating away.", | ||
"description": "The dirty status value to be passed to the compound micro frontend. It's used to indicate that there are unsaved changes when navigating away.", | ||
"name": "dirtyStatus", | ||
@@ -711,3 +1168,3 @@ "default": "undefined", | ||
{ | ||
"description": "The document title value to be passed to the web-component-based micro frontend.", | ||
"description": "The document title value to be passed to the compound micro frontend.", | ||
"name": "document-title", | ||
@@ -721,3 +1178,3 @@ "default": "undefined", | ||
{ | ||
"description": "The hasBack value to be passed to the web-component-based micro frontend. It indicates that there is one or more preserved views. Useful when you need to show a back button.", | ||
"description": "The hasBack value to be passed to the compound micro frontend. It indicates that there is one or more preserved views. Useful when you need to show a back button.", | ||
"name": "has-back", | ||
@@ -740,3 +1197,3 @@ "default": "undefined", | ||
{ | ||
"description": "The locale to be passed to the web-component-based micro frontend.", | ||
"description": "The locale to be passed to the compound micro frontend.", | ||
"name": "locale", | ||
@@ -750,3 +1207,3 @@ "default": "undefined", | ||
{ | ||
"description": "If set to true, the Luigi container webcomponent will not use the shadow DOM for rendering.", | ||
"description": "If set to true, the Luigi compound container webcomponent will not use the shadow DOM for rendering.", | ||
"name": "no-shadow", | ||
@@ -760,3 +1217,3 @@ "default": "undefined", | ||
{ | ||
"description": "The parameters to be passed to the web-component-based micro frontend. Will not be passed to the compound children.", | ||
"description": "The parameters to be passed to the compound micro frontend. Will not be passed to the compound children.", | ||
"name": "node-params", | ||
@@ -770,3 +1227,3 @@ "default": "undefined", | ||
{ | ||
"description": "The path parameters to be passed to the web-component-based micro frontend.", | ||
"description": "The path parameters to be passed to the compound micro frontend.", | ||
"name": "path-params", | ||
@@ -780,12 +1237,3 @@ "default": "undefined", | ||
{ | ||
"description": "The list of rules for the content in the iframe, managed by the HTML `sandbox` attribute. You can use one or more rules by adding them to the array.", | ||
"name": "sandbox-rules", | ||
"default": "undefined", | ||
"fieldName": "sandboxRules", | ||
"type": { | ||
"text": "Array" | ||
} | ||
}, | ||
{ | ||
"description": "The search parameters to be passed to the web-component-based micro frontend.", | ||
"description": "The search parameters to be passed to the compound micro frontend.", | ||
"name": "search-params", | ||
@@ -817,3 +1265,3 @@ "default": "undefined", | ||
{ | ||
"description": "The theme to be passed to the web-component-based micro frontend.", | ||
"description": "The theme to be passed to the compound microfrontend.", | ||
"name": "theme", | ||
@@ -827,3 +1275,3 @@ "default": "undefined", | ||
{ | ||
"description": "The user settings to be passed to the web-component-based micro frontend.", | ||
"description": "The user settings to be passed to the compound micro frontend.", | ||
"name": "user-settings", | ||
@@ -837,3 +1285,3 @@ "default": "undefined", | ||
{ | ||
"description": "Url to the microfrontend", | ||
"description": "The URL used for the renderer.", | ||
"name": "viewurl", | ||
@@ -847,12 +1295,11 @@ "default": "undefined", | ||
{ | ||
"description": "Webcomponent", | ||
"description": "The following properties can be set for the web component object. By default, the web component is set to true.", | ||
"name": "webcomponent", | ||
"default": "undefined", | ||
"fieldName": "label", | ||
"fieldName": "webcomponent", | ||
"type": { | ||
"text": "boolean | WebComponentSettings | string" | ||
"text": "WebComponentSettings | string" | ||
} | ||
} | ||
], | ||
"slots": [] | ||
] | ||
} | ||
@@ -863,6 +1310,6 @@ ], | ||
"kind": "js", | ||
"name": "LuigiContainer", | ||
"name": "LuigiCompoundContainer", | ||
"declaration": { | ||
"name": "LuigiContainer", | ||
"module": "LuigiContainer.js" | ||
"name": "LuigiCompoundContainer", | ||
"module": "LuigiCompoundContainer.js" | ||
} | ||
@@ -872,6 +1319,6 @@ }, | ||
"kind": "custom-element-definition", | ||
"name": "luigi-container", | ||
"name": "luigi-compound-container", | ||
"declaration": { | ||
"name": "LuigiContainer", | ||
"module": "LuigiContainer.js" | ||
"name": "LuigiCompoundContainer", | ||
"module": "LuigiCompoundContainer.js" | ||
} | ||
@@ -878,0 +1325,0 @@ } |
@@ -14,3 +14,3 @@ export declare interface WebComponentSettings { | ||
/** | ||
* The configuration for the compound microfrontend | ||
* The configuration for the compound microfrontend. | ||
* Take a look at the [compound parameter](https://docs.luigi-project.io/docs/navigation-parameters-reference/?section=compound) for details. | ||
@@ -23,3 +23,3 @@ * @since 1.0.0 | ||
/** | ||
* If set to true defers from initializing the microfronted automatically. In that case init() can be used | ||
* If set to true defers from initializing the microfronted automatically. In that case init() can be used. | ||
* @since 1.0.0 | ||
@@ -61,3 +61,3 @@ */ | ||
/** | ||
* The stringified context to be passed to the compound microfrontend | ||
* The stringified context to be passed to the compound microfrontend. | ||
* @since 1.0.0 | ||
@@ -74,3 +74,3 @@ */ | ||
/** | ||
* The user settings to be passed to the compound micro frontend | ||
* The user settings to be passed to the compound micro frontend. | ||
* @since 1.0.0 | ||
@@ -77,0 +77,0 @@ */ |
@@ -22,3 +22,3 @@ { | ||
], | ||
"version": "1.3.0-dev.202410140909" | ||
"version": "1.3.0-dev.202410141937" | ||
} |
325424
2097