wave-ui 2.27.0 → 2.30.0

package/src/wave-ui/components/w-tooltip.vue

@@ -1,19 +1,14 @@
 <template lang="pug">
-.w-tooltip-wrap(ref="wrapper" :class="{ 'w-tooltip-wrap--attached': !detachTo }")
+.w-tooltip-wrap
   slot(name="activator" :on="eventHandlers")
   transition(:name="transitionName" appear)
-    //- In Vue 3, a ref in a transition doesn't stay in $refs, it must be set as a function.
     .w-tooltip(
-      :ref="el => tooltipEl = el"
+      v-if="detachableVisible"
+      ref="detachable"
       :key="_.uid"
-      v-show="showTooltip"
       :class="classes"
       :style="styles")
-      //- When there is a bg color, another div wrapper is needed for the triangle
-      //- to inherit the current color.
-      div(v-if="bgColor" :class="color")
-        slot
-      slot(v-else)
+      slot
 </template>
 
 <script>
@@ -27,12 +22,13 @@
  */
 
 import { objectifyClasses } from '../utils/index'
-import { consoleWarn } from '../utils/console'
+import DetachableMixin from '../mixins/detachable'
 
-const marginFromWindowSide = 4 // Amount of px from a window side, instead of overflowing.
+// const marginFromWindowSide = 4 // Amount of px from a window side, instead of overflowing.
 
 export default {
   name: 'w-tooltip',
+  mixins: [DetachableMixin],
 
   props: {
     modelValue: {},
@@ -46,32 +42,44 @@ export default {
     transition: { type: String },
     tooltipClass: { type: [String, Object, Array] },
     // Position.
-    detachTo: {},
+    detachTo: { type: [String, Boolean, Object], deprecated: true },
+    appendTo: { type: [String, Boolean, Object] },
     fixed: { type: Boolean },
     top: { type: Boolean },
     bottom: { type: Boolean },
     left: { type: Boolean },
     right: { type: Boolean },
-    zIndex: { type: [Number, String, Boolean] }
+    alignTop: { type: Boolean },
+    alignBottom: { type: Boolean },
+    alignLeft: { type: Boolean },
+    alignRight: { type: Boolean },
+    zIndex: { type: [Number, String, Boolean] },
+    persistent: { type: Boolean },
+    noPosition: { type: Boolean }
   },
 
   emits: ['input', 'update:modelValue', 'open', 'close'],
 
   data: () => ({
-    showTooltip: false,
+    detachableVisible: false,
+    hoveringActivator: false,
     // The activator coordinates.
-    coordinates: {
+    detachableCoords: {
       top: 0,
-      left: 0,
-      width: 0,
-      height: 0
+      left: 0
     },
     activatorEl: null,
-    tooltipEl: null,
+    detachableEl: null,
     timeoutId: null
   }),
 
   computed: {
+    /**
+     * Other computed in the detachable mixin:
+     * - `appendToTarget`
+     * - `detachableParentEl`
+     **/
+
     tooltipClasses () {
       return objectifyClasses(this.tooltipClass)
     },
@@ -81,29 +89,6 @@ export default {
       return this.transition || `w-tooltip-slide-fade-${direction}`
     },
 
-    detachToTarget () {
-      let target = this.detachTo || '.w-app'
-      if (target === true) target = '.w-app'
-      else if (target && !['object', 'string'].includes(typeof target)) target = '.w-app'
-      else if (typeof target === 'object' && !target.nodeType) {
-        target = '.w-app'
-        consoleWarn('Invalid node provided in w-tooltip `attach-to`. Falling back to .w-app.', this)
-      }
-      if (typeof target === 'string') target = document.querySelector(target)
-
-      if (!target) {
-        consoleWarn(`Unable to locate ${this.detachTo ? `target ${this.detachTo}` : '.w-app'}`, this)
-        target = document.querySelector('.w-app')
-      }
-
-      return target
-    },
-
-    // DOM element that will receive the tooltip.
-    tooltipParentEl () {
-      return this.detachTo ? this.detachToTarget : this.$refs.wrapper
-    },
-
     position () {
       return (
         (this.top && 'top') ||
@@ -114,57 +99,39 @@ export default {
       )
     },
 
-    tooltipCoordinates () {
-      const coords = {}
-      const { top, left, width, height } = this.coordinates
-
-      switch (this.position) {
-        case 'top': {
-          coords.top = top
-          coords.left = left + width / 2 // left: 50%.
-          break
-        }
-        case 'bottom': {
-          coords.top = top + height
-          coords.left = left + width / 2 // left: 50%.
-          break
-        }
-        case 'left': {
-          coords.top = top + height / 2 // top: 50%.
-          coords.left = left
-          break
-        }
-        case 'right': {
-          coords.top = top + height / 2 // top: 50%.
-          coords.left = left + width
-          break
-        }
-      }
-
-      return coords
+    alignment () {
+      return (
+        (['top', 'bottom'].includes(this.position) && this.alignLeft && 'left') ||
+        (['top', 'bottom'].includes(this.position) && this.alignRight && 'right') ||
+        (['left', 'right'].includes(this.position) && this.alignTop && 'top') ||
+        (['left', 'right'].includes(this.position) && this.alignBottom && 'bottom') ||
+        ''
+      )
     },
 
     classes () {
       return {
-        [this.color]: !this.bgColor,
-        [`${this.bgColor} ${this.bgColor}--bg`]: this.bgColor,
+        [this.color]: this.color,
+        [`${this.bgColor}--bg`]: this.bgColor,
         ...this.tooltipClasses,
-        [`w-tooltip--${this.position}`]: true,
+        [`w-tooltip--${this.position}`]: !this.noPosition,
+        [`w-tooltip--align-${this.alignment}`]: !this.noPosition && this.alignment,
         'w-tooltip--tile': this.tile,
         'w-tooltip--round': this.round,
         'w-tooltip--shadow': this.shadow,
         'w-tooltip--fixed': this.fixed,
-        'w-tooltip--active': this.showTooltip,
         'w-tooltip--no-border': this.noBorder || this.bgColor,
         'w-tooltip--custom-transition': this.transition
       }
     },
 
+    // The tooltip styles.
     styles () {
       return {
         zIndex: this.zIndex || this.zIndex === 0 || null,
-        top: `${~~this.tooltipCoordinates.top}px`,
-        left: `${~~this.tooltipCoordinates.left}px`
+        top: (this.detachableCoords.top && `${~~this.detachableCoords.top}px`) || null,
+        left: (this.detachableCoords.left && `${~~this.detachableCoords.left}px`) || null,
+        '--w-tooltip-bg-color': this.$waveui.colors[this.bgColor || 'white']
       }
     },
 
@@ -175,20 +142,38 @@ export default {
         handlers = {
           focus: this.toggle,
           blur: this.toggle,
-          mouseenter: this.toggle,
-          mouseleave: this.toggle
+          mouseenter: e => {
+            this.hoveringActivator = true
+            this.open(e)
+          },
+          mouseleave: e => {
+            this.hoveringActivator = false
+            this.close()
+          }
         }
 
-        if ('ontouchstart' in window) handlers.click = this.toggle
+        // Check the window exists: SSR-proof.
+        if (typeof window !== 'undefined' && 'ontouchstart' in window) handlers.click = this.toggle
       }
       return handlers
     }
   },
 
   methods: {
+    /**
+     * Other methods in the `detachable` mixin:
+     * - `getActivatorCoordinates`
+     * - `computeDetachableCoords`
+     * - `onResize`
+     * - `onOutsideMousedown`
+     * - `insertInDOM`
+     * - `removeFromDOM`
+     **/
+
+    // ! \ This function uses the DOM - NO SSR (only trigger from beforeMount and later).
     toggle (e) {
-      let shouldShowTooltip = this.showTooltip
-      if ('ontouchstart' in window) {
+      let shouldShowTooltip = this.detachableVisible
+      if (typeof window !== 'undefined' && 'ontouchstart' in window) {
         if (e.type === 'click') shouldShowTooltip = !shouldShowTooltip
       }
       else if (e.type === 'click' && this.showOnClick) shouldShowTooltip = !shouldShowTooltip
@@ -197,129 +182,101 @@ export default {
 
       this.timeoutId = clearTimeout(this.timeoutId)
       if (shouldShowTooltip) {
-        this.coordinates = this.getCoordinates(e)
-        // In `getCoordinates` accessing the tooltip computed styles takes a few ms (less than 10ms),
-        // if we don't postpone the tooltip apparition it will start transition from a visible tooltip and
-        // thus will not transition.
-        this.timeoutId = setTimeout(() => {
-          this.showTooltip = true
-          this.$emit('update:modelValue', true)
-          this.$emit('input', true)
-          this.$emit('open')
-        }, 10)
-      }
-      else {
-        this.showTooltip = false
-        this.$emit('update:modelValue', false)
-        this.$emit('input', false)
-        this.$emit('close')
-      }
-    },
-
-    getCoordinates () {
-      const { top, left, width, height } = this.activatorEl.getBoundingClientRect()
-      let coords = { top, left, width, height }
+        this.$emit('update:modelValue', (this.detachableVisible = true))
+        this.$emit('input', true)
+        this.$emit('open')
 
-      if (!this.fixed) {
-        const { top: targetTop, left: targetLeft } = this.tooltipParentEl.getBoundingClientRect()
-        coords = { ...coords, top: top - targetTop, left: left - targetLeft }
+        this.open(e)
       }
+      else this.close()
+    },
 
-      const tooltip = this.tooltipEl
+    // ! \ This function uses the DOM - NO SSR (only trigger from beforeMount and later).
+    async open (e) {
+      this.detachableVisible = true
+      await this.insertInDOM()
 
-      // 1. First display the tooltip but hide it (So we can get its dimension).
-      tooltip.style.visibility = 'hidden'
-      tooltip.style.display = 'table'
-      const computedStyles = window.getComputedStyle(tooltip, null)
+      if (this.minWidth === 'activator') this.activatorWidth = this.activatorEl.offsetWidth
 
-      // Keep fully in viewport.
-      // --------------------------------------------------
-      if (this.position === 'top' && ((top - tooltip.offsetHeight) < 0)) {
-        const margin = -parseInt(computedStyles.getPropertyValue('margin-top'))
-        coords.top -= top - tooltip.offsetHeight - margin - marginFromWindowSide
-      }
-      else if (this.position === 'left' && left - tooltip.offsetWidth < 0) {
-        const margin = -parseInt(computedStyles.getPropertyValue('margin-left'))
-        coords.left -= left - tooltip.offsetWidth - margin - marginFromWindowSide
-      }
-      else if (this.position === 'right' && left + width + tooltip.offsetWidth > window.innerWidth) {
-        const margin = parseInt(computedStyles.getPropertyValue('margin-left'))
-        coords.left -= left + width + tooltip.offsetWidth - window.innerWidth + margin + marginFromWindowSide
-      }
-      else if (this.position === 'bottom' && top + height + tooltip.offsetHeight > window.innerHeight) {
-        const margin = parseInt(computedStyles.getPropertyValue('margin-top'))
-        coords.top -= top + height + tooltip.offsetHeight - window.innerHeight + margin + marginFromWindowSide
-      }
-      // --------------------------------------------------
-
-      // 2. Update left & top if there is a custom transition.
-      // Tooltip position relies on transform translate, the custom animation may override the transform
-      // property so do without it and subtract half width or height manually.
-      if (this.transition) {
-        // If tooltip is on top or bottom.
-        if (['top', 'bottom'].includes(this.position)) coords.left -= tooltip.offsetWidth / 2
-        // If tooltip is on left or right.
-        if (['left', 'right'].includes(this.position)) coords.top -= tooltip.offsetHeight / 2
-
-        if (this.position === 'left') coords.left -= tooltip.offsetWidth
-        if (this.position === 'top') coords.top -= tooltip.offsetHeight
-      }
+      if (!this.noPosition) this.computeDetachableCoords(e)
 
-      // 3. Hide the tooltip again so the transition happens correctly.
-      tooltip.style.visibility = null
-      tooltip.style.display = 'none'
+      // In `getActivatorCoordinates` accessing the tooltip computed styles takes a few ms (less than 10ms),
+      // if we don't postpone the Tooltip apparition it will start transition from a visible tooltip and
+      // thus will not transition.
+      this.timeoutId = setTimeout(() => {
+        this.$emit('update:modelValue', true)
+        this.$emit('input', true)
+        this.$emit('open')
+      }, 0)
 
-      return coords
+      if (!this.persistent) document.addEventListener('mousedown', this.onOutsideMousedown)
+      if (!this.noPosition) window.addEventListener('resize', this.onResize)
     },
 
-    insertTooltip () {
-      const wrapper = this.$refs.wrapper
-
-      // Unwrap the activator element.
-      wrapper.parentNode.insertBefore(this.activatorEl, wrapper)
-
-      // Move the tooltip elsewhere in the DOM.
-      // wrapper.parentNode.insertBefore(this.tooltipEl, wrapper)
-      // this.tooltipEl is set in the dynamic ref.
-      this.detachToTarget.appendChild(this.tooltipEl)
-    },
+    /**
+     * Closes the tooltip. Can happen on:
+     * - click of activator
+     * - hover outside if showOnHover
+     * - click inside tooltip if hideOnTooltipClick.
+     * / ! \ This function uses the DOM - NO SSR (only trigger from beforeMount and later).
+     *
+     * @param {Boolean} force when showOnHover is set to true, hovering tooltip should keep it open.
+     *                        But if hideOnTooltipClick is also set to true, this should force close
+     *                        even while hovering the tooltip.
+     */
+    async close (force = false) {
+      // Might be already closed.
+      // E.g. showOnHover & hideOnTooltipClick: on click, force hide then mouseleave is also firing.
+      if (!this.detachableVisible) return
+
+      if (this.showOnHover && !force) {
+        await new Promise(resolve => setTimeout(resolve, 10))
+        if (this.showOnHover && this.hoveringActivator) return
+      }
 
-    removeTooltip () {
-      if (this.tooltipEl && this.tooltipEl.parentNode) this.tooltipEl.remove()
+      this.$emit('update:modelValue', (this.detachableVisible = false))
+      this.$emit('input', false)
+      this.$emit('close')
+      // Remove the mousedown listener if the tooltip got closed without a mousedown outside of the tooltip.
+      document.removeEventListener('mousedown', this.onOutsideMousedown)
+      window.removeEventListener('resize', this.onResize)
     }
   },
 
   mounted () {
-    this.activatorEl = this.$refs.wrapper.firstElementChild
-    if (this.detachTo) this.insertTooltip()
+    const wrapper = this.$el
+    this.activatorEl = wrapper.firstElementChild
+
+    // Unwrap the activator element.
+    wrapper.parentNode.insertBefore(this.activatorEl, wrapper)
 
     if (this.modelValue) this.toggle({ type: 'click', target: this.activatorEl })
   },
 
   beforeUnmount () {
-    this.removeTooltip()
+    this.removeFromDOM()
 
     if (this.activatorEl && this.activatorEl.parentNode) this.activatorEl.remove()
   },
 
   watch: {
     modelValue (bool) {
-      if (bool !== this.showTooltip) this.toggle({ type: 'click', target: this.activatorEl })
+      if (bool !== this.detachableVisible) this.toggle({ type: 'click', target: this.activatorEl })
     },
     detachTo () {
-      this.removeTooltip()
-      this.insertTooltip()
+      this.removeFromDOM()
+      this.insertInDOM()
+    },
+    appendTo () {
+      this.removeFromDOM()
+      this.insertInDOM()
     }
   }
 }
 </script>
 
 <style lang="scss">
-.w-tooltip-wrap {
-  display: none;
-
-  &--attached {display: inline-block;position: relative;}
-}
+.w-tooltip-wrap {display: none;}
 
 .w-tooltip {
   // Fix Safari where `width: max-content` does not take padding and border into consideration.
@@ -347,113 +304,22 @@ export default {
   &--shadow {box-shadow: $box-shadow;}
   &--no-border {border: none;}
 
-  &--top {
-    transform: translate(-50%, -100%);
-    margin-top: -3 * $base-increment;
-  }
-  &--bottom {
-    transform: translateX(-50%);
-    margin-top: 3 * $base-increment;
-  }
-  &--left {
-    transform: translate(-100%, -50%);
-    margin-left: -3 * $base-increment;
-  }
-  &--right {
-    transform: translateY(-50%);
-    margin-left: 3 * $base-increment;
-  }
+  &--top {margin-top: -3 * $base-increment;}
+  &--bottom {margin-top: 3 * $base-increment;}
+  &--left {margin-left: -3 * $base-increment;}
+  &--right {margin-left: 3 * $base-increment;}
 
   &--custom-transition {transform: none;}
 
-  &:after {
-    content: '';
-    position: absolute;
-    width: 0;
-    height: 0;
-    border: 6px solid transparent;
-  }
-  &--top:after {
-    top: 100%;
-    left: 50%;
-    border-top-color: $tooltip-bg-color;
-    transform: translateX(-50%);
-    margin-top: 1px;
-  }
-  &--bottom:after {
-    bottom: 100%;
-    left: 50%;
-    border-bottom-color: $tooltip-bg-color;
-    transform: translateX(-50%);
-    margin-bottom: 1px;
-  }
-  &--left:after {
-    left: 100%;
-    top: 50%;
-    border-left-color: $tooltip-bg-color;
-    transform: translateY(-50%);
-    margin-left: 1px;
-  }
-  &--right:after {
-    right: 100%;
-    top: 50%;
-    border-right-color: $tooltip-bg-color;
-    transform: translateY(-50%);
-    margin-right: 1px;
-  }
-
   // Tooltip without border.
-  // --------------------------------------------------------
-  &--no-border.w-tooltip--top:after {margin-top: -1px;border-top-color: inherit;}
-  &--no-border.w-tooltip--bottom:after {margin-bottom: -1px;border-bottom-color: inherit;}
-  &--no-border.w-tooltip--left:after {margin-left: -1px;border-left-color: inherit;}
-  &--no-border.w-tooltip--right:after {margin-right: -1px;border-right-color: inherit;}
+  &--no-border {
+    @include triangle(var(--w-tooltip-bg-color), '.w-tooltip', 7px, 0);
+  }
 
   // Tooltip with border.
-  // --------------------------------------------------------
-  &:not(&--no-border).w-tooltip--top:after {margin-top: -1px;}
-  &:not(&--no-border).w-tooltip--bottom:after {margin-bottom: -1px;}
-  &:not(&--no-border).w-tooltip--left:after {margin-left: -1px;}
-  &:not(&--no-border).w-tooltip--right:after {margin-right: -1px;}
-
   &:not(&--no-border) {
-    &:before {
-      content: '';
-      position: absolute;
-      width: 0;
-      height: 0;
-      border: 7px solid transparent;
-    }
-    &.w-tooltip--top:before {
-      top: 100%;
-      left: 50%;
-      border-top-color: inherit;
-      transform: translateX(-50%);
-      margin-top: 0;
-    }
-    &.w-tooltip--bottom:before {
-      bottom: 100%;
-      left: 50%;
-      border-bottom-color: inherit;
-      transform: translateX(-50%);
-      margin-bottom: 0;
-    }
-    &.w-tooltip--left:before {
-      left: 100%;
-      top: 50%;
-      border-left-color: inherit;
-      transform: translateY(-50%);
-      margin-left: 0;
-    }
-    &.w-tooltip--right:before {
-      right: 100%;
-      top: 50%;
-      border-right-color: inherit;
-      transform: translateY(-50%);
-      margin-right: 0;
-    }
+    @include triangle(var(--w-tooltip-bg-color), '.w-tooltip', 7px);
   }
-  // --------------------------------------------------------
 }
 
 // Transitions.