From ebd01993753832e19dc9ac464cd40e91f2680bc9 Mon Sep 17 00:00:00 2001
From: cupcakearmy <hi@nicco.io>
Date: Sun, 16 Jan 2022 01:27:04 +0100
Subject: [PATCH] use fluent UI

---
 README.md                        | 15 ++++----
 package.json                     |  5 ++-
 pnpm-lock.yaml                   | 25 +++++++-----
 src/components/Playground.svelte | 11 ++++--
 src/lib/Hint.svelte              | 66 ++++++++++++++++----------------
 src/routes/index.svelte          |  2 +-
 6 files changed, 69 insertions(+), 55 deletions(-)

diff --git a/README.md b/README.md
index a9ddcfc..04749de 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # svelte-hint
 
-Svelte library for tooltips internally powered by the awesome [Popper.js](https://popper.js.org/) with sensible default values.
+Svelte library for tooltips internally powered by the awesome [Fluent UI](https://floating-ui.com/) with sensible default values.
 
 Check out the **[demo](https://svelte-hint.pages.dev/)** to see it in action.
 
@@ -50,12 +50,13 @@ npm install svelte-hint
 
 ### Props
 
-| Prop        | Type                    | Default             | Description                                                                                           |
-| ----------- | ----------------------- | ------------------- | ----------------------------------------------------------------------------------------------------- |
-| `placement` | `Placement`             | `auto`              | For possible values see [popper](https://popper.js.org/docs/v2/constructors/#options).                |
-| `text`      | `string`                | `''`                | Text to be used as the tooltip. If empty the slot will be used.                                       |
-| `boundary`  | `HTMLElement \| string` | `'clippingParents'` | See [popper docs](https://popper.js.org/docs/v2/utils/detect-overflow/#boundary) for possible values. |
-| `offset`    | `number`                | `4`                 | The offset is the distance that the tooltip gets positioned from the trigger.                         |
+| Prop        | Type                          | Default             | Description                                                                                                           |
+| ----------- | ----------------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| `text`      | `string`                      | `''`                | Text to be used as the tooltip. If empty the slot will be used.                                                       |
+| `placement` | `Placement`                   | `auto`              | See the [Fluent UI docs](https://floating-ui.com/docs/computePosition#placement).                                     |
+| `boundary`  | `HTMLElement \| string`       | `'clippingParents'` | See the [Fluent UI docs](https://floating-ui.com/docs/detectOverflow#boundary).                                       |
+| `offset`    | `Options`                     | `4`                 | See the [Fluent UI docs](https://floating-ui.com/docs/offset#options).                                                |
+| `auto`      | `boolean \| 'start' \| 'end'` | `false`             | Use the [`autoPlacement`](https://floating-ui.com/docs/autoPlacement) middleware. If set `placement` will be ignored. |
 
 ### Slots
 
diff --git a/package.json b/package.json
index 52c3a7d..a71575d 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "svelte-hint",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.2",
   "description": "Tooltip library for svelte",
   "author": {
     "name": "Niccolo Borgioli",
@@ -19,6 +19,7 @@
     "publish": "rm -rf ./package && pnpm run check && pnpm run package && pnpm publish ./package"
   },
   "devDependencies": {
+    "@floating-ui/core": "^0.3.1",
     "@sveltejs/adapter-auto": "next",
     "@sveltejs/kit": "next",
     "bulma": "^0.9.3",
@@ -31,6 +32,6 @@
     "typescript": "^4.5.4"
   },
   "dependencies": {
-    "@popperjs/core": "^2"
+    "@floating-ui/dom": "^0.1.10"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index f1cae50..97859cf 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -1,7 +1,8 @@
 lockfileVersion: 5.3
 
 specifiers:
-  '@popperjs/core': ^2
+  '@floating-ui/core': ^0.3.1
+  '@floating-ui/dom': ^0.1.10
   '@sveltejs/adapter-auto': next
   '@sveltejs/kit': next
   bulma: ^0.9.3
@@ -14,11 +15,12 @@ specifiers:
   typescript: ^4.5.4
 
 dependencies:
-  '@popperjs/core': 2.11.2
+  '@floating-ui/dom': 0.1.10
 
 devDependencies:
+  '@floating-ui/core': 0.3.1
   '@sveltejs/adapter-auto': 1.0.0-next.10
-  '@sveltejs/kit': 1.0.0-next.228_svelte@3.46.0
+  '@sveltejs/kit': 1.0.0-next.229_svelte@3.46.0
   bulma: 0.9.3
   interactjs: 1.10.11
   svelte: 3.46.0
@@ -30,6 +32,15 @@ devDependencies:
 
 packages:
 
+  /@floating-ui/core/0.3.1:
+    resolution: {integrity: sha512-ensKY7Ub59u16qsVIFEo2hwTCqZ/r9oZZFh51ivcLGHfUwTn8l1Xzng8RJUe91H/UP8PeqeBronAGx0qmzwk2g==}
+
+  /@floating-ui/dom/0.1.10:
+    resolution: {integrity: sha512-4kAVoogvQm2N0XE0G6APQJuCNuErjOfPW8Ux7DFxh8+AfugWflwVJ5LDlHOwrwut7z/30NUvdtHzQ3zSip4EzQ==}
+    dependencies:
+      '@floating-ui/core': 0.3.1
+    dev: false
+
   /@iarna/toml/2.2.5:
     resolution: {integrity: sha512-trnsAYxU3xnS1gPHPyU961coFyLkh4gAD/0zQ5mymY4yOZ+CYvsPqUbOFSw0aDM4y0tV7tiFxL/1XfXPNC6IPg==}
     dev: true
@@ -59,10 +70,6 @@ packages:
       fastq: 1.13.0
     dev: true
 
-  /@popperjs/core/2.11.2:
-    resolution: {integrity: sha512-92FRmppjjqz29VMJ2dn+xdyXZBrMlE42AV6Kq6BwjWV7CNUW1hs2FtxSNLQE+gJhaZ6AAmYuO9y8dshhcBl7vA==}
-    dev: false
-
   /@rollup/pluginutils/4.1.2:
     resolution: {integrity: sha512-ROn4qvkxP9SyPeHaf7uQC/GPFY6L/OWy9+bd9AwcjOAWQwxRscoEyAUD8qCY5o5iL4jqQwoLk2kaTKJPb/HwzQ==}
     engines: {node: '>= 8.0.0'}
@@ -99,8 +106,8 @@ packages:
       esbuild: 0.13.15
     dev: true
 
-  /@sveltejs/kit/1.0.0-next.228_svelte@3.46.0:
-    resolution: {integrity: sha512-77e8G7CcmqHhMyAbtjrAWjRDDgFiZArFhujKGql5YM68TWx0cCoipqGdhK0m3EJ/t/NL+T2YuK/9nvtrSNEK6A==}
+  /@sveltejs/kit/1.0.0-next.229_svelte@3.46.0:
+    resolution: {integrity: sha512-i609g5T58Qdgh/qgO1atak70R7woNuJwWp7GtF/YUOZ9csMR9JPUr1tfX9lSh2I4Ez7j+Dc10RLlQ3szVywfXA==}
     engines: {node: '>=14.13'}
     hasBin: true
     peerDependencies:
diff --git a/src/components/Playground.svelte b/src/components/Playground.svelte
index ea441b1..c8839a6 100644
--- a/src/components/Playground.svelte
+++ b/src/components/Playground.svelte
@@ -1,5 +1,5 @@
 <script lang="ts">
-  import Hint, { Placement } from '../lib/Hint.svelte'
+  import Hint from '../lib/Hint.svelte'
   import interact from 'interactjs'
   import { onMount } from 'svelte'
 
@@ -11,7 +11,8 @@
   let direction = 'bottom'
   let align = 'center'
 
-  $: placement = `${direction}-${align}`.replace('-center', '') as Placement
+  $: placement = `${direction}-${align}`.replace('-center', '') as any
+  $: auto = (placement.startsWith('auto') && (placement.includes('-') ? placement.split('-')[1] : true)) as any
 
   let knob: HTMLDivElement
 
@@ -74,13 +75,17 @@
 
 <div class="container bg-light">
   <div bind:this={knob}>
-    <Hint {placement} {offset} {text}>
+    <Hint {placement} {offset} {text} {auto}>
       <button class="btn btn-success drag">Hover me!</button>
       <div slot="hint">Test</div>
     </Hint>
   </div>
 </div>
 
+<p>
+  Positioning gets recalculated <b>when hovering</b>, not while moving the button around.
+</p>
+
 <style>
   .container {
     width: 100%;
diff --git a/src/lib/Hint.svelte b/src/lib/Hint.svelte
index 6cf52b7..523a7a7 100644
--- a/src/lib/Hint.svelte
+++ b/src/lib/Hint.svelte
@@ -1,47 +1,41 @@
 <script lang="ts" context="module">
-  export type { Placement } from '@popperjs/core'
+  import type { DOMDetectOverflowOptions, Placement } from '@floating-ui/dom'
 </script>
 
 <script lang="ts">
-  import { createPopper, Instance, Placement } from '@popperjs/core'
+  import { computePosition, flip, shift, offset as offsetMiddleware, autoPlacement } from '@floating-ui/dom'
   import { onMount } from 'svelte'
 
-  export let placement: Placement = 'auto'
+  export let placement: Placement | undefined = undefined
   export let text: string | null = null
-  export let boundary: HTMLElement | string = 'clippingParents'
-  export let offset: number = 4
+  export let boundary: DOMDetectOverflowOptions['boundary'] = 'clippingParents'
+  export let offset: Parameters<typeof offsetMiddleware>[0] = 4
+  export let auto: boolean | 'start' | 'end' = false
 
   let trigger: HTMLSpanElement | null = null
   let hint: HTMLSpanElement | null = null
-  let instance: Instance | null = null
   let dataShow = false
   let id = ''
 
-  $: if (hint && trigger) {
-    if (instance) instance.destroy()
-    instance = createPopper(trigger, hint, {
-      placement,
-      modifiers: [
-        {
-          name: 'offset',
-          options: {
-            offset: [0, offset],
-          },
-        },
-        {
-          name: 'flip',
-          options: {
-            boundary,
-          },
-        },
-      ],
+  async function update() {
+    if (!hint || !trigger) return
+
+    const options = {
+      placement: placement as Placement,
+      middleware: auto
+        ? [offsetMiddleware(offset), autoPlacement({ boundary, alignment: typeof auto === 'string' ? auto : null })]
+        : [offsetMiddleware(offset), flip({ boundary }), shift({ boundary, padding: 4 })],
+    }
+    const { x, y } = await computePosition(trigger, hint, options)
+    Object.assign(hint!.style, {
+      left: `${x}px`,
+      top: `${y}px`,
     })
   }
 
-  function show() {
-    console.debug('show', hint)
+  async function show() {
+    await update()
     dataShow = true
-    instance?.update()
   }
 
   function hide() {
@@ -49,14 +43,19 @@
   }
 
   onMount(() => {
+    update()
     id = Math.random().toString(16).slice(2) // Random id for the tooltip
-    const showEvents = ['mouseenter', 'focus']
-    const hideEvents = ['mouseleave', 'blur']
-    showEvents.forEach((event) => trigger?.addEventListener(event, show, false))
-    hideEvents.forEach((event) => trigger?.addEventListener(event, hide, false))
+
+    // Bind events
+    const events: [keyof HTMLElementEventMap, EventListener][] = [
+      ['mouseenter', show],
+      ['focus', show],
+      ['mouseleave', hide],
+      ['blur', hide],
+    ]
+    events.forEach(([event, handler]) => trigger?.addEventListener(event, handler))
     return () => {
-      showEvents.forEach((event) => trigger?.removeEventListener(event, show, false))
-      hideEvents.forEach((event) => trigger?.removeEventListener(event, hide, false))
+      events.forEach(([event, handler]) => trigger?.removeEventListener(event, handler))
     }
   })
 </script>
@@ -74,6 +73,7 @@
 
 <style>
   .svelte-hint-tooltip {
+    position: absolute;
     visibility: hidden;
   }
 
diff --git a/src/routes/index.svelte b/src/routes/index.svelte
index 1490ff5..cbf3e6d 100644
--- a/src/routes/index.svelte
+++ b/src/routes/index.svelte
@@ -8,7 +8,7 @@
 
   <p>
     Svelte utility library for Tooltips. Heavy lifting of positioning is done by
-    <a href="https://popper.js.org/">Popper.js</a>.
+    <a href="https://floating-ui.com/">Floating UI</a>.
   </p>
   <p>
     If you are looking for installation and docs please see the