@orangesk/orange-design-system 2.0.0-beta.36 → 2.0.0-beta.38

package/src/components/Tile/tests/Tile.conformance.test.jsx

@@ -1,5 +1,5 @@
 import { render } from "@testing-library/react";
-import { axe } from 'vitest-axe';
+import { axe } from "vitest-axe";
 
 import { Tile } from "../";
 

package/src/components/Tooltip/InfoTooltip.tsx

@@ -1,7 +1,7 @@
 "use client";
 
-import React from "react";
 import cx from "classnames";
+import React from "react";
 
 import { Icon } from "../Icon";
 import { Tooltip, TooltipProps } from "./Tooltip";

package/src/components/Tooltip/Tooltip.static.ts

@@ -1,7 +1,11 @@
-import { createPopper, Instance as PopperInstance, Options as PopperOptions } from '@popperjs/core';
-import { transitionHiddenElement } from '@cloudfour/transition-hidden-element';
+import { transitionHiddenElement } from "@cloudfour/transition-hidden-element";
+import {
+  createPopper,
+  Instance as PopperInstance,
+  Options as PopperOptions,
+} from "@popperjs/core";
 
-import { keys } from '../../utils';
+import { keys } from "../../utils";
 
 export interface TooltipConfig {
   rootContainerSelector: string;
@@ -10,39 +14,39 @@ export interface TooltipConfig {
 }
 
 export const defaultConfig: TooltipConfig = {
-  rootContainerSelector: '#root-tooltips',
+  rootContainerSelector: "#root-tooltips",
   removeDialogOnDestroy: false,
   popperOptions: {
-    placement: 'bottom',
-    strategy: 'absolute',
+    placement: "bottom",
+    strategy: "absolute",
     modifiers: [
       {
-        name: 'arrow',
+        name: "arrow",
         options: {
-          element: '.tooltip__arrow',
+          element: ".tooltip__arrow",
           padding: 10,
         },
       },
       {
-        name: 'eventListeners',
+        name: "eventListeners",
         options: {
           scroll: false,
           resize: false,
         },
       },
       {
-        name: 'flip',
+        name: "flip",
         options: {
-          fallbackPlacements: ['right', 'top', 'auto'],
+          fallbackPlacements: ["right", "top", "auto"],
         },
       },
       {
-        name: 'offset',
+        name: "offset",
         options: {
           offset: ({ placement }: { placement: string }) => {
-            if (placement.includes('start')) {
+            if (placement.includes("start")) {
               return [-10, 0];
-            } else if (placement.includes('end')) {
+            } else if (placement.includes("end")) {
               return [10, 0];
             }
             return [0, 0];
@@ -60,6 +64,8 @@ export default class Tooltip {
   public trigger!: HTMLElement;
   public rootContainer?: HTMLElement | null;
   public transitioner: any;
+  private isOpen = false;
+  private ignoreNextBlur = false;
 
   constructor(element: HTMLElement, config?: Partial<TooltipConfig>) {
     this.element = element;
@@ -75,6 +81,8 @@ export default class Tooltip {
 
     this.handleVisibility = this.handleVisibility.bind(this);
     this.onKeydown = this.onKeydown.bind(this);
+    this.onDialogMouseDown = this.onDialogMouseDown.bind(this);
+    this.onDocumentClick = this.onDocumentClick.bind(this);
 
     (this.element as any).ODS_Tooltip = this;
 
@@ -88,111 +96,136 @@ export default class Tooltip {
   }
 
   wrapLastWordAndButton(): void {
-    if (!this.element.hasAttribute('data-tooltip-keep-with-text')) return;
+    if (!this.element.hasAttribute("data-tooltip-keep-with-text")) return;
     const previousSibling = this.trigger.previousSibling;
     if (!previousSibling || previousSibling.nodeType !== Node.TEXT_NODE) {
-      console.warn('Previous sibling is not a text node.');
+      console.warn("Previous sibling is not a text node.");
       return;
     }
-    const textContent = previousSibling.textContent?.trim() || '';
-    const words = textContent.split(' ');
+    const textContent = previousSibling.textContent?.trim() || "";
+    const words = textContent.split(" ");
     const lastWord = words.pop();
-    const updatedTextContent = words.join(' ');
-    previousSibling.textContent = updatedTextContent + ' ';
-    const span = document.createElement('span');
-    span.className = 'text-nowrap';
+    const updatedTextContent = words.join(" ");
+    previousSibling.textContent = updatedTextContent + " ";
+    const span = document.createElement("span");
+    span.className = "text-nowrap";
     span.innerHTML = `${lastWord} ${this.trigger.outerHTML}`;
     this.trigger.parentNode?.replaceChild(span, this.trigger);
-    this.trigger = span.querySelector('[data-tooltip-trigger]') as HTMLElement;
+    this.trigger = span.querySelector("[data-tooltip-trigger]") as HTMLElement;
   }
 
   private init(): void {
     this.trigger = document.querySelector(
-      `[data-tooltip-trigger][aria-describedby=${this.element.getAttribute('id')}]`
+      `[data-tooltip-trigger][aria-describedby=${this.element.getAttribute("id")}]`,
     ) as HTMLElement;
     if (!this.trigger) {
       console.warn(
-        `tooltip trigger element is not defined and the tooltip cannot be attached. Please provide an element with [aria-describedby=${this.element.getAttribute('id')}]`
+        `tooltip trigger element is not defined and the tooltip cannot be attached. Please provide an element with [aria-describedby=${this.element.getAttribute("id")}]`,
       );
     }
-    if (this.element.hasAttribute('data-tooltip-keep-with-text')) {
+    if (this.element.hasAttribute("data-tooltip-keep-with-text")) {
       this.wrapLastWordAndButton();
     }
-    this.rootContainer = document.querySelector(this.config.rootContainerSelector);
+    this.rootContainer = document.querySelector(
+      this.config.rootContainerSelector,
+    );
     if (this.rootContainer) {
       this.rootContainer.appendChild(this.element);
     } else {
       console.warn(
-        'rootContainer element is not defined. Tooltips will be placed inside content which can affect positioning. Please provide rootContainer element (should be placed outside of main content, usually in end of <body /> tag)'
+        "rootContainer element is not defined. Tooltips will be placed inside content which can affect positioning. Please provide rootContainer element (should be placed outside of main content, usually in end of <body /> tag)",
       );
     }
-    const customPlacement = this.element.getAttribute('data-tooltip-placement');
+    const customPlacement = this.element.getAttribute("data-tooltip-placement");
     if (customPlacement) {
       this.config.popperOptions.placement = customPlacement as any;
     }
     this.instance = createPopper(
       this.trigger,
       this.element,
-      this.config.popperOptions
+      this.config.popperOptions,
     );
     this.transitioner = transitionHiddenElement({
       element: this.element,
-      visibleClass: 'is-visible',
+      visibleClass: "is-visible",
     });
-    this.trigger.addEventListener('mouseenter', this.handleVisibility);
-    this.trigger.addEventListener('mouseleave', this.handleVisibility);
-    this.trigger.addEventListener('focus', this.handleVisibility);
-    this.trigger.addEventListener('blur', this.handleVisibility);
+    this.element.addEventListener("mousedown", this.onDialogMouseDown);
+    this.trigger.addEventListener("click", this.handleVisibility);
+    this.trigger.addEventListener("keydown", this.handleVisibility);
+    this.trigger.addEventListener("blur", this.handleVisibility);
   }
 
-  private handleVisibility(e: Event): void {
-    if (e.type === 'mouseenter' || e.type === 'focus') {
-      this.show();
-    }
-    if (e.type === 'blur') {
-      this.hide();
+  private onDialogMouseDown(): void {
+    this.ignoreNextBlur = true;
+  }
+
+  private onDocumentClick(e: MouseEvent): void {
+    const target = e.target as Node | null;
+
+    if (!target) {
+      return;
     }
-    if (e.type === 'mouseleave') {
-      const shouldClose = this.shouldClose(e as MouseEvent);
-      if (shouldClose) {
-        this.hide();
-      }
+
+    if (this.trigger.contains(target) || this.element.contains(target)) {
+      return;
     }
+
+    this.hide();
   }
 
-  private shouldClose(e: MouseEvent): boolean {
-    const mouseLeftTo = (e as any).relatedreference || (e as any).toElement || (e as any).relatedTarget;
-    const callback = (e2: MouseEvent) => {
-      const mouseLeftTo2 = (e2 as any).relatedreference || (e2 as any).toElement || (e2 as any).relatedTarget;
-      this.element.removeEventListener('mouseleave', callback);
-      if (!this.trigger.contains(mouseLeftTo2)) {
-        this.hide();
+  private handleVisibility(e: Event): void {
+    if (e.type === "click") {
+      this.toggle();
+      return;
+    }
+    if (e.type === "keydown") {
+      this.onKeydown(e as KeyboardEvent);
+      return;
+    }
+    if (e.type === "blur") {
+      if (this.ignoreNextBlur) {
+        this.ignoreNextBlur = false;
+        return;
       }
-    };
-    if (this.element.contains(mouseLeftTo)) {
-      this.element.addEventListener('mouseleave', callback);
-      return false;
+      this.hide();
     }
-    return true;
   }
 
   private onKeydown(e: KeyboardEvent): void {
+    if (
+      (e.key === "Enter" || e.key === " ") &&
+      this.trigger.tagName !== "BUTTON"
+    ) {
+      e.preventDefault();
+      this.toggle();
+      return;
+    }
     if (keys.ESC.includes(e.key)) {
       this.hide();
     }
   }
 
+  private toggle(): void {
+    if (this.isOpen) {
+      this.hide();
+    } else {
+      this.show();
+    }
+  }
+
   public show(): void {
     this.transitioner.show();
-    this.trigger.classList.add('is-active');
+    this.trigger.classList.add("is-active");
+    this.isOpen = true;
     this.instance.forceUpdate();
-    document.addEventListener('keydown', this.onKeydown);
+    document.addEventListener("click", this.onDocumentClick);
   }
 
   public hide(): void {
     this.transitioner.hide();
-    this.trigger.classList.remove('is-active');
-    document.removeEventListener('keydown', this.onKeydown);
+    this.trigger.classList.remove("is-active");
+    this.isOpen = false;
+    document.removeEventListener("click", this.onDocumentClick);
   }
 
   public update(): void {
@@ -200,10 +233,11 @@ export default class Tooltip {
   }
 
   public destroy(): void {
-    this.trigger.removeEventListener('mouseenter', this.handleVisibility);
-    this.trigger.removeEventListener('mouseleave', this.handleVisibility);
-    this.trigger.removeEventListener('focus', this.handleVisibility);
-    this.trigger.removeEventListener('blur', this.handleVisibility);
+    this.element.removeEventListener("mousedown", this.onDialogMouseDown);
+    this.trigger.removeEventListener("click", this.handleVisibility);
+    this.trigger.removeEventListener("keydown", this.handleVisibility);
+    this.trigger.removeEventListener("blur", this.handleVisibility);
+    document.removeEventListener("click", this.onDocumentClick);
     this.instance.destroy();
     (this.element as any).ODS_Tooltip = null;
     if (this.config.removeDialogOnDestroy) {

package/src/components/Tooltip/Tooltip.tsx

@@ -1,10 +1,9 @@
 "use client";
 
-import React from "react";
 import cx from "classnames";
-
-import TooltipStatic from "./Tooltip.static";
+import React from "react";
 import { useHydrationSafeId, useStatic } from "../../utils/hooks";
+import TooltipStatic from "./Tooltip.static";
 
 const CLASS_ROOT = "tooltip";
 

package/src/components/Tooltip/index.ts

@@ -1,2 +1,2 @@
-export { Tooltip } from "./Tooltip";
 export { InfoTooltip } from "./InfoTooltip";
+export { Tooltip } from "./Tooltip";

package/src/components/Tooltip/styles/mixins.scss

@@ -1,9 +1,9 @@
-@use 'sass:math' as math;
-@use '../../../styles/tokens/base';
-@use '../../../styles/tools/generate';
-@use '../../../styles/tools/convert';
-@use '../../../styles/tools/layout';
-@use './config';
+@use "sass:math" as math;
+@use "../../../styles/tokens/base";
+@use "../../../styles/tools/generate";
+@use "../../../styles/tools/convert";
+@use "../../../styles/tools/layout";
+@use "./config";
 
 @mixin tooltip($config: config.$layout, $offset: config.$offset) {
   position: absolute;
@@ -18,7 +18,7 @@
   }
 
   @each $direction, $opposite in config.$direction-opposites {
-    &[data-popper-placement^='#{$direction}'] {
+    &[data-popper-placement^="#{$direction}"] {
       padding-#{$opposite}: $offset;
     }
   }
@@ -42,13 +42,14 @@
   $size-unitless: convert.strip-units($size);
   $hypotenuse: math.sqrt(
       math.pow($size-unitless, 2) + math.pow($size-unitless, 2)
-    ) * 1rem;
+    ) *
+    1rem;
   $arrow-position: $offset - math.div($hypotenuse, 4);
 
   display: block;
 
   &::before {
-    content: '';
+    content: "";
     display: block;
     width: $size;
     height: $size;
@@ -59,13 +60,13 @@
   }
 
   @each $direction, $opposite in config.$direction-opposites {
-    [data-popper-placement^='#{$direction}'] & {
+    [data-popper-placement^="#{$direction}"] & {
       #{$opposite}: $arrow-position;
     }
   }
 
   @each $direction, $reset-directions in config.$direction-border-color-reset {
-    [data-popper-placement^='#{$direction}'] &:before {
+    [data-popper-placement^="#{$direction}"] &:before {
       @each $reset-direction in $reset-directions {
         border-#{$reset-direction}-color: transparent;
       }
@@ -80,7 +81,7 @@
   @include base.focusring-round;
 
   &::before {
-    content: '';
+    content: "";
     position: absolute;
     top: convert.to-rem(-10px);
     left: convert.to-rem(-10px);
@@ -91,4 +92,4 @@
 
 @mixin info-tooltip-active-icon {
   color: config.$icon-active-color;
-}
+}

package/src/components/Tooltip/tests/Tooltip.conformance.test.jsx

@@ -1,5 +1,5 @@
 import { render } from "@testing-library/react";
-import { axe } from 'vitest-axe';
+import { axe } from "vitest-axe";
 
 import { Button } from "../../Button";
 import { Tooltip } from "../";

package/src/components/Tooltip/tests/Tooltip.unit.test.jsx

@@ -1,4 +1,4 @@
-import { render, fireEvent, waitFor } from "@testing-library/react";
+import { fireEvent, render } from "@testing-library/react";
 
 import { Tooltip } from "../Tooltip";
 
@@ -223,79 +223,88 @@ describe("rendering Tooltip", () => {
         </Base>,
       );
     });
-    it("button has class is-active when focused", () => {
+    it("button does not get class is-active when focused", () => {
       const { container } = tooltip;
       fireEvent.focus(container.querySelector("button"));
-      expect(container.querySelector("button")).toHaveClass("is-active");
+      expect(container.querySelector("button")).not.toHaveClass("is-active");
     });
 
-    it("tooltip has class is-visible when button is focused", () => {
+    it("tooltip is not visible when button is focused", () => {
       const { container, getByTestId } = tooltip;
       fireEvent.focus(container.querySelector("button"));
-      expect(getByTestId("test-id")).toHaveClass("is-visible");
+      expect(getByTestId("test-id")).not.toHaveClass("is-visible");
     });
-    it("button has class is-active when mouse enters button", () => {
+    it("button has class is-active when clicked", () => {
       const { container } = tooltip;
-      fireEvent.mouseEnter(container.querySelector("button"));
+      fireEvent.click(container.querySelector("button"));
       expect(container.querySelector("button")).toHaveClass("is-active");
     });
 
-    it("tooltip has class is-visible when mouse enters button", () => {
+    it("tooltip has class is-visible when button is clicked", () => {
       const { container, getByTestId } = tooltip;
-      fireEvent.mouseEnter(container.querySelector("button"));
+      fireEvent.click(container.querySelector("button"));
       expect(getByTestId("test-id")).toHaveClass("is-visible");
     });
-    it("has hidden attribute set to false after mouse enters button", () => {
+    it("has hidden attribute set to false after button click", () => {
       const { getByTestId, container } = tooltip;
-      fireEvent.mouseEnter(container.querySelector("button"));
+      fireEvent.click(container.querySelector("button"));
       expect(getByTestId("test-id").hidden).toBe(false);
     });
-    it("has hidden attribute set to false after button focus", () => {
+    it("keeps hidden attribute set to true after button focus", () => {
       const { getByTestId, container } = tooltip;
       fireEvent.focus(container.querySelector("button"));
-      expect(getByTestId("test-id").hidden).toBe(false);
+      expect(getByTestId("test-id").hidden).toBe(true);
     });
-    it("button losses class is-active after it losses focus", () => {
+    it("button loses class is-active after blur", () => {
       const { container } = tooltip;
-      fireEvent.focus(container.querySelector("button"));
+      fireEvent.click(container.querySelector("button"));
       fireEvent.blur(container.querySelector("button"));
       expect(container.querySelector("button")).not.toHaveClass("is-active");
     });
 
-    it("tooltip losses class is-visible after button losses focus", () => {
+    it("tooltip loses class is-visible after blur", () => {
       const { container, getByTestId } = tooltip;
-      fireEvent.focus(container.querySelector("button"));
+      fireEvent.click(container.querySelector("button"));
       fireEvent.blur(container.querySelector("button"));
       expect(getByTestId("test-id")).not.toHaveClass("is-visible");
     });
-    it("button losses class is-active after mouse leave event", () => {
+    it("button loses class is-active after second click", () => {
       const { container } = tooltip;
-      fireEvent.mouseEnter(container.querySelector("button"));
-      fireEvent.mouseLeave(container.querySelector("button"));
+      fireEvent.click(container.querySelector("button"));
+      fireEvent.click(container.querySelector("button"));
       expect(container.querySelector("button")).not.toHaveClass("is-active");
     });
 
-    it("tooltip losses class is-visible after mouse leaves button", () => {
+    it("tooltip loses class is-visible after second click", () => {
       const { container, getByTestId } = tooltip;
-      fireEvent.mouseEnter(container.querySelector("button"));
-      fireEvent.mouseLeave(container.querySelector("button"));
+      fireEvent.click(container.querySelector("button"));
+      fireEvent.click(container.querySelector("button"));
       expect(getByTestId("test-id")).not.toHaveClass("is-visible");
     });
-    it("keeps hidden attribute unset after mouse leaves button", async () => {
+    it("hides on blur after being opened by click", () => {
       const { getByTestId, container } = tooltip;
-      fireEvent.mouseEnter(container.querySelector("button"));
-      fireEvent.mouseLeave(container.querySelector("button"));
-      await waitFor(() => {
-        expect(getByTestId("test-id").hidden).toBe(false);
-      });
+      fireEvent.click(container.querySelector("button"));
+      fireEvent.blur(container.querySelector("button"));
+      expect(getByTestId("test-id")).not.toHaveClass("is-visible");
     });
-    it("keeps hidden attribute unset after button blur", async () => {
+    it("stays visible when tooltip content is clicked", () => {
       const { getByTestId, container } = tooltip;
-      fireEvent.focus(container.querySelector("button"));
+      fireEvent.click(container.querySelector("button"));
+      fireEvent.mouseDown(getByTestId("test-id"));
       fireEvent.blur(container.querySelector("button"));
-      await waitFor(() => {
-        expect(getByTestId("test-id").hidden).toBe(false);
-      });
+      expect(getByTestId("test-id")).toHaveClass("is-visible");
+    });
+    it("hides when clicking outside tooltip and trigger", () => {
+      const { getByTestId, container } = tooltip;
+      fireEvent.click(container.querySelector("button"));
+      fireEvent.click(document.body);
+      expect(getByTestId("test-id")).not.toHaveClass("is-visible");
+    });
+    it("hides on Escape key press", () => {
+      const { getByTestId, container } = tooltip;
+      fireEvent.click(container.querySelector("button"));
+      fireEvent.keyDown(container.querySelector("button"), { key: "Escape" });
+      expect(getByTestId("test-id")).not.toHaveClass("is-visible");
     });
   });
 });