fix(internet-header): Trap focus is not working on overlays and missi…

…ng in search overlay (#2922) Co-authored-by: Philipp Gfeller <philipp.gfeller@post.ch>
swisspost · Jun 3, 2024 · 9cd1f9a · 9cd1f9a
1 parent 0a33535
commit 9cd1f9a
Show file tree

Hide file tree

Showing 16 changed files with 477 additions and 250 deletions.
diff --git a/.changeset/spicy-nails-fix.md b/.changeset/spicy-nails-fix.md
@@ -0,0 +1,6 @@
+---
+'@swisspost/internet-header': patch
+---
+
+Fixed focus trap on overlay of the breadcrumb.
+Added a focus trap on search overlay
diff --git a/packages/internet-header/cypress/e2e/breadcrumbs.cy.ts b/packages/internet-header/cypress/e2e/breadcrumbs.cy.ts
@@ -14,8 +14,8 @@ describe('breadcrumb', () => {
     cy.get('@breadcrumbs')
       .find('div.overlay')
       .should('exist')
-      .find('div.overlay-container')
-      .should('have.class', 'loaded');
+      .find('[role=dialog].loaded', { timeout: 30000 })
+      .should('exist');
 
     cy.get('@breadcrumbs')
       .find('div.overlay')

diff --git a/packages/internet-header/cypress/e2e/header.cy.ts b/packages/internet-header/cypress/e2e/header.cy.ts
@@ -9,7 +9,7 @@ describe('header', () => {
 
   context('initial state', () => {
     it('renders', () => {
-      cy.get('swisspost-internet-header').should('have.class', 'hydrated');
+      cy.get('swisspost-internet-header', { timeout: 30000 }).should('have.class', 'hydrated');
     });
 
     it(`has nav item 'Briefe versenden' selected`, () => {

diff --git a/packages/internet-header/package.json b/packages/internet-header/package.json
@@ -27,7 +27,7 @@
     "loader/"
   ],
   "scripts": {
-    "dev": "stencil build --serve --port 9310 --watch --docs-readme",
+    "dev": "stencil build --serve --port 9310 --watch --docs-readme --dev",
     "start": "stencil build --watch --docs-readme",
     "build": "stencil build --docs-readme",
     "clean": "rimraf www dist loader",
@@ -46,7 +46,6 @@
     "body-scroll-lock": "4.0.0-beta.0",
     "iframe-resizer": "4.3.11",
     "jquery": "3.7.1",
-    "tabbable": "6.2.0",
     "throttle-debounce": "5.0.0",
     "url-polyfill": "1.1.12"
   },
@@ -71,6 +70,7 @@
     "cypress-storybook": "0.5.1",
     "eslint": "8.57.0",
     "eslint-plugin-react": "7.34.1",
+    "focus-trap": "7.5.4",
     "globby": "14.0.1",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",

diff --git a/packages/internet-header/src/components.d.ts b/packages/internet-header/src/components.d.ts
@@ -18,6 +18,13 @@ export { StickynessOptions } from "./models/implementor.model";
 export { Environment, ICustomConfig } from "./models/general.model";
 export { IAvailableLanguage } from "./models/language.model";
 export namespace Components {
+    /**
+     * Trap the focus inside a specific container.
+     * @param active activate or deactivate the focus trap
+     */
+    interface FocusTrap {
+        "active": boolean;
+    }
     interface PostKlpLoginWidget {
         /**
           * Override the logout-url provided by the portal config.
@@ -193,6 +200,16 @@ export interface SwisspostInternetHeaderCustomEvent<T> extends CustomEvent<T> {
     target: HTMLSwisspostInternetHeaderElement;
 }
 declare global {
+    /**
+     * Trap the focus inside a specific container.
+     * @param active activate or deactivate the focus trap
+     */
+    interface HTMLFocusTrapElement extends Components.FocusTrap, HTMLStencilElement {
+    }
+    var HTMLFocusTrapElement: {
+        prototype: HTMLFocusTrapElement;
+        new (): HTMLFocusTrapElement;
+    };
     interface HTMLPostKlpLoginWidgetElement extends Components.PostKlpLoginWidget, HTMLStencilElement {
     }
     var HTMLPostKlpLoginWidgetElement: {
@@ -300,6 +317,7 @@ declare global {
         new (): HTMLSwisspostInternetHeaderElement;
     };
     interface HTMLElementTagNameMap {
+        "focus-trap": HTMLFocusTrapElement;
         "post-klp-login-widget": HTMLPostKlpLoginWidgetElement;
         "post-language-switch": HTMLPostLanguageSwitchElement;
         "post-logo": HTMLPostLogoElement;
@@ -313,6 +331,13 @@ declare global {
     }
 }
 declare namespace LocalJSX {
+    /**
+     * Trap the focus inside a specific container.
+     * @param active activate or deactivate the focus trap
+     */
+    interface FocusTrap {
+        "active"?: boolean;
+    }
     interface PostKlpLoginWidget {
         /**
           * Override the logout-url provided by the portal config.
@@ -450,6 +475,7 @@ declare namespace LocalJSX {
         "stickyness"?: StickynessOptions;
     }
     interface IntrinsicElements {
+        "focus-trap": FocusTrap;
         "post-klp-login-widget": PostKlpLoginWidget;
         "post-language-switch": PostLanguageSwitch;
         "post-logo": PostLogo;
@@ -466,6 +492,11 @@ export { LocalJSX as JSX };
 declare module "@stencil/core" {
     export namespace JSX {
         interface IntrinsicElements {
+            /**
+             * Trap the focus inside a specific container.
+             * @param active activate or deactivate the focus trap
+             */
+            "focus-trap": LocalJSX.FocusTrap & JSXBase.HTMLAttributes<HTMLFocusTrapElement>;
             "post-klp-login-widget": LocalJSX.PostKlpLoginWidget & JSXBase.HTMLAttributes<HTMLPostKlpLoginWidgetElement>;
             "post-language-switch": LocalJSX.PostLanguageSwitch & JSXBase.HTMLAttributes<HTMLPostLanguageSwitchElement>;
             "post-logo": LocalJSX.PostLogo & JSXBase.HTMLAttributes<HTMLPostLogoElement>;

diff --git a/...ernet-header/src/components/post-internet-breadcrumbs/components/focus-trap.component.tsx b/...ernet-header/src/components/post-internet-breadcrumbs/components/focus-trap.component.tsx
diff --git a/...internet-header/src/components/post-internet-breadcrumbs/components/overlay.component.tsx b/...internet-header/src/components/post-internet-breadcrumbs/components/overlay.component.tsx
@@ -1,7 +1,6 @@
 import { h } from '@stencil/core';
 import { SvgIcon } from '../../../utils/svg-icon.component';
 import { IBreadcrumbOverlay } from '../../../models/breadcrumbs.model';
-import { FocusTrap } from './focus-trap.component';
 
 /**
  * Overlay implementation with focus trap according to
@@ -25,13 +24,8 @@ export const OverlayComponent = (props: {
     ref={e => e !== undefined && props.overlayRef(e)}
   >
     <div class="container" role="dialog">
-      <FocusTrap>
-        <div
-          class="overlay-container"
-          tabindex="-1" /* For initial focus */
-          role="document"
-          onClick={e => e.stopPropagation()}
-        >
+      <focus-trap active={true}>
+        <div class="overlay-container" role="document" onClick={e => e.stopPropagation()}>
           <button
             class={`overlay-close btn-blank d-inline-flex align-items-center nav-link ${props.overlay.id}`}
             onClick={() => props.onClick()}
@@ -46,7 +40,7 @@ export const OverlayComponent = (props: {
             ref={e => e !== undefined && props.iFrameRef(e)}
           ></iframe>
         </div>
-      </FocusTrap>
+      </focus-trap>
       <div class="loader-wrapper">
         <div class="loader"></div>
       </div>

diff --git a/...s/internet-header/src/components/post-internet-breadcrumbs/post-internet-breadcrumbs.scss b/...s/internet-header/src/components/post-internet-breadcrumbs/post-internet-breadcrumbs.scss
@@ -171,7 +171,6 @@
   position: relative;
   background: white;
   box-shadow: 0 0 40px rgba(0, 0, 0, 0.6);
-  visibility: hidden;
   transform: translateY(3rem);
   opacity: 0;
   transition: transform 500ms, opacity 500ms;
@@ -223,10 +222,10 @@ iframe {
   height: 100%;
   top: 0;
   left: 0;
+}
 
-  .loaded ~ & {
-    display: none;
-  }
+.loaded .loader-wrapper {
+  display:none;
 }
 
 .hidden-control-breadcrumbs {

diff --git a/...es/internet-header/src/components/post-internet-breadcrumbs/post-internet-breadcrumbs.tsx b/...es/internet-header/src/components/post-internet-breadcrumbs/post-internet-breadcrumbs.tsx
@@ -194,7 +194,7 @@ export class PostInternetBreadcrumbs {
         [{ opacity: 1, visibility: 'visible', transform: 'translateY(0px)' }],
         { duration, fill: 'forwards' },
       );
-      iFrame.parentElement?.classList.add('loaded');
+      iFrame.closest('[role=dialog]')?.classList.add('loaded');
       this.loadedAnimation?.finished.then(() => {
         iFrame.parentElement?.focus();
       });

diff --git a/packages/internet-header/src/components/post-internet-breadcrumbs/readme.md b/packages/internet-header/src/components/post-internet-breadcrumbs/readme.md
@@ -32,6 +32,19 @@ Type: `Promise<void>`
 
 
 
+## Dependencies
+
+### Depends on
+
+- [focus-trap](../shared)
+
+### Graph
+```mermaid
+graph TD;
+  swisspost-internet-breadcrumbs --> focus-trap
+  style swisspost-internet-breadcrumbs fill:#f9f,stroke:#333,stroke-width:4px
+```
+
 ----------------------------------------------
 
 *Built with [StencilJS](https://stenciljs.com/)*
diff --git a/packages/internet-header/src/components/post-internet-header/readme.md b/packages/internet-header/src/components/post-internet-header/readme.md
@@ -70,6 +70,7 @@ graph TD;
   swisspost-internet-header --> post-main-navigation
   swisspost-internet-header --> post-search
   swisspost-internet-header --> post-klp-login-widget
+  post-search --> focus-trap
   style swisspost-internet-header fill:#f9f,stroke:#333,stroke-width:4px
 ```