Add locale prop to Compound Container (#3935)

SAP · Sep 30, 2024 · c54dda8 · c54dda8
1 parent f0956a2
commit c54dda8
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 0 deletions.
diff --git a/container/cypress/e2e/test-app/compound/wc-compound-container.cy.js b/container/cypress/e2e/test-app/compound/wc-compound-container.cy.js
@@ -32,6 +32,18 @@ describe('Compound Container Tests', () => {
         });
     });
 
+    it('LuigiClient API - getCurrentLocale', () => {
+      cy.on('window:alert', stub);
+
+      cy.get(containerSelector)
+        .shadow()
+        .contains('getCurrentLocale')
+        .click()
+        .then(() => {
+          expect(stub.getCall(0)).to.be.calledWith('LuigiClient.getCurrentLocale()=en');
+        });
+    });
+
     it('LuigiClient API - getDirtyStatus', () => {
       cy.on('window:alert', stub);
 

diff --git a/container/src/LuigiCompoundContainer.svelte b/container/src/LuigiCompoundContainer.svelte
@@ -20,6 +20,7 @@
       dirtyStatus: { type: 'Boolean', reflect: false, attribute: 'dirty-status'},
       documentTitle: {type: 'String', reflect: false, attribute: 'document-title'},
       hasBack: { type: 'Boolean', reflect: false, attribute: 'has-back'},
+      locale: { type: 'String', reflect: false, attribute: 'locale' },
       noShadow: { type: 'Boolean', attribute: 'no-shadow', reflect: false },
       nodeParams: { type: 'Object', reflect: false, attribute: 'node-params' },
       pathParams: { type: 'Object', reflect: false, attribute: 'path-params' },
@@ -75,6 +76,7 @@
   export let dirtyStatus: boolean;
   export let documentTitle: string;
   export let hasBack: boolean;
+  export let locale: string;
   export let noShadow: boolean;
   export let nodeParams: any;
   export let pathParams: any;
@@ -100,6 +102,7 @@
       dirtyStatus &&
       documentTitle &&
       hasBack &&
+      locale &&
       noShadow &&
       nodeParams &&
       pathParams &&

diff --git a/container/test-app/compound/compoundClientAPI.html b/container/test-app/compound/compoundClientAPI.html
@@ -37,6 +37,7 @@ <h3>
         defer-init="false"
         webcomponent="true"
         theme="sap_fiori_3"
+        locale="en"
       ></luigi-compound-container>
     </div>
 

diff --git a/container/test-app/compound/helloWorldWC.js b/container/test-app/compound/helloWorldWC.js
@@ -13,6 +13,9 @@ export default class extends HTMLElement {
     const templateBtn = document.createElement('template');
     templateBtn.innerHTML = '<button id="aButton">Click me!</button>';
 
+    const current_locale = document.createElement('template');
+    current_locale.innerHTML = '<button id="current_locale">getCurrentLocale</button>';
+
     const templateBtn2 = document.createElement('template');
     templateBtn2.innerHTML = '<button class="button2">Publish event</button>';
 
@@ -112,10 +115,22 @@ export default class extends HTMLElement {
     this._shadowRoot.appendChild(linkManagerOpenAsRequestsBtn.content.cloneNode(true));
     this._shadowRoot.appendChild(linkManagerUpdateTopPathExistsBackBtn.content.cloneNode(true));
     this._shadowRoot.appendChild(setViewGroupDataBtn.content.cloneNode(true));
+    this._shadowRoot.appendChild(current_locale.content.cloneNode(true));
 
     this._shadowRoot.appendChild(empty.content.cloneNode(true));
 
+    this.$currentLocaleButton = this._shadowRoot.querySelector('#current_locale');
+    this.$currentLocaleButton.addEventListener('click', () => {
+      if (this.LuigiClient) {
+        this.LuigiClient.uxManager().showAlert({
+          text: 'LuigiClient.getCurrentLocale()=' + this.LuigiClient.getCurrentLocale(),
+          type: 'info'
+        });
+      }
+    });
+
     this.$paragraph = this._shadowRoot.querySelector('p');
+
     this.$button = this._shadowRoot.querySelector('#aButton');
     this.$button.addEventListener('click', () => {
       if (this.LuigiClient) {

diff --git a/container/typings/LuigiCompoundContainer.svelte.d.ts b/container/typings/LuigiCompoundContainer.svelte.d.ts
@@ -24,6 +24,13 @@ export default class LuigiCompoundContainer extends HTMLElement {
    */
   deferInit: boolean;
 
+  /**
+   *
+   * The locale to be passed to the compound micro frontend.
+   * @since NEXT_RELEASE_CONTAINER
+   */
+  locale: string;
+
   /**
    * The parameters to be passed to the compound micro frontend. Will not be passed to the compound children.
    * @since 1.0.0

diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md
@@ -49,6 +49,16 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob
 
 *   **since**: 1.0.0
 
+### locale
+
+The locale to be passed to the compound micro frontend.
+
+Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+**Meta**
+
+*   **since**: NEXT_RELEASE_CONTAINER
+
 ### nodeParams
 
 The parameters to be passed to the compound micro frontend. Will not be passed to the compound children.