Skip to content

Commit

Permalink
Merge branch 'main' into remove-ie-leftovers
Browse files Browse the repository at this point in the history
  • Loading branch information
JohannesDoberer committed Jul 25, 2024
2 parents 4cab8cd + 26eca19 commit 03f5f35
Show file tree
Hide file tree
Showing 8 changed files with 7,660 additions and 7,173 deletions.
9 changes: 4 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,6 @@ 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
20 changes: 7 additions & 13 deletions container/typings/LuigiContainer.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@ 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 +37,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 +72,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 +85,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 +122,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 +141,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 +157,6 @@ 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 +167,6 @@ 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 +177,6 @@ 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 +185,6 @@ 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 +195,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;
}
3 changes: 1 addition & 2 deletions core/src/core-api/i18n.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,7 @@ class LuigiI18NManager {
* Property values for token replacement in the localization key will be taken from the specified interpolations object.
*
* <!-- add-attribute:class:success -->
* > **TIP**: Be aware that this function is not asynchronous and therefore the translation table must be existing already at initialization.
* Take a look at our [i18n](i18n.md) section for an implementation suggestion.
* > **TIP**: Be aware that this function is not asynchronous and therefore the translation table must be existing already at initialization. Take a look at our [i18n](i18n.md) section for an implementation suggestion.
*
* @param {string} key key to be translated
* @param {Object} interpolations objects with properties that will be used for token replacements in the localization key
Expand Down
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 @@ -149,7 +149,7 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob

**Meta**

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

### searchParams

Expand Down
4 changes: 1 addition & 3 deletions docs/luigi-core-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -887,9 +887,7 @@ Property values for token replacement in the localization key will be taken from

<!-- add-attribute:class:success -->

> **TIP**: Be aware that this function is not asynchronous and therefore the translation table must be existing already at initialization.
Take a look at our [i18n](i18n.md) section for an implementation suggestion.
> **TIP**: Be aware that this function is not asynchronous and therefore the translation table must be existing already at initialization. Take a look at our [i18n](i18n.md) section for an implementation suggestion.
##### Parameters

Expand Down
Loading

0 comments on commit 03f5f35

Please sign in to comment.