wave-ui 2.28.0 → 2.31.0

package/src/wave-ui/mixins/detachable.js

@@ -0,0 +1,321 @@
+/**
+ * A detachable element is an element that can be appended to another DOM node
+ * (but keeping data-driven Vue DOM refreshes).
+ * This mixin is used by w-tooltip & w-menu.
+ */
+
+import { consoleWarn } from '../utils/console'
+
+export default {
+  props: {
+    // Position.
+    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 },
+    alignTop: { type: Boolean },
+    alignBottom: { type: Boolean },
+    alignLeft: { type: Boolean },
+    alignRight: { type: Boolean },
+    noPosition: { type: Boolean },
+    zIndex: { type: [Number, String, Boolean] },
+    activator: { type: String } // Optionally designate an external activator.
+  },
+
+  data: () => ({
+    // The event listeners handlers have to be removed the exact same way they have been attached.
+    // Since the handler functions have variables that change after hot-reload, keep them exactly
+    // as is in an array so we can delete them on destroy.
+    // This only applies to the activatorEventHandlers, the other events listeners can be removed
+    // normally.
+    docAEventListenersHandlers: []
+  }),
+
+  computed: {
+    // DOM element to attach tooltip/menu to.
+    // ! \ This computed uses the DOM - NO SSR (only trigger from beforeMount and later).
+    appendToTarget () {
+      const defaultTarget = '.w-app'
+
+      // Convert deprecated prop to renamed one.
+      if (this.detachTo && !this.appendTo) {
+        consoleWarn(`The ${this.$options.name} prop \`detach-to\` is deprecated. You can replace it with \`append-to\`.`, this)
+      }
+
+      let target = this.appendTo || this.detachTo || defaultTarget
+      if (target === true) target = defaultTarget
+      else if (this.appendTo === 'activator') target = this.$el.previousElementSibling
+      else if (target && !['object', 'string'].includes(typeof target)) target = defaultTarget
+      else if (typeof target === 'object' && !target.nodeType) {
+        target = defaultTarget
+        consoleWarn(`Invalid node provided in ${this.$options.name} \`append-to\`. Falling back to .w-app.`, this)
+      }
+      if (typeof target === 'string') target = document.querySelector(target)
+
+      if (!target) {
+        consoleWarn(`Unable to locate ${this.appendTo ? `target ${this.appendTo}` : defaultTarget}`, this)
+        target = document.querySelector(defaultTarget)
+      }
+
+      return target
+    },
+
+    // DOM element that will receive the tooltip/menu.
+    // ! \ This computed uses the DOM - NO SSR (only trigger from beforeMount and later).
+    detachableParentEl () {
+      return this.appendToTarget
+    },
+
+    hasSeparateActivator () {
+      return !this.$slots.activator && typeof this.activator === 'string'
+    },
+
+    activatorEl: {
+      get () {
+        if (this.hasSeparateActivator) return document.querySelector(this.activator)
+        return this.$el.firstElementChild
+      },
+      set () {
+
+      }
+    },
+
+    position () {
+      return (
+        (this.top && 'top') ||
+        (this.bottom && 'bottom') ||
+        (this.left && 'left') ||
+        (this.right && 'right') ||
+        'bottom'
+      )
+    },
+
+    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') ||
+        ''
+      )
+    }
+  },
+
+  methods: {
+    // ! \ This function uses the DOM - NO SSR (only trigger from beforeMount and later).
+    getActivatorCoordinates (e) {
+      // Get the activator coordinates relative to window.
+      const { top, left, width, height } = (e ? e.target : this.activatorEl).getBoundingClientRect()
+      let coords = { top, left, width, height }
+
+      // If absolute position, adjust top & left.
+      if (!this.fixed) {
+        const { top: targetTop, left: targetLeft } = this.detachableParentEl.getBoundingClientRect()
+        const computedStyles = window.getComputedStyle(this.detachableParentEl, null)
+        coords = {
+          ...coords,
+          top: top - targetTop + this.detachableParentEl.scrollTop - parseInt(computedStyles.getPropertyValue('border-top-width')),
+          left: left - targetLeft + this.detachableParentEl.scrollLeft - parseInt(computedStyles.getPropertyValue('border-left-width'))
+        }
+      }
+
+      return coords
+    },
+
+    // ! \ This function uses the DOM - NO SSR (only trigger from beforeMount and later).
+    computeDetachableCoords (e) {
+      // Get the activator coordinates.
+      let { top, left, width, height } = this.getActivatorCoordinates(e)
+
+      // 1. First display the menu but hide it (So we can get its dimension).
+      // --------------------------------------------------
+      this.detachableEl.style.visibility = 'hidden'
+      this.detachableEl.style.display = 'flex'
+      const computedStyles = window.getComputedStyle(this.detachableEl, null)
+
+      // 2. Position the menu top, left, right, bottom and apply chosen alignment.
+      // --------------------------------------------------
+      // Subtract half or full activator width or height and menu width or height according to the
+      // menu alignment.
+      // Note: the menu position relies on transform translate, the custom animation may override the
+      // css transform property so do without it i.e. no translateX(-50%), and recalculate top & left
+      // manually.
+      switch (this.position) {
+        case 'top': {
+          top -= this.detachableEl.offsetHeight
+          if (this.alignRight) {
+            // left: 100% of activator.
+            left += width - this.detachableEl.offsetWidth +
+                    parseInt(computedStyles.getPropertyValue('border-right-width'))
+          }
+          else if (!this.alignLeft) left += (width - this.detachableEl.offsetWidth) / 2 // left: 50% of activator - half menu width.
+          break
+        }
+        case 'bottom': {
+          top += height
+          if (this.alignRight) {
+            // left: 100% of activator.
+            left += width - this.detachableEl.offsetWidth +
+                    parseInt(computedStyles.getPropertyValue('border-right-width'))
+          }
+          else if (!this.alignLeft) left += (width - this.detachableEl.offsetWidth) / 2 // left: 50% of activator - half menu width.
+          break
+        }
+        case 'left': {
+          left -= this.detachableEl.offsetWidth
+          if (this.alignBottom) top += height - this.detachableEl.offsetHeight
+          else if (!this.alignTop) top += (height - this.detachableEl.offsetHeight) / 2 // top: 50% of activator - half menu height.
+          break
+        }
+        case 'right': {
+          left += width
+          if (this.alignBottom) {
+            top += height - this.detachableEl.offsetHeight +
+                   parseInt(computedStyles.getPropertyValue('margin-top'))
+          }
+          else if (!this.alignTop) {
+            top += (height - this.detachableEl.offsetHeight) / 2 + // top: 50% of activator - half menu height.
+                   parseInt(computedStyles.getPropertyValue('margin-top'))
+          }
+          break
+        }
+      }
+
+      // 3. Keep fully in viewport.
+      // @todo: do this.
+      // --------------------------------------------------
+      // if (this.position === 'top' && ((top - this.detachableEl.offsetHeight) < 0)) {
+      //   const margin = - parseInt(computedStyles.getPropertyValue('margin-top'))
+      //   top -= top - this.detachableEl.offsetHeight - margin - marginFromWindowSide
+      // }
+      // else if (this.position === 'left' && left - this.detachableEl.offsetWidth < 0) {
+      //   const margin = - parseInt(computedStyles.getPropertyValue('margin-left'))
+      //   left -= left - this.detachableEl.offsetWidth - margin - marginFromWindowSide
+      // }
+      // else if (this.position === 'right' && left + width + this.detachableEl.offsetWidth > window.innerWidth) {
+      //   const margin = parseInt(computedStyles.getPropertyValue('margin-left'))
+      //   left -= left + width + this.detachableEl.offsetWidth - window.innerWidth + margin + marginFromWindowSide
+      // }
+      // else if (this.position === 'bottom' && top + height + this.detachableEl.offsetHeight > window.innerHeight) {
+      //   const margin = parseInt(computedStyles.getPropertyValue('margin-top'))
+      //   top -= top + height + this.detachableEl.offsetHeight - window.innerHeight + margin + marginFromWindowSide
+      // }
+
+      // 4. Hide the menu again so the transition happens correctly.
+      // --------------------------------------------------
+      this.detachableEl.style.visibility = null
+
+      // The menu coordinates are also recalculated while resizing window with open menu: keep the menu visible.
+      if (!this.detachableVisible) this.detachableEl.style.display = 'none'
+
+      this.detachableCoords = { top, left }
+    },
+
+    onResize () {
+      if (this.minWidth === 'activator') this.activatorWidth = this.activatorEl.offsetWidth
+      this.computeDetachableCoords()
+    },
+
+    // ! \ This function uses the DOM - NO SSR (only trigger from beforeMount and later).
+    onOutsideMousedown (e) {
+      if (!this.detachableEl.contains(e.target) && !this.activatorEl.contains(e.target)) {
+        this.$emit('update:modelValue', (this.detachableVisible = false))
+        this.$emit('input', false)
+        this.$emit('close')
+        document.removeEventListener('mousedown', this.onOutsideMousedown)
+        window.removeEventListener('resize', this.onResize)
+      }
+    },
+
+    insertInDOM () {
+      return new Promise(resolve => {
+        this.$nextTick(() => {
+          this.detachableEl = this.$refs.detachable?.$el || this.$refs.detachable
+
+          // Move the tooltip/menu elsewhere in the DOM.
+          // wrapper.parentNode.insertBefore(this.detachableEl, wrapper)
+          if (this.detachableEl) this.appendToTarget.appendChild(this.detachableEl)
+          resolve()
+        })
+      })
+    },
+
+    removeFromDOM () {
+      document.removeEventListener('mousedown', this.onOutsideMousedown)
+      window.removeEventListener('resize', this.onResize)
+      if (this.detachableEl && this.detachableEl.parentNode) {
+        this.detachableVisible = false
+        this.detachableEl.remove()
+        this.detachableEl = null
+      }
+    }
+  },
+
+  mounted () {
+    const wrapper = this.$el
+
+    // Unwrap the activator element if the activator is in the activator slot.
+    if (this.$slots.activator) wrapper.parentNode.insertBefore(this.activatorEl, wrapper)
+
+    // If the activator is external, add event listeners to the document and check the target is
+    // the activator when toggling.
+    // This way, the activator can be a future DOM element, that is not yet in the DOM.
+    else if (this.activator) {
+      Object.entries(this.activatorEventHandlers).forEach(([eventName, handler]) => {
+        // Convert mouseenter to mouseover & mouseleave to mouseout because we are attaching
+        // event to the document, so it can accept future nodes.
+        eventName = eventName.replace('mouseenter', 'mouseover').replace('mouseleave', 'mouseout')
+        const handlerWrap = e => {
+          if (e.target?.matches && e.target.matches(this.activator)) handler(e)
+        }
+        document.addEventListener(eventName, handlerWrap)
+        // The event listeners handlers have to be removed the exact same way they have been attached.
+        // Since the handler functions have variables that change after hot-reload, keep them exactly
+        // as is in an array so we can delete them on destroy.
+        this.docAEventListenersHandlers.push({ eventName, handler: handlerWrap })
+      })
+    }
+
+    // Unwrap the overlay if any.
+    if (this.overlay) {
+      this.overlayEl = this.$refs.overlay?.$el
+      wrapper.parentNode.insertBefore(this.overlayEl, wrapper)
+    }
+
+    if (this.modelValue) this.toggleMenu({ type: 'click', target: this.activatorEl })
+  },
+
+  beforeUnmount () {
+    this.close()
+
+    this.removeFromDOM()
+
+    // Remove the event listeners the exact same way they have been defined.
+    // Fixes issues on hot-reloading.
+    if (this.docAEventListenersHandlers.length) {
+      this.docAEventListenersHandlers.forEach(({ eventName, handler }) => {
+        document.removeEventListener(eventName, handler)
+      })
+    }
+
+    if (this.overlay && this.overlayEl.parentNode) this.overlayEl.remove()
+    if (this.activatorEl?.parentNode && this.$slots.activator) this.activatorEl.remove()
+  },
+
+  watch: {
+    modelValue (bool) {
+      if (!!bool !== this.detachableVisible) this.toggle({ type: 'click', target: this.activatorEl })
+    },
+    detachTo () {
+      this.removeFromDOM()
+      this.insertInDOM()
+    },
+    appendTo () {
+      this.removeFromDOM()
+      this.insertInDOM()
+    }
+  }
+}

package/src/wave-ui/scss/_mixins.scss

@@ -54,10 +54,24 @@
       margin-right: 0;
     }
 
-    &#{$selector}--align-top:before {transform: none;top: (2 * $base-increment) - 1px;}
-    &#{$selector}--align-bottom:before {transform: none;top: auto;bottom: (2 * $base-increment) - 1px;}
-    &#{$selector}--align-left:before {transform: none;left: (2 * $base-increment) - 1px;}
-    &#{$selector}--align-right:before {transform: none;left: auto;right: (2 * $base-increment) - 1px;}
+    &#{$selector}--align-top:before {
+      transform: none;
+      top: (2 * $base-increment) - 1px;
+    }
+    &#{$selector}--align-bottom:before {
+      transform: none;
+      top: auto;
+      bottom: (2 * $base-increment) - 1px;
+    }
+    &#{$selector}--align-left:before {
+      transform: none;
+      left: (2 * $base-increment) - 1px;
+    }
+    &#{$selector}--align-right:before {
+      transform: none;
+      left: auto;
+      right: (2 * $base-increment) - 1px;
+    }
   }
 
   // The colored triangle on top of `:before`.

package/src/wave-ui/scss/_variables.scss

@@ -11,7 +11,7 @@ $css-scope: '.w-app' !default; // Allows control on CSS rules priority.
 // True by default. False allows you to use an external CSS library (like Tailwind).
 $use-layout-classes: true !default;
 
-$base-font-size: 14px !default;
+$base-font-size: 14px !default; // Must be a px unit.
 $base-increment: round(divide($base-font-size, 4)) !default;
 $layout-padding: $base-increment * 4 !default; // Applied on the .content-wrap tag.
 $border-radius: 3px !default;

package/src/wave-ui/utils/index.js

@@ -6,6 +6,6 @@
  */
 export const objectifyClasses = (classes = {}) => {
   if (typeof classes === 'string') classes = { [classes]: true }
-  else if (typeof classes === 'array') classes = { [classes.join(' ')]: true }
+  else if (Array.isArray(classes)) classes = { [classes.join(' ')]: true }
   return classes
 }