@@ -7,7 +7,7 @@ export declare interface WebComponentSettings {
77export default class LuigiCompoundContainer extends HTMLElement {
88 /**
99 * The URL used for the renderer.
10- *
10+ *
1111 * @example <luigi-container viewurl="/index.html"></luigi-container>
1212 * @example myContainer.viewurl = "/index.html"
1313 */
@@ -17,7 +17,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
1717 * The configuration for the compound microfrontend.
1818 * Take a look at the [compound parameter](https://docs.luigi-project.io/docs/navigation-parameters-reference/?section=compound) for details.
1919 * @since 1.0.0
20- *
20+ *
2121 * @example renderer = { use: 'grid', config: { columns: '1fr 1fr 1fr 2fr', layouts: [{maxWidth: 600, columns: '1fr', gap: 0, ...}]}};
2222 * children = [{ viewUrl: '/main.js', context: { label: 'WC', ...}, layoutConfig: {column: '1 / -1', ...}, eventListeners: [{ source: 'input1', ...}}] }];
2323 * myContainer.compoundConfig = { renderer, children };
@@ -27,7 +27,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
2727 /**
2828 * If set to true defers from initializing the microfronted automatically. In that case init() can be used.
2929 * @since 1.0.0
30- *
30+ *
3131 * @example <luigi-container viewurl="/index.html" defer-init></luigi-container>
3232 * @example myContainer.deferInit = true
3333 */
@@ -36,8 +36,8 @@ export default class LuigiCompoundContainer extends HTMLElement {
3636 /**
3737 *
3838 * The locale to be passed to the compound micro frontend.
39- * @since NEXT_RELEASE_CONTAINER
40- *
39+ * @since 1.4.0
40+ *
4141 * @example <luigi-container locale="en_us"></luigi-container>
4242 * @example myContainer.locale = "en_us"
4343 */
@@ -46,7 +46,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
4646 /**
4747 * The parameters to be passed to the compound micro frontend. Will not be passed to the compound children.
4848 * @since 1.0.0
49- *
49+ *
5050 * @example <luigi-container viewurl="/index.html" node-params='{"node":"param"}'></luigi-container>
5151 * @example myContainer.nodeParams = {foo: bar}
5252 */
@@ -55,7 +55,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
5555 /**
5656 * If set to true, the Luigi compound container webcomponent will not use the shadow DOM for rendering.
5757 * @since 1.2.0
58- *
58+ *
5959 * @example <luigi-container viewurl="/index.html" no-shadow></luigi-container>
6060 * @example myContainer.noShadow = true
6161 */
@@ -64,7 +64,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
6464 /**
6565 * The search parameters to be passed to the compound micro frontend.
6666 * @since 1.0.0
67- *
67+ *
6868 * @example <luigi-container viewurl="/index.html" search-params='{"search":"param"}'></luigi-container>
6969 * @example myContainer.searchParams = {foo: bar}
7070 */
@@ -73,7 +73,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
7373 /**
7474 * The path parameters to be passed to the compound micro frontend.
7575 * @since 1.0.0
76- *
76+ *
7777 * @example <luigi-container viewurl="/index.html" path-params='{"path":"param"}'></luigi-container>
7878 * @example myContainer.pathParams = {foo: "bar"}
7979 */
@@ -82,7 +82,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
8282 /**
8383 * The stringified context to be passed to the compound microfrontend.
8484 * @since 1.0.0
85- *
85+ *
8686 * @example <luigi-container viewUrl="/index.html" context='{"label": "Dashboard"}'></luigi-container>
8787 * @example myContainer.context = {label: "Dashboard"}
8888 */
@@ -91,7 +91,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
9191 /**
9292 * The clientPermissions to be passed to the compound micro frontend.
9393 * @since 1.0.0
94- *
94+ *
9595 * @example <luigi-container viewurl="/index.html" client-permissions='{"permission": "adminGroup"}'></luigi-container>
9696 * @example myContainer.clientPermissions = {permission: "adminGroup"}
9797 */
@@ -100,7 +100,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
100100 /**
101101 * The user settings to be passed to the compound micro frontend.
102102 * @since 1.0.0
103- *
103+ *
104104 * @example <luigi-container viewurl="/index.html" user-settings='{"language": "de", "theme":"sap_horizon"}'></luigi-container>
105105 * @example myContainer.userSettings = {language: 'de', theme: 'sap_horizon'}
106106 */
@@ -109,7 +109,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
109109 /**
110110 * The anchor value to be passed to the compound micro frontend.
111111 * @since 1.0.0
112- *
112+ *
113113 * @example <luigi-container viewurl="/index.html" anchor='#foo'></luigi-container>
114114 * @example myContainer.anchor = '#foo'
115115 */
@@ -118,7 +118,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
118118 /**
119119 * The document title value to be passed to the compound micro frontend.
120120 * @since 1.2.0
121- *
121+ *
122122 * @example <luigi-container viewurl="/index.html" document-title='Luigi App'></luigi-container>
123123 * @example myContainer.documentTitle = 'Luigi App'
124124 */
@@ -128,7 +128,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
128128 * The hasBack value to be passed to the compound micro frontend.
129129 * It indicates that there is one or more preserved views. Useful when you need to show a back button.
130130 * @since 1.2.0
131- *
131+ *
132132 * @example <luigi-container viewurl="/index.html" has-back></luigi-container>
133133 * @example myContainer.hasBack = true
134134 */
@@ -138,7 +138,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
138138 * The dirty status value to be passed to the compound micro frontend.
139139 * It's used to indicate that there are unsaved changes when navigating away.
140140 * @since 1.2.0
141- *
141+ *
142142 * @example <luigi-container viewurl="/index.html" dirty-status></luigi-container>
143143 * @example myContainer.dirtyStatus = true
144144 */
@@ -152,36 +152,36 @@ export default class LuigiCompoundContainer extends HTMLElement {
152152 * @param {string } WebComponentSettings.tagName: tag name where web component is added to DOM.
153153 * @param {string } string must be a stringified JSON object from type `WebComponentSettings`.
154154 * @since 1.0.0
155- *
155+ *
156156 * @example <luigi-container webcomponent="{ type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}"></luigi-container>
157157 * @example myContainer.webcomponent = { type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}
158158 */
159159 webcomponent : boolean | WebComponentSettings | string ;
160160
161161 /**
162162 * If set to true, skips handshake and ready event is fired immediately.
163- * @since NEXT_RELEASE_CONTAINER
164- *
163+ * @since 1.4.0
164+ *
165165 * @example <luigi-container viewurl="/index.html" skipInitCheck></luigi-container>
166166 * @example myContainer.skipInitCheck = true
167167 */
168168 skipInitCheck : boolean ;
169169
170170 /**
171171 * The list of active feature toggles to be passed to the compound microfrontend.
172- * @since NEXT_RELEASE_CONTAINER
173- *
174- *
172+ * @since 1.4.0
173+ *
174+ *
175175 * @example <luigi-container viewUrl="/index.html" active-feature-toggle-list='["enable-foo", "allow-bar"]'></luigi-container>
176176 * @example myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"]
177177 */
178178 activeFeatureToggleList : string [ ] ;
179179
180180 /**
181181 * The theme to be passed to the compound microfrontend.
182- * @since NEXT_RELEASE_CONTAINER
183- *
184- *
182+ * @since 1.4.0
183+ *
184+ *
185185 * @example <luigi-container viewUrl="/index.html" theme='sap_horizon'></luigi-container>
186186 * @example myContainer.theme = 'sap_horizon'
187187 */
0 commit comments