Skip to content

Commit

Permalink
Merge branch 'main' into 3826-luigi-compound-container-cascading-context
Browse files Browse the repository at this point in the history
  • Loading branch information
walmazacn authored Jul 25, 2024
2 parents 9a5e862 + 26eca19 commit 1e1a78b
Show file tree
Hide file tree
Showing 9 changed files with 8,090 additions and 7,575 deletions.
1 change: 0 additions & 1 deletion container/typings/LuigiCompoundContainer.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 0 additions & 6 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 Down Expand Up @@ -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 Down
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
365 changes: 189 additions & 176 deletions docs/luigi-client-api.md

Large diffs are not rendered by default.

45 changes: 23 additions & 22 deletions docs/luigi-compound-container-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ meta -->

# Luigi Compound Container API

This document outlines the parameters provided by the Luigi Compound Container. Luigi Compound Container provides the possibility to insert multiple webcomponent-based microfrontends in one container
This document outlines the parameters provided by the Luigi Compound Container. Luigi Compound Container provides the possibility to insert multiple webcomponent-based microfrontends in one container

## API Reference

Expand All @@ -37,7 +37,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa

**Meta**

- **since**: 1.0.0
* **since**: 1.0.0

### deferInit

Expand All @@ -47,7 +47,7 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob

**Meta**

- **since**: 1.0.0
* **since**: 1.0.0

### noShadow

Expand All @@ -57,7 +57,7 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob

**Meta**

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

### searchParams

Expand All @@ -67,7 +67,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa

**Meta**

- **since**: 1.0.0
* **since**: 1.0.0

### pathParams

Expand All @@ -77,7 +77,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa

**Meta**

- **since**: 1.0.0
* **since**: 1.0.0

### context

Expand All @@ -87,7 +87,7 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa

**Meta**

- **since**: 1.0.0
* **since**: 1.0.0

### clientPermissions

Expand All @@ -97,7 +97,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa

**Meta**

- **since**: 1.0.0
* **since**: 1.0.0

### userSettings

Expand All @@ -107,7 +107,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa

**Meta**

- **since**: 1.0.0
* **since**: 1.0.0

### anchor

Expand All @@ -117,7 +117,7 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa

**Meta**

- **since**: 1.0.0
* **since**: 1.0.0

### documentTitle

Expand All @@ -127,7 +127,7 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa

**Meta**

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

### hasBack

Expand All @@ -138,7 +138,7 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa

**Meta**

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

### dirtyStatus

Expand All @@ -149,7 +149,7 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob

**Meta**

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

### webcomponent

Expand All @@ -159,23 +159,24 @@ Type: ([boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glo

#### Parameters

- `WebComponentSettings` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**
- `WebComponentSettings.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** : string, like module.
- `WebComponentSettings.selfRegistered` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** : if it is true, the web component bundle will be added via script tag.
- `WebComponentSettings.tagName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** : tag name where web component is added to DOM.
- `string` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** must be a stringified JSON object from type `WebComponentSettings`.
* `WebComponentSettings` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**

* `WebComponentSettings.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** : string, like module.
* `WebComponentSettings.selfRegistered` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** : if it is true, the web component bundle will be added via script tag.
* `WebComponentSettings.tagName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** : tag name where web component is added to DOM.
* `string` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** must be a stringified JSON object from type `WebComponentSettings`.

**Meta**

- **since**: 1.0.0
* **since**: 1.0.0

### updateContext

Function that updates the context of the compound microfrontend.

#### Parameters

- `contextObj` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The context data
* `contextObj` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The context data

#### Examples

Expand All @@ -187,7 +188,7 @@ Returns **void**

**Meta**

- **since**: 1.0.0
* **since**: 1.0.0

### init

Expand All @@ -197,4 +198,4 @@ Returns **void**

**Meta**

- **since**: 1.0.0
* **since**: 1.0.0
Loading

0 comments on commit 1e1a78b

Please sign in to comment.