From 31628ac7a42165f8cf2788017df2497e670224c1 Mon Sep 17 00:00:00 2001 From: Ndricim Date: Thu, 25 Jul 2024 14:19:45 +0200 Subject: [PATCH] Fix docu missing Since tags (#3830) --- .../LuigiCompoundContainer.svelte.d.ts | 10 +++---- container/typings/LuigiContainer.svelte.d.ts | 26 +++++++++---------- docs/luigi-compound-container-api.md | 2 +- docs/luigi-container-api.md | 2 +- docs/luigi-core-api.md | 4 +++ 5 files changed, 24 insertions(+), 20 deletions(-) diff --git a/container/typings/LuigiCompoundContainer.svelte.d.ts b/container/typings/LuigiCompoundContainer.svelte.d.ts index 66a227fa0d..ce7234c4d9 100644 --- a/container/typings/LuigiCompoundContainer.svelte.d.ts +++ b/container/typings/LuigiCompoundContainer.svelte.d.ts @@ -12,9 +12,9 @@ export default class LuigiCompoundContainer extends HTMLElement { /** * 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. + * Take a look at the [compound parameter](https://docs.luigi-project.io/docs/navigation-parameters-reference/?section=compound) for details. * @since 1.0.0 - * + * */ compoundConfig: Object; @@ -26,7 +26,7 @@ export default class LuigiCompoundContainer extends HTMLElement { /** * If set to true, the Luigi compound container webcomponent will not use the shadow DOM for rendering. - * @since NEXTRELEASE + * @since NEXT_RELEASE_CONTAINER */ noShadow: boolean; @@ -74,7 +74,7 @@ export default class LuigiCompoundContainer extends HTMLElement { /** * 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. + * It indicates that there is one or more preserved views. Useful when you need to show a back button. * @since NEXT_RELEASE_CONTAINER */ hasBack: string; @@ -100,7 +100,7 @@ export default class LuigiCompoundContainer extends HTMLElement { /** * Function that updates the context of the compound microfrontend. * @param contextObj The context data - * + * * @example * containerElement.updateContext({newContextData: 'some data'}) * @since 1.0.0 diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 0f35193215..4a0e63a76f 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -7,14 +7,14 @@ export declare interface WebComponentSettings { export default class LuigiContainer extends HTMLElement { /** * The URL of the microfrontend to be rendered - * + * * @since 1.0.0 */ viewurl: string; /** * If set to true defers from initializing the microfronted automatically. In that case init() can be used - * + * * @since 1.0.0 */ deferInit: boolean; @@ -39,7 +39,7 @@ export default class LuigiContainer extends HTMLElement { * @param {boolean} WebComponentSettings.selfRegistered: if it is true, the web component bundle will be added via script tag. * @param {string} WebComponentSettings.tagName: tag name where web component is added to DOM. * @param {string} string must be a stringified boolean or JSON object from type `WebComponentSettings`. - * + * *

*
*

@@ -74,7 +74,7 @@ export default class LuigiContainer extends HTMLElement { activeFeatureToggleList: string[]; /** - * If set to true, skips handshake and ready event is fired immediately + * If set to true, skips handshake and ready event is fired immediately * @since 1.0.0 */ skipInitCheck: boolean; @@ -87,7 +87,7 @@ export default class LuigiContainer extends HTMLElement { /** * If set to true, the Luigi container webcomponent will not use the shadow DOM for rendering. - * @since NEXTRELEASE + * @since NEXT_RELEASE_CONTAINER */ noShadow: boolean; @@ -124,14 +124,14 @@ export default class LuigiContainer extends HTMLElement { /** * 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"]. - * @since NEXT_RELEASE_CONTAINER + * @since NEXT_RELEASE_CONTAINER */ allowRules: string[]; /** * 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, for example sandboxRules: ["allow-scripts", "allow-same-origin"]. - * @since NEXT_RELEASE_CONTAINER + * @since NEXT_RELEASE_CONTAINER */ sandboxRules: string[]; @@ -143,7 +143,7 @@ export default class LuigiContainer extends HTMLElement { /** * 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. + * It indicates that there is one or more preserved views. Useful when you need to show a back button. * @since NEXT_RELEASE_CONTAINER */ hasBack: string; @@ -159,7 +159,7 @@ export default class LuigiContainer extends HTMLElement { * Function that updates the context of the microfrontend * @param {Object} contextObj The context data * @param {Object} internal internal luigi legacy data used for iframes - * + * * @example * containerElement.updateContext({newContextData: 'some data'}) * @since 1.0.0 @@ -170,7 +170,7 @@ export default class LuigiContainer extends HTMLElement { * Send a custom message to the microfronted * @param id a string containing the message id * @param data data to be sent alongside the custom message - * + * * @example * containerElement.sendCustomMessage('my-message-id', {dataToSend: 'some data'}) * @since 1.0.0 @@ -181,7 +181,7 @@ export default class LuigiContainer extends HTMLElement { * A function that notifies the microfrontend that the opened alert has been closed * @param id the id of the opened alert * @param dismissKey the key specifying which dismiss link was clicked on the alert message - * + * * @example * containerElement.closeAlert('my-alert-id', 'my-dismiss-key') * @since 1.0.0 @@ -190,7 +190,7 @@ export default class LuigiContainer extends HTMLElement { /** * Manually triggers the micro frontend rendering process when using defer-init attribute - * + * * @example * containerElement.init() * @since 1.0.0 @@ -201,5 +201,5 @@ export default class LuigiContainer extends HTMLElement { * The authData value to be passed to the iframe-based micro frontend. * @since NEXT_RELEASE_CONTAINER */ - authData: Object; + authData: Object; } diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index c4159addbf..0467395fee 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -57,7 +57,7 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob **Meta** -- **since**: NEXTRELEASE +- **since**: NEXT_RELEASE_CONTAINER ### searchParams diff --git a/docs/luigi-container-api.md b/docs/luigi-container-api.md index 1a4bff43c5..1c00758e51 100644 --- a/docs/luigi-container-api.md +++ b/docs/luigi-container-api.md @@ -148,7 +148,7 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob **Meta** -- **since**: NEXTRELEASE +- **since**: NEXT_RELEASE_CONTAINER ### searchParams diff --git a/docs/luigi-core-api.md b/docs/luigi-core-api.md index bf9ec3c8c8..a730a692ad 100644 --- a/docs/luigi-core-api.md +++ b/docs/luigi-core-api.md @@ -603,6 +603,10 @@ Luigi.navigation().navigateToIntent('Sales-settings') Luigi.navigation().navigateToIntent('Sales-settings', {project: 'pr1'}) ``` +**Meta** + +- **since**: NEXTRELEASE + #### openAsModal Opens a view in a modal. You can specify the modal's title and size. If you do not specify the title, it is the node label. If there is no node label, the title remains empty. The default size of the modal is `l`, which means 80%. You can also use `m` (60%) and `s` (40%) to set the modal size. Optionally, use it in combination with any of the navigation functions.