From 64d1c11eae111e38fb6716fcdd134a311d398fd3 Mon Sep 17 00:00:00 2001
From: DaBadBunny <clement.debroize@gmail.com>
Date: Tue, 29 Aug 2023 16:01:43 +0200
Subject: [PATCH] feat: :sparkles: Nouveau composant Bulle d'aide

---
 .vitepress/config.ts                          |   4 +-
 .vitepress/theme/style.css                    |  14 +-
 docs/_frame.md                                |   2 +-
 src/components/DsfrTooltip/DsfrTooltip.md     |  48 ++++++
 .../DsfrTooltip/DsfrTooltip.stories.ts        |  95 ++++++++++++
 src/components/DsfrTooltip/DsfrTooltip.vue    | 142 ++++++++++++++++++
 .../docs-demo/DsfrTooltipExample.vue          |  37 +++++
 7 files changed, 338 insertions(+), 4 deletions(-)
 create mode 100644 src/components/DsfrTooltip/DsfrTooltip.md
 create mode 100644 src/components/DsfrTooltip/DsfrTooltip.stories.ts
 create mode 100644 src/components/DsfrTooltip/DsfrTooltip.vue
 create mode 100644 src/components/DsfrTooltip/docs-demo/DsfrTooltipExample.vue

diff --git a/.vitepress/config.ts b/.vitepress/config.ts
index ae8cf311..fde6cd4b 100644
--- a/.vitepress/config.ts
+++ b/.vitepress/config.ts
@@ -118,8 +118,8 @@ export default defineConfig({
             link: '/composants/DsfrSegmented.md',
           },
           {
-            text: 'DsfrSegmentedSet',
-            link: '/composants/DsfrSegmentedSet.md',
+            text: 'DsfrTooltip',
+            link: '/composants/DsfrTooltip.md',
           },
         ]
       },
diff --git a/.vitepress/theme/style.css b/.vitepress/theme/style.css
index a5cd579c..9a4ca893 100644
--- a/.vitepress/theme/style.css
+++ b/.vitepress/theme/style.css
@@ -7,7 +7,7 @@
  * Colors
  * -------------------------------------------------------------------------- */
 
-@font-face {
+ @font-face {
   font-family: Marianne;
   src: url("@gouvfr/dsfr/dist/fonts/Marianne-Light.woff2") format("woff2"), url("@gouvfr/dsfr/dist/fonts/Marianne-Light.woff") format("woff");
   font-weight: 300;
@@ -190,3 +190,15 @@
 .w-full {
   width: 100%;
 }
+
+.h-full {
+  width: 100%;
+}
+
+.flex {
+  display: flex;
+}
+
+.flex-end {
+  justify-content: flex-end;
+}
diff --git a/docs/_frame.md b/docs/_frame.md
index f6d85047..c7fff87c 100644
--- a/docs/_frame.md
+++ b/docs/_frame.md
@@ -2,7 +2,7 @@
 layout: false
 ---
 
-<div ref="el" class="flex h-4 flex-col px-6 pb-5"></div>
+<div ref="el" class="flex h-full flex-col px-6 pb-5"></div>
 
 <script setup lang="ts">
 import { useStyleTag } from '@vueuse/core'
diff --git a/src/components/DsfrTooltip/DsfrTooltip.md b/src/components/DsfrTooltip/DsfrTooltip.md
new file mode 100644
index 00000000..d8041105
--- /dev/null
+++ b/src/components/DsfrTooltip/DsfrTooltip.md
@@ -0,0 +1,48 @@
+# Information contextuelle et Infobulle - DsfrTooltip
+
+## 🌟 Introduction
+
+Le `DsfrTooltip` est un composant Vue versatile, conçu pour fournir des infobulles contextuelles. Il supporte le déclenchement au survol ou au clic, et s'adapte automatiquement à la position de l'élément source pour une visibilité optimale. Ce composant est idéal pour ajouter des explications ou des informations supplémentaires sans encombrer l'interface utilisateur.
+
+## 🛠️ Les props
+
+| Nom        | Type      | Défaut               | Obligatoire | Description                                                 |
+|------------|-----------|----------------------|:-----------:|-------------------------------------------------------------|
+| `content`  | `string`  |                      | ✅          | Le texte à afficher dans l'infobulle.                       |
+| `onHover`  | `boolean` | `false`              |             | Si `true`, l'infobulle s'affiche au survol.                 |
+| `id`       | `string`  | `getRandomId('tooltip')` |         | Identifiant unique pour l'infobulle. Utilisé pour l'accessibilité. |
+
+## 📡 Événements
+
+- Aucun événement personnalisé n'est émis par ce composant.
+
+## 🧩 Les slots
+
+- `default` : Contenu personnalisé pour l'élément déclencheur de l'infobulle (peut être un lien ou un bouton selon `onHover`).
+
+## 📝 Exemples
+
+```vue
+<DsfrTooltip content="Voici une infobulle">
+  Survolez-moi
+</DsfrTooltip>
+```
+
+## 📝 Toutes les variantes 🌈 d’info-bulles
+
+::: code-group
+
+<Story data-title="Démo" min-h="300px">
+  <DsfrTooltipExample />
+</Story>
+
+<<< docs-demo/DsfrTooltipExample.vue [Code de la démo]
+
+<<< DsfrTooltip.vue
+:::
+
+Avec DsfrTooltip, révélez des informations cachées comme un magicien sort un lapin de son chapeau ! 🎩🐇✨
+
+<script setup lang="ts">
+import DsfrTooltipExample from './docs-demo/DsfrTooltipExample.vue'
+</script>
diff --git a/src/components/DsfrTooltip/DsfrTooltip.stories.ts b/src/components/DsfrTooltip/DsfrTooltip.stories.ts
new file mode 100644
index 00000000..838dcbec
--- /dev/null
+++ b/src/components/DsfrTooltip/DsfrTooltip.stories.ts
@@ -0,0 +1,95 @@
+import DsfrTooltip from './DsfrTooltip.vue'
+export default {
+  component: DsfrTooltip,
+  title: 'Composants/DsfrTooltip',
+  argTypes: {
+    id: {
+      control: 'text',
+      description: '(optionnel) Valeur de l’attribut `id` du tooltip. Par défaut, un id pseudo-aléatoire sera donné.',
+    },
+    content: {
+      control: 'text',
+      description: 'Contenu de votre bulle d’aide : il s’agit d’un texte sans mise en forme.',
+    },
+    onHover: {
+      control: 'boolean',
+      description: 'Permet de définir si l’infobulle doit s’afficher au survol de l’élément (`true`) ou au clic (`false`, défaut).',
+    },
+  },
+}
+
+export const Infobulle = (args) => ({
+  components: {
+    DsfrTooltip,
+  },
+
+  data () {
+    return {
+      ...args,
+    }
+  },
+
+  template: `
+    <DsfrTooltip
+      :content="content"
+      :on-hover="onHover"
+    >
+      Un élément intriguant
+    </DsfrTooltip>
+  `,
+
+})
+Infobulle.args = {
+  content: 'Un élément assez intriguant',
+  onHover: false,
+}
+
+export const InfobulleParDefaut = (args) => ({
+  components: {
+    DsfrTooltip,
+  },
+
+  data () {
+    return {
+      ...args,
+    }
+  },
+
+  template: `
+    <DsfrTooltip
+      :content="content"
+    >
+      Un contenu qui n’apparaîtra que si hover est à \`true\`
+    </DsfrTooltip>
+  `,
+
+})
+InfobulleParDefaut.args = {
+  content: 'Un élément assez intriguant',
+}
+
+export const InfobulleAuSurvol = (args) => ({
+  components: {
+    DsfrTooltip,
+  },
+
+  data () {
+    return {
+      ...args,
+    }
+  },
+
+  template: `
+    Du texte
+    <DsfrTooltip
+      :content="content"
+      onHover
+    >
+      avec une précision à donner ici
+    </DsfrTooltip>
+  `,
+
+})
+InfobulleAuSurvol.args = {
+  content: 'Texte précisant pourquoi ce texte est là',
+}
diff --git a/src/components/DsfrTooltip/DsfrTooltip.vue b/src/components/DsfrTooltip/DsfrTooltip.vue
new file mode 100644
index 00000000..b109b6a6
--- /dev/null
+++ b/src/components/DsfrTooltip/DsfrTooltip.vue
@@ -0,0 +1,142 @@
+<script setup lang="ts">
+import { computed, defineProps, ref, watch, onUnmounted, onMounted } from 'vue'
+
+import { getRandomId } from '../../utils/random-utils'
+
+const props = withDefaults(defineProps<{
+    content: string
+    onHover?: boolean
+    id?: string,
+  }>(), {
+  id: () => getRandomId('tooltip'),
+})
+
+const show = ref(false)
+
+const source = ref<HTMLElement | null>(null)
+const tooltip = ref<HTMLElement | null>(null)
+
+const translateX = ref('0px')
+const translateY = ref('0px')
+const arrowX = ref('0px')
+const top = ref(false)
+const opacity = ref(0)
+
+watch(show, async (value) => {
+  if (typeof document === 'undefined') {
+    return
+  }
+  if (!value) {
+    return
+  }
+
+  opacity.value = 0
+  await new Promise(resolve => setTimeout(resolve, 100))
+  const sourceTop = source.value?.offsetTop
+  const sourceHeight = source.value?.offsetHeight
+  const sourceWidth = source.value?.offsetWidth
+  const sourceLeft = source.value?.offsetLeft
+  const tooltipHeight = tooltip.value?.offsetHeight
+  const tooltipWidth = tooltip.value?.offsetWidth
+  const isSourceAtTop = (sourceTop - tooltipHeight) < 0
+  const isSourceAtBottom = !isSourceAtTop && (sourceTop + sourceHeight + tooltipHeight) >= document.documentElement.offsetHeight
+  top.value = isSourceAtBottom
+  const isSourceOnRightSide = (sourceLeft + sourceWidth) >= document.documentElement.offsetWidth
+  const isSourceOnLeftSide = (sourceLeft + (sourceWidth / 2) - (tooltipWidth / 2)) <= 0
+
+  translateY.value = isSourceAtBottom
+    ? `${sourceTop - tooltipHeight + 8}px`
+    : `${sourceTop + sourceHeight - 8}px`
+  opacity.value = 1
+  translateX.value = isSourceOnRightSide
+    ? `${sourceLeft + sourceWidth - tooltipWidth - 4}px`
+    : isSourceOnLeftSide
+      ? `${sourceLeft + 4}px`
+      : `${sourceLeft + (sourceWidth / 2) - (tooltipWidth / 2)}px`
+
+  arrowX.value = isSourceOnRightSide
+    ? `${(tooltipWidth / 2) - (sourceWidth / 2) + 4}px`
+    : isSourceOnLeftSide
+      ? `${-(tooltipWidth / 2) + (sourceWidth / 2) - 4}px`
+      : '0px'
+})
+
+const tooltipStyle = computed(() => (`transform: translate(${translateX.value}, ${translateY.value}); --arrow-x: ${arrowX.value}; opacity: ${opacity.value};'`))
+const tooltipClass = computed(() => ({
+  'fr-tooltip--shown': show.value,
+  'fr-placement--top': top.value,
+  'fr-placement--bottom': !top.value,
+}))
+
+const clickListener = (event: MouseEvent) => {
+  if (!show.value) {
+    return
+  }
+  if (event.target === source.value || source.value?.contains(event.target as Node)) {
+    return
+  }
+  if (event.target === tooltip.value || tooltip.value?.contains(event.target as Node)) {
+    return
+  }
+  show.value = false
+}
+
+onMounted(() => {
+  document.documentElement.addEventListener('click', clickListener)
+})
+
+onUnmounted(() => {
+  document.documentElement.removeEventListener('click', clickListener)
+})
+
+const onMouseEnter = () => {
+  if (props.onHover) {
+    show.value = true
+  }
+}
+
+const onMouseLeave = () => {
+  if (props.onHover) {
+    show.value = false
+  }
+}
+
+const onClick = () => {
+  if (!props.onHover) {
+    show.value = !show.value
+  }
+}
+</script>
+
+<template>
+  <component
+    :is="onHover ? 'a' : 'button'"
+    :id="'link-' + id"
+    ref="source"
+    :class="onHover ? 'fr-link' : 'fr-btn  fr-btn--tooltip'"
+    :aria-describedby="id"
+    :href="onHover ? '#' : undefined"
+    @click="onClick()"
+    @mouseenter="onMouseEnter()"
+    @mouseleave="onMouseLeave()"
+  >
+    <slot />
+  </component>
+  <span
+    :id="id"
+    ref="tooltip"
+    class="fr-tooltip  fr-placement"
+    :class="tooltipClass"
+    :style="tooltipStyle"
+    role="tooltip"
+    aria-hidden="true"
+  >
+    {{ content }}
+  </span>
+</template>
+
+<style scoped>
+.fr-tooltip {
+  transition: opacity 0.3s ease-in-out;
+}
+</style>
diff --git a/src/components/DsfrTooltip/docs-demo/DsfrTooltipExample.vue b/src/components/DsfrTooltip/docs-demo/DsfrTooltipExample.vue
new file mode 100644
index 00000000..bd21f461
--- /dev/null
+++ b/src/components/DsfrTooltip/docs-demo/DsfrTooltipExample.vue
@@ -0,0 +1,37 @@
+<script lang="ts" setup>
+import DsfrTooltip from '../DsfrTooltip.vue'
+</script>
+
+<template>
+  <div
+    class="flex flex-col justify-between w-full"
+    style="height: 300px"
+  >
+    <div class="flex justify-between w-full">
+      <DsfrTooltip
+        on-hover
+        content="Texte de l’info-bulle en haut à gauche qui peut être très très long"
+      >
+        Avec du texte ici
+      </DsfrTooltip>
+      <DsfrTooltip
+        content="Texte de l’info-bulle en haut à droite qui peut être très très long"
+      />
+    </div>
+
+    <div class="flex justify-center w-full">
+      <DsfrTooltip
+        content="Texte de l’info-bulle au centre qui peut être très très long"
+      />
+    </div>
+
+    <div class="flex  justify-between w-full">
+      <DsfrTooltip
+        content="Texte de l’info-bulle en bas à gauche qui peut être très très long"
+      />
+      <DsfrTooltip
+        content="Texte de l’info-bulle en bas à droite qui peut être très très long"
+      />
+    </div>
+  </div>
+</template>