@saasmakers/ui 1.4.51 → 1.4.52

package/app/components/layout/LayoutBottomSheet.vue

@@ -9,11 +9,10 @@ defineSlots<{
 
 const closeThresholdRatio = 0.25
 const dragMoveThreshold = 8
-const focusableSelector = 'a[href], button:not([disabled]), textarea:not([disabled]), input:not([disabled]), select:not([disabled]), [tabindex]:not([tabindex="-1"])'
 const visible = defineModel<boolean>({ default: false })
 const contentRef = ref<HTMLElement>()
-const focusTrigger = ref<HTMLElement>()
 const panelRef = ref<HTMLElement>()
+const { release: onAfterLeave } = useDialog(visible, panelRef, { ignoreClass: 'layout-bottom-sheet' })
 
 const drag = reactive({
   closing: false,
@@ -24,56 +23,10 @@ const drag = reactive({
   startY: 0,
 })
 
-let savedBodyOverflow = ''
-let savedBodyPaddingRight = ''
-
-const fixedElementPadding = new Map<HTMLElement, string>()
-
 const closeThreshold = computed(() => {
   return (panelRef.value?.offsetHeight ?? 320) * closeThresholdRatio
 })
 
-function getFocusableElements(container: HTMLElement) {
-  return Array.from(container.querySelectorAll<HTMLElement>(focusableSelector))
-    .filter((element) => {
-      return element.offsetParent !== null || getComputedStyle(element).position === 'fixed'
-    })
-}
-
-function lockBodyScroll() {
-  const scrollbarWidth = window.innerWidth - document.documentElement.clientWidth
-
-  savedBodyOverflow = document.body.style.overflow
-  savedBodyPaddingRight = document.body.style.paddingRight
-  document.body.style.overflow = 'hidden'
-
-  if (scrollbarWidth > 0) {
-    document.body.style.paddingRight = `${scrollbarWidth}px`
-
-    for (const element of document.querySelectorAll('body *')) {
-      if (!(element instanceof HTMLElement)) {
-        continue
-      }
-
-      if (element.classList.contains('layout-bottom-sheet')) {
-        continue
-      }
-
-      const { position } = getComputedStyle(element)
-
-      if (position !== 'fixed' && position !== 'sticky') {
-        continue
-      }
-
-      fixedElementPadding.set(element, element.style.paddingRight)
-
-      const currentPadding = Number.parseFloat(getComputedStyle(element).paddingRight) || 0
-
-      element.style.paddingRight = `${currentPadding + scrollbarWidth}px`
-    }
-  }
-}
-
 function onClose() {
   visible.value = false
 }
@@ -92,34 +45,6 @@ function onContentPointerDown(event: PointerEvent) {
   drag.startY = event.clientY
 }
 
-function onFocusTrap(event: KeyboardEvent) {
-  if (event.key !== 'Tab' || !panelRef.value) {
-    return
-  }
-
-  const focusableElements = getFocusableElements(panelRef.value)
-
-  if (focusableElements.length === 0) {
-    event.preventDefault()
-    panelRef.value.focus()
-
-    return
-  }
-
-  const firstElement = focusableElements[0]
-  const lastElement = focusableElements[focusableElements.length - 1]
-  const activeElement = document.activeElement
-
-  if (event.shiftKey && activeElement === firstElement) {
-    event.preventDefault()
-    lastElement.focus()
-  }
-  else if (!event.shiftKey && activeElement === lastElement) {
-    event.preventDefault()
-    firstElement.focus()
-  }
-}
-
 function onHeaderPointerDown(event: PointerEvent) {
   if (drag.closing) {
     return
@@ -136,26 +61,6 @@ function onHeaderPointerDown(event: PointerEvent) {
   handle.setPointerCapture(event.pointerId)
 }
 
-function onKeydown(event: KeyboardEvent) {
-  if (!visible.value) {
-    return
-  }
-
-  if (event.key === 'Escape') {
-    onClose()
-  }
-}
-
-function onPanelAfterLeave() {
-  if (import.meta.client) {
-    unlockBodyScroll()
-    window.removeEventListener('keydown', onFocusTrap)
-    focusTrigger.value?.focus()
-
-    focusTrigger.value = undefined
-  }
-}
-
 function onPanelTransitionEnd(event: TransitionEvent) {
   if (event.propertyName !== 'transform' || !drag.closing) {
     return
@@ -262,53 +167,10 @@ function resetPendingDrag() {
   drag.startedFromContent = false
 }
 
-function unlockBodyScroll() {
-  document.body.style.overflow = savedBodyOverflow
-  document.body.style.paddingRight = savedBodyPaddingRight
-
-  for (const [element, paddingRight] of fixedElementPadding) {
-    element.style.paddingRight = paddingRight
-  }
-
-  fixedElementPadding.clear()
-}
-
-watch(visible, async (isVisible) => {
-  if (import.meta.client && isVisible) {
-    focusTrigger.value = document.activeElement instanceof HTMLElement ? document.activeElement : undefined
-
-    lockBodyScroll()
-
-    await nextTick()
-
-    if (panelRef.value) {
-      const focusableElements = getFocusableElements(panelRef.value)
-
-      if (focusableElements.length > 0) {
-        focusableElements[0].focus()
-      }
-      else {
-        panelRef.value.focus()
-      }
-
-      window.addEventListener('keydown', onFocusTrap)
-    }
-  }
-
+watch(visible, (isVisible) => {
   if (!isVisible) {
     resetDragState()
   }
-}, { immediate: true })
-
-onMounted(() => window.addEventListener('keydown', onKeydown))
-
-onUnmounted(() => {
-  window.removeEventListener('keydown', onKeydown)
-  window.removeEventListener('keydown', onFocusTrap)
-
-  if (import.meta.client) {
-    unlockBodyScroll()
-  }
 })
 </script>
 
@@ -345,7 +207,7 @@ onUnmounted(() => {
         leave-active-class="transition-transform duration-300 ease motion-reduce:transition-none motion-reduce:duration-0"
         leave-from-class="translate-y-0"
         leave-to-class="translate-y-full motion-reduce:translate-y-0"
-        @after-leave="onPanelAfterLeave"
+        @after-leave="onAfterLeave"
       >
         <div
           v-if="visible"

package/app/components/layout/LayoutModal.vue

@@ -0,0 +1,65 @@
+<script lang="ts" setup>
+import type { LayoutModal } from '../../types/layout'
+
+withDefaults(defineProps<LayoutModal>(), { title: undefined })
+
+defineSlots<{
+  default?: () => VNode[]
+}>()
+
+const visible = defineModel<boolean>({ default: false })
+const panelRef = ref<HTMLElement>()
+const { release: onAfterLeave } = useDialog(visible, panelRef, { ignoreClass: 'layout-modal' })
+
+function onClose() {
+  visible.value = false
+}
+</script>
+
+<template>
+  <ClientOnly>
+    <Teleport to="body">
+      <Transition
+        enter-active-class="transition-opacity duration-300 ease motion-reduce:transition-none motion-reduce:duration-0"
+        enter-from-class="opacity-0 motion-reduce:opacity-100"
+        enter-to-class="opacity-100"
+        leave-active-class="transition-opacity duration-300 ease motion-reduce:transition-none motion-reduce:duration-0"
+        leave-from-class="opacity-100"
+        leave-to-class="opacity-0 motion-reduce:opacity-100"
+      >
+        <div
+          v-if="visible"
+          aria-hidden="true"
+          class="layout-modal fixed inset-0 z-[60] bg-black/50"
+          @click="onClose"
+        />
+      </Transition>
+
+      <Transition
+        enter-active-class="transition duration-200 ease motion-reduce:transition-none motion-reduce:duration-0"
+        enter-from-class="opacity-0 scale-95 motion-reduce:scale-100 motion-reduce:opacity-100"
+        enter-to-class="opacity-100 scale-100"
+        leave-active-class="transition duration-200 ease motion-reduce:transition-none motion-reduce:duration-0"
+        leave-from-class="opacity-100 scale-100"
+        leave-to-class="opacity-0 scale-95 motion-reduce:scale-100 motion-reduce:opacity-100"
+        @after-leave="onAfterLeave"
+      >
+        <div
+          v-if="visible"
+          class="layout-modal pointer-events-none fixed inset-0 z-[60] flex items-center justify-center p-4"
+        >
+          <div
+            ref="panelRef"
+            :aria-label="title"
+            aria-modal="true"
+            class="pointer-events-auto max-h-[85dvh] max-w-md w-full overflow-y-auto rounded-2xl bg-white p-5 text-gray-900 shadow-lg dark:bg-gray-900 dark:text-gray-100"
+            role="dialog"
+            tabindex="-1"
+          >
+            <slot />
+          </div>
+        </div>
+      </Transition>
+    </Teleport>
+  </ClientOnly>
+</template>

package/app/composables/useDialog.ts

@@ -0,0 +1,150 @@
+interface UseDialogOptions {
+  ignoreClass: string
+}
+
+export default function useDialog(
+  visible: Ref<boolean>,
+  panelRef: Ref<HTMLElement | undefined>,
+  options: UseDialogOptions,
+) {
+  const focusableSelector = 'a[href], button:not([disabled]), textarea:not([disabled]), input:not([disabled]), select:not([disabled]), [tabindex]:not([tabindex="-1"])'
+  const focusTrigger = ref<HTMLElement>()
+  const fixedElementPadding = new Map<HTMLElement, string>()
+
+  let savedBodyOverflow = ''
+  let savedBodyPaddingRight = ''
+
+  function getFocusableElements(container: HTMLElement) {
+    return Array.from(container.querySelectorAll<HTMLElement>(focusableSelector))
+      .filter((element) => {
+        return element.offsetParent !== null || getComputedStyle(element).position === 'fixed'
+      })
+  }
+
+  function lockBodyScroll() {
+    const scrollbarWidth = window.innerWidth - document.documentElement.clientWidth
+
+    savedBodyOverflow = document.body.style.overflow
+    savedBodyPaddingRight = document.body.style.paddingRight
+    document.body.style.overflow = 'hidden'
+
+    if (scrollbarWidth > 0) {
+      document.body.style.paddingRight = `${scrollbarWidth}px`
+
+      for (const element of document.querySelectorAll('body *')) {
+        if (!(element instanceof HTMLElement)) {
+          continue
+        }
+
+        // Skip the dialog's own teleported elements so they are not padded.
+        if (element.classList.contains(options.ignoreClass)) {
+          continue
+        }
+
+        const { position } = getComputedStyle(element)
+
+        if (position !== 'fixed' && position !== 'sticky') {
+          continue
+        }
+
+        fixedElementPadding.set(element, element.style.paddingRight)
+
+        const currentPadding = Number.parseFloat(getComputedStyle(element).paddingRight) || 0
+
+        element.style.paddingRight = `${currentPadding + scrollbarWidth}px`
+      }
+    }
+  }
+
+  function onFocusTrap(event: KeyboardEvent) {
+    if (event.key !== 'Tab' || !panelRef.value) {
+      return
+    }
+
+    const focusableElements = getFocusableElements(panelRef.value)
+
+    if (focusableElements.length === 0) {
+      event.preventDefault()
+      panelRef.value.focus()
+
+      return
+    }
+
+    const firstElement = focusableElements[0]
+    const lastElement = focusableElements[focusableElements.length - 1]
+    const activeElement = document.activeElement
+
+    if (event.shiftKey && activeElement === firstElement) {
+      event.preventDefault()
+      lastElement.focus()
+    }
+    else if (!event.shiftKey && activeElement === lastElement) {
+      event.preventDefault()
+      firstElement.focus()
+    }
+  }
+
+  function onKeydown(event: KeyboardEvent) {
+    if (visible.value && event.key === 'Escape') {
+      visible.value = false
+    }
+  }
+
+  function unlockBodyScroll() {
+    document.body.style.overflow = savedBodyOverflow
+    document.body.style.paddingRight = savedBodyPaddingRight
+
+    for (const [element, paddingRight] of fixedElementPadding) {
+      element.style.paddingRight = paddingRight
+    }
+
+    fixedElementPadding.clear()
+  }
+
+  // Restores the page state once the leave transition has finished.
+  function release() {
+    if (import.meta.client) {
+      unlockBodyScroll()
+      window.removeEventListener('keydown', onFocusTrap)
+      focusTrigger.value?.focus()
+
+      focusTrigger.value = undefined
+    }
+  }
+
+  watch(visible, async (isVisible) => {
+    if (import.meta.client && isVisible) {
+      focusTrigger.value = document.activeElement instanceof HTMLElement ? document.activeElement : undefined
+
+      lockBodyScroll()
+
+      await nextTick()
+
+      if (panelRef.value) {
+        const focusableElements = getFocusableElements(panelRef.value)
+
+        if (focusableElements.length > 0) {
+          focusableElements[0].focus()
+        }
+        else {
+          panelRef.value.focus()
+        }
+
+        window.addEventListener('keydown', onFocusTrap)
+      }
+    }
+  }, { immediate: true })
+
+  onMounted(() => window.addEventListener('keydown', onKeydown))
+
+  onUnmounted(() => {
+    window.removeEventListener('keydown', onKeydown)
+    window.removeEventListener('keydown', onFocusTrap)
+
+    if (import.meta.client) {
+      unlockBodyScroll()
+    }
+  })
+
+  return { release }
+}

package/app/types/global.d.ts

@@ -94,6 +94,7 @@ declare global {
 
   // Layout
   type LayoutBottomSheet = import('./layout').LayoutBottomSheet
+  type LayoutModal = import('./layout').LayoutModal
 
   // Project
   type LayerIconIcon = import('../composables/useLayerIcons').LayerIconIcon

package/app/types/layout.d.ts

@@ -1,3 +1,7 @@
 export interface LayoutBottomSheet {
   title?: string
 }
+
+export interface LayoutModal {
+  title?: string
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saasmakers/ui",
-  "version": "1.4.51",
+  "version": "1.4.52",
   "private": false,
   "description": "Reusable Nuxt UI components for SaaS Makers projects",
   "license": "MIT",