Skip to content

Commit

Permalink
Fix docu missing Since tags (#3830)
Browse files Browse the repository at this point in the history
  • Loading branch information
ndricimrr authored Jul 25, 2024
1 parent 47e51e5 commit 31628ac
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 20 deletions.
10 changes: 5 additions & 5 deletions container/typings/LuigiCompoundContainer.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -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;

Expand Down Expand Up @@ -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;
Expand All @@ -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
Expand Down
26 changes: 13 additions & 13 deletions container/typings/LuigiContainer.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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`.
*
*
* </br></br>
* <blockquote class="warning">
* <p>
Expand Down Expand Up @@ -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;
Expand All @@ -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;

Expand Down Expand Up @@ -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[];

Expand All @@ -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;
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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;
}
2 changes: 1 addition & 1 deletion docs/luigi-compound-container-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob

**Meta**

- **since**: NEXTRELEASE
- **since**: NEXT_RELEASE_CONTAINER

### searchParams

Expand Down
2 changes: 1 addition & 1 deletion docs/luigi-container-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob

**Meta**

- **since**: NEXTRELEASE
- **since**: NEXT_RELEASE_CONTAINER

### searchParams

Expand Down
4 changes: 4 additions & 0 deletions docs/luigi-core-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 31628ac

Please sign in to comment.