From e078fdac46611bb1c6e3a3866747c58f0c44eee9 Mon Sep 17 00:00:00 2001
From: Geoffroy Begouaussel <geoffroy.begouaussel@zenika.com>
Date: Thu, 13 Jun 2024 17:11:24 +0200
Subject: [PATCH] refactor(Tooltip): improve tooltip display on focus

---
 addon/components/pix-tooltip.hbs              |  3 +-
 addon/components/pix-tooltip.js               |  6 ++--
 addon/styles/_pix-tooltip.scss                | 28 +++++++++++++++----
 app/stories/pix-tooltip.mdx                   |  1 +
 app/stories/pix-tooltip.stories.js            | 23 +++++++++++++++
 .../components/pix-tooltip-test.js            | 11 ++++----
 6 files changed, 55 insertions(+), 17 deletions(-)

diff --git a/addon/components/pix-tooltip.hbs b/addon/components/pix-tooltip.hbs
index 82c9c05ad..e28c4bf06 100644
--- a/addon/components/pix-tooltip.hbs
+++ b/addon/components/pix-tooltip.hbs
@@ -1,5 +1,5 @@
 <div
-  class="pix-tooltip"
+  class="pix-tooltip {{if this.isTooltipVisible 'pix-tooltip--visible' ''}}"
   {{on-escape-action this.hideTooltip}}
   {{on "mouseover" this.showTooltip}}
   {{on "mouseleave" this.hideTooltipOnMouseOut}}
@@ -19,7 +19,6 @@
         id={{@id}}
         role="tooltip"
         class="pix-tooltip__content pix-tooltip__content--{{this.position}}
-          {{if this.isVisible 'pix-tooltip__content--visible'}}
           {{if @isInline 'pix-tooltip__content--inline'}}
           {{if @isLight 'pix-tooltip__content--light'}}
           {{if @isWide 'pix-tooltip__content--wide'}}"
diff --git a/addon/components/pix-tooltip.js b/addon/components/pix-tooltip.js
index c11c5adf1..4d77bcaa6 100644
--- a/addon/components/pix-tooltip.js
+++ b/addon/components/pix-tooltip.js
@@ -3,7 +3,7 @@ import { action } from '@ember/object';
 import { tracked } from '@glimmer/tracking';
 
 export default class PixTooltip extends Component {
-  @tracked isVisible = false;
+  @tracked isTooltipVisible = false;
 
   get position() {
     const correctsPosition = [
@@ -25,12 +25,12 @@ export default class PixTooltip extends Component {
 
   @action
   showTooltip() {
-    this.isVisible = true;
+    this.isTooltipVisible = true;
   }
 
   @action
   hideTooltip() {
-    this.isVisible = false;
+    this.isTooltipVisible = false;
   }
 
   @action
diff --git a/addon/styles/_pix-tooltip.scss b/addon/styles/_pix-tooltip.scss
index ac51a3803..60c5326f4 100644
--- a/addon/styles/_pix-tooltip.scss
+++ b/addon/styles/_pix-tooltip.scss
@@ -8,6 +8,27 @@
     display: block;
     width: 100%;
   }
+
+  &__trigger-element:hover + .pix-tooltip__content {
+    visibility: visible;
+    opacity: 1;
+  }
+}
+
+@supports selector(:has(*)) {
+  .pix-tooltip--visible:has(.pix-tooltip__trigger-element :focus-visible) {
+    .pix-tooltip__content {
+      visibility: visible;
+      opacity: 1;
+    }
+  }
+}
+
+@supports not selector(:has(*)) {
+  .pix-tooltip--visible .pix-tooltip__trigger-element:focus-within + .pix-tooltip__content {
+    visibility: visible;
+    opacity: 1;
+  }
 }
 
 .pix-tooltip__content {
@@ -16,22 +37,17 @@
   position: absolute;
   left: auto;
   z-index: 100;
-  display: none;
   padding: var(--pix-spacing-2x) var(--pix-spacing-4x);
   color: var(--pix-neutral-0);
   font-size: 0.875rem;
   line-height: 1.4rem;
   background-color: var(--pix-neutral-900);
   border-radius: 6px;
+  visibility: hidden;
   opacity: 0;
   transition: opacity 0.3s;
   pointer-events: none;
 
-  &--visible {
-    display: block;
-    opacity: 1;
-  }
-
   &--inline {
     white-space: nowrap;
   }
diff --git a/app/stories/pix-tooltip.mdx b/app/stories/pix-tooltip.mdx
index 0d71b4f49..ea9e27868 100644
--- a/app/stories/pix-tooltip.mdx
+++ b/app/stories/pix-tooltip.mdx
@@ -61,6 +61,7 @@ Infobulle en position `top`, fond sombre (par défaut).
 
 <Story of={ComponentStories.Default} height={200} />
 <Story of={ComponentStories.WithIcon} height={200} />
+<Story of={ComponentStories.WithInput} height={200} />
 
 ## Is Light
 
diff --git a/app/stories/pix-tooltip.stories.js b/app/stories/pix-tooltip.stories.js
index 7c3b3ec97..7f3139b42 100644
--- a/app/stories/pix-tooltip.stories.js
+++ b/app/stories/pix-tooltip.stories.js
@@ -118,6 +118,23 @@ const TemplateWithIconElement = (args) => {
   };
 };
 
+const TemplateWithInputElement = (args) => {
+  return {
+    template: hbs`<PixTooltip @id={{this.id}} @isInline='true'>
+  <:triggerElement>
+    <PixInput @id='some-id'>
+      <:label>{{this.label}}</:label>
+    </PixInput>
+  </:triggerElement>
+
+  <:tooltip>
+    {{this.text}}
+  </:tooltip>
+</PixTooltip>`,
+    context: args,
+  };
+};
+
 export const Default = Template.bind({});
 Default.args = {
   text: 'Hello World',
@@ -184,6 +201,12 @@ WithIcon.args = {
   label: 'À survoler pour voir la tooltip',
 };
 
+export const WithInput = TemplateWithInputElement.bind({});
+WithInput.args = {
+  text: 'Hello World',
+  label: 'À survoler pour voir la tooltip',
+};
+
 export const hide = Template.bind({});
 hide.args = {
   label: "Survoler ici n'affiche pas tooltip",
diff --git a/tests/integration/components/pix-tooltip-test.js b/tests/integration/components/pix-tooltip-test.js
index eadd97ba7..37a4dd758 100644
--- a/tests/integration/components/pix-tooltip-test.js
+++ b/tests/integration/components/pix-tooltip-test.js
@@ -60,21 +60,20 @@ module('Integration | Component | pix-tooltip', function (hooks) {
 
   test('it dismissed tooltip on escape keyup', async function (assert) {
     // given
-    const screen = await render(hbs`<PixTooltip>
+    const screen = await render(hbs`<PixTooltip @position='bottom'>
   <:triggerElement>
-    template block text
+    <PixButton>Trigger</PixButton>
   </:triggerElement>
-  <:tooltip></:tooltip>
+  <:tooltip>Some tooltip</:tooltip>
 </PixTooltip>`);
 
     // when
-    await screen.getByText('template block text').focus();
+    await screen.getByRole('button', { name: 'Trigger' }).focus();
 
     await userEvent.keyboard('[Escape]');
 
     // then
-    assert.contains('template block text');
-    assert.dom('.pix-tooltip__content').isNotVisible();
+    assert.dom('.pix-tooltip').doesNotHaveClass('pix-tooltip--visible');
   });
 
   module('tooltip position', function () {