refactor: use @vueuse/core useEventListener composable in order to remove listeners easier

packages/radix-vue/src/DismissableLayer/utils.ts

@@ -1,4 +1,5 @@
 import { isClient } from '@vueuse/shared'
+import { useEventListener } from '@vueuse/core'
 import { handleAndDispatchCustomEvent } from '@/shared'
 import { type Ref, nextTick, ref, watchEffect } from 'vue'
 
@@ -30,12 +31,11 @@
     (targetLayer
     && mainLayer === targetLayer)
     || nodeList.indexOf(mainLayer) < nodeList.indexOf(targetLayer)
-  ) {
+  )
     return true
-  }
-  else {
+
+  else
     return false
-  }
 }
 
 /**
@@ -53,6 +53,9 @@
   const isPointerInsideDOMTree = ref(false)
   const handleClickRef = ref(() => {})
 
+  let ownerDocumentClickCleanup: ReturnType<typeof useEventListener>
+  let ownerDocumentPointerdownCleanup: ReturnType<typeof useEventListener>
+
   watchEffect((cleanupFn) => {
     if (!isClient)
       return
@@ -93,7 +96,7 @@
         if (event.pointerType === 'touch') {
           ownerDocument.removeEventListener('click', handleClickRef.value)
           handleClickRef.value = handleAndDispatchPointerDownOutsideEvent
-          ownerDocument.addEventListener('click', handleClickRef.value, {
+          ownerDocumentClickCleanup = useEventListener(ownerDocument, 'click', handleClickRef.value, {
             once: true,
           })
         }
@@ -104,7 +107,7 @@
       else {
         // We need to remove the event listener in case the outside click has been canceled.
         // See: https://github.com/radix-ui/primitives/issues/2171
-        ownerDocument.removeEventListener('click', handleClickRef.value)
+        ownerDocumentClickCleanup()
       }
       isPointerInsideDOMTree.value = false
     }
@@ -122,13 +125,12 @@
      * });
      */
     const timerId = window.setTimeout(() => {
-      ownerDocument.addEventListener('pointerdown', handlePointerDown)
+      ownerDocumentPointerdownCleanup = useEventListener(ownerDocument, 'pointerdown', handlePointerDown)
     }, 0)
 
     cleanupFn(() => {
       window.clearTimeout(timerId)
-      ownerDocument.removeEventListener('pointerdown', handlePointerDown)
-      ownerDocument.removeEventListener('click', handleClickRef.value)
+      ownerDocumentPointerdownCleanup()
     })
   })
 
@@ -148,6 +150,8 @@
   const ownerDocument: Document
     = element?.value?.ownerDocument ?? globalThis?.document
 
+  let ownerDocumentFocusinCleanup: ReturnType<typeof useEventListener>
+
   const isFocusInsideDOMTree = ref(false)
   watchEffect((cleanupFn) => {
     if (!isClient)
@@ -170,9 +174,7 @@
       }
     }
 
-    ownerDocument.addEventListener('focusin', handleFocus)
-
-    cleanupFn(() => ownerDocument.removeEventListener('focusin', handleFocus))
+    ownerDocumentFocusinCleanup = useEventListener(ownerDocument, 'focusin', handleFocus)
   })
 
   return {

packages/radix-vue/src/FocusScope/FocusScope.vue

@@ -35,6 +35,7 @@ export interface FocusScopeProps extends PrimitiveProps {
 
 <script setup lang="ts">
 import { nextTick, reactive, ref, watchEffect } from 'vue'
+import { useEventListener } from '@vueuse/core'
 import { isClient } from '@vueuse/shared'
 import {
   AUTOFOCUS_ON_MOUNT,
@@ -122,15 +123,14 @@ watchEffect((cleanupFn) => {
       focus(container)
   }
 
-  document.addEventListener('focusin', handleFocusIn)
-  document.addEventListener('focusout', handleFocusOut)
+  useEventListener(document, 'focusin', handleFocusIn)
+  useEventListener(document, 'focusout', handleFocusOut)
+
   const mutationObserver = new MutationObserver(handleMutations)
   if (container)
     mutationObserver.observe(container, { childList: true, subtree: true })
 
   cleanupFn(() => {
-    document.removeEventListener('focusin', handleFocusIn)
-    document.removeEventListener('focusout', handleFocusOut)
     mutationObserver.disconnect()
   })
 })
@@ -168,15 +168,17 @@ watchEffect(async (cleanupFn) => {
     const unmountEventHandler = (ev: Event) => {
       emits('unmountAutoFocus', ev)
     }
-    container.addEventListener(AUTOFOCUS_ON_UNMOUNT, unmountEventHandler)
+
+    const stop = useEventListener(container, AUTOFOCUS_ON_UNMOUNT, unmountEventHandler)
+
     container.dispatchEvent(unmountEvent)
 
     setTimeout(() => {
       if (!unmountEvent.defaultPrevented)
         focus(previouslyFocusedElement ?? document.body, { select: true })
 
       // we need to remove the listener after we `dispatchEvent`
-      container.removeEventListener(AUTOFOCUS_ON_UNMOUNT, unmountEventHandler)
+      stop()
 
       focusScopesStack.remove(focusScope)
     }, 0)

packages/radix-vue/src/HoverCard/HoverCardContentImpl.vue

@@ -10,6 +10,7 @@ export interface HoverCardContentImplProps extends PopperContentProps {}
 
 <script setup lang="ts">
 import { nextTick, onMounted, onUnmounted, ref, watchEffect } from 'vue'
+import { useEventListener } from '@vueuse/core'
 import { injectHoverCardRootContext } from './HoverCardRoot.vue'
 import { PopperContent } from '@/Popper'
 import { DismissableLayer } from '@/DismissableLayer'
@@ -63,15 +64,14 @@ function handlePointerUp() {
 }
 onMounted(() => {
   if (contentElement.value) {
-    document.addEventListener('pointerup', handlePointerUp)
+    useEventListener(document, 'pointerup', handlePointerUp)
 
     const tabbables = getTabbableNodes(contentElement.value)
     tabbables.forEach(tabbable => tabbable.setAttribute('tabindex', '-1'))
   }
 })
 
 onUnmounted(() => {
-  document.removeEventListener('pointerup', handlePointerUp)
   rootContext.hasSelectionRef.value = false
   rootContext.isPointerDownOnContentRef.value = false
 })

packages/radix-vue/src/NavigationMenu/NavigationMenuContentImpl.vue

@@ -15,6 +15,7 @@ export interface NavigationMenuContentImplProps extends DismissableLayerProps {}
 
 <script setup lang="ts">
 import { computed, ref, watchEffect } from 'vue'
+import { useEventListener } from '@vueuse/core'
 import { injectNavigationMenuContext } from './NavigationMenuRoot.vue'
 import {
   EVENT_ROOT_CONTENT_DISMISS,
@@ -107,7 +108,7 @@ function handlePointerDownOutside(ev: PointerDownOutsideEvent) {
   }
 }
 
-watchEffect((cleanupFn) => {
+watchEffect(() => {
   const content = currentElement.value
   if (menuContext.isRootMenu && content) {
     // Bubble dismiss to the root content node and focus its trigger
@@ -117,11 +118,8 @@ watchEffect((cleanupFn) => {
       if (content.contains(document.activeElement))
         itemContext.triggerRef.value?.focus()
     }
-    content.addEventListener(EVENT_ROOT_CONTENT_DISMISS, handleClose)
 
-    cleanupFn(() =>
-      content.removeEventListener(EVENT_ROOT_CONTENT_DISMISS, handleClose),
-    )
+    useEventListener(document, EVENT_ROOT_CONTENT_DISMISS, handleClose)
   }
 })
 

packages/radix-vue/src/ScrollArea/ScrollAreaScrollbarHover.vue

@@ -6,6 +6,7 @@ export interface ScrollAreaScrollbarHoverProps extends ScrollAreaScrollbarAutoPr
 
 <script setup lang="ts">
 import { onMounted, onUnmounted, ref } from 'vue'
+import { useEventListener } from '@vueuse/core'
 import { injectScrollAreaRootContext } from './ScrollAreaRoot.vue'
 import ScrollAreaScrollbarAuto from './ScrollAreaScrollbarAuto.vue'
 import { Presence } from '@/Presence'
@@ -38,18 +39,15 @@ onMounted(() => {
   const scrollArea = rootContext.scrollArea.value
 
   if (scrollArea) {
-    scrollArea.addEventListener('pointerenter', handlePointerEnter)
-    scrollArea.addEventListener('pointerleave', handlePointerLeave)
+    useEventListener(scrollArea, 'pointerenter', handlePointerEnter)
+    useEventListener(scrollArea, 'pointerleave', handlePointerLeave)
   }
 })
 
 onUnmounted(() => {
   const scrollArea = rootContext.scrollArea.value
-  if (scrollArea) {
+  if (scrollArea)
     window.clearTimeout(timeout)
-    scrollArea.removeEventListener('pointerenter', handlePointerEnter)
-    scrollArea.removeEventListener('pointerleave', handlePointerLeave)
-  }
 })
 </script>
 

packages/radix-vue/src/ScrollArea/ScrollAreaScrollbarImpl.vue

@@ -11,8 +11,8 @@ export interface ScrollAreaScrollbarImplProps {
 </script>
 
 <script setup lang="ts">
-import { onMounted, onUnmounted, ref } from 'vue'
-import { useResizeObserver } from '@vueuse/core'
+import { onMounted, ref } from 'vue'
+import { useEventListener, useResizeObserver } from '@vueuse/core'
 import { injectScrollAreaRootContext } from './ScrollAreaRoot.vue'
 import { injectScrollAreaScrollbarVisibleContext } from './ScrollAreaScrollbarVisible.vue'
 import { injectScrollAreaScrollbarContext } from './ScrollAreaScrollbar.vue'
@@ -83,10 +83,7 @@ function handleWheel(event: WheelEvent) {
 }
 
 onMounted(() => {
-  document.addEventListener('wheel', handleWheel, { passive: false })
-})
-onUnmounted(() => {
-  document.removeEventListener('wheel', handleWheel)
+  useEventListener(document, 'wheel', handleWheel, { passive: false })
 })
 
 function handleSizeChange() {

packages/radix-vue/src/ScrollArea/ScrollAreaScrollbarScroll.vue

@@ -6,7 +6,7 @@ export interface ScrollAreaScrollbarScrollProps {
 
 <script setup lang="ts">
 import { watchEffect } from 'vue'
-import { useDebounceFn } from '@vueuse/core'
+import { useDebounceFn, useEventListener } from '@vueuse/core'
 import { useStateMachine } from '../shared/useStateMachine'
 import { injectScrollAreaRootContext } from './ScrollAreaRoot.vue'
 import { injectScrollAreaScrollbarContext } from './ScrollAreaScrollbar.vue'
@@ -55,7 +55,7 @@ watchEffect((onCleanup) => {
 
 const debounceScrollEnd = useDebounceFn(() => dispatch('SCROLL_END'), 100)
 
-watchEffect((onCleanup) => {
+watchEffect(() => {
   const viewport = rootContext.viewport.value
   const scrollDirection = scrollbarContext.isHorizontal.value
     ? 'scrollLeft'
@@ -72,11 +72,8 @@ watchEffect((onCleanup) => {
       }
       prevScrollPos = scrollPos
     }
-    viewport.addEventListener('scroll', handleScroll)
 
-    onCleanup(() => {
-      viewport.removeEventListener('scroll', handleScroll)
-    })
+    useEventListener(viewport, 'scroll', handleScroll)
   }
 })
 </script>

packages/radix-vue/src/ScrollArea/ScrollAreaThumb.vue

@@ -7,7 +7,7 @@ export interface ScrollAreaThumbProps extends PrimitiveProps {}
 
 <script setup lang="ts">
 import { computed, onUnmounted, ref } from 'vue'
-import { watchOnce } from '@vueuse/core'
+import { useEventListener, watchOnce } from '@vueuse/core'
 import { Primitive } from '@/Primitive'
 import { addUnlinkedScrollListener } from './utils'
 import { injectScrollAreaRootContext } from './ScrollAreaRoot.vue'
@@ -58,12 +58,12 @@ watchOnce(sizes, () => {
      * https://developer.mozilla.org/en-US/docs/Mozilla/Performance/Scroll-linked_effects
      */
     scrollbarContextVisible.onThumbPositionChange()
-    viewport.value.addEventListener('scroll', handleScroll)
+
+    useEventListener(viewport, 'scroll', handleScroll)
   }
 })
 
 onUnmounted(() => {
-  viewport.value!.removeEventListener('scroll', handleScroll)
   rootContext.viewport.value?.removeEventListener('scroll', handleScroll)
 })
 </script>

packages/radix-vue/src/Select/SelectContentImpl.vue

@@ -85,7 +85,7 @@ import {
   watch,
   watchEffect,
 } from 'vue'
-import { unrefElement } from '@vueuse/core'
+import { unrefElement, useEventListener } from '@vueuse/core'
 import { injectSelectRootContext } from './SelectRoot.vue'
 import SelectItemAlignedPosition from './SelectItemAlignedPosition.vue'
 import SelectPopperPosition from './SelectPopperPosition.vue'
@@ -160,20 +160,19 @@ watchEffect((cleanupFn) => {
       if (!content.value?.contains(event.target as HTMLElement))
         onOpenChange(false)
     }
-    document.removeEventListener('pointermove', handlePointerMove)
+    useEventListener(document, 'pointermove', handlePointerMove)
     triggerPointerDownPosRef.value = null
   }
 
   if (triggerPointerDownPosRef.value !== null) {
-    document.addEventListener('pointermove', handlePointerMove)
+    useEventListener(document, 'pointermove', handlePointerMove)
     document.addEventListener('pointerup', handlePointerUp, {
       capture: true,
       once: true,
     })
   }
 
   cleanupFn(() => {
-    document.removeEventListener('pointermove', handlePointerMove)
     document.removeEventListener('pointerup', handlePointerUp, {
       capture: true,
     })

packages/radix-vue/src/Select/SelectScrollDownButton.vue

@@ -7,6 +7,7 @@ export interface SelectScrollDownButtonProps extends PrimitiveProps {}
 
 <script setup lang="ts">
 import { ref, watch, watchEffect } from 'vue'
+import { useEventListener } from '@vueuse/core'
 import { SelectContentDefaultContextValue, injectSelectContentContext } from './SelectContentImpl.vue'
 import SelectScrollButtonImpl from './SelectScrollButtonImpl.vue'
 import { injectSelectItemAlignedPositionContext } from './SelectItemAlignedPosition.vue'
@@ -23,7 +24,7 @@ const { forwardRef, currentElement } = useForwardExpose()
 
 const canScrollDown = ref(false)
 
-watchEffect((cleanupFn) => {
+watchEffect(() => {
   if (contentContext.viewport?.value && contentContext.isPositioned?.value) {
     const viewport = contentContext.viewport.value
 
@@ -34,9 +35,8 @@ watchEffect((cleanupFn) => {
       canScrollDown.value = Math.ceil(viewport.scrollTop) < maxScroll
     }
     handleScroll()
-    viewport.addEventListener('scroll', handleScroll)
 
-    cleanupFn(() => viewport.removeEventListener('scroll', handleScroll))
+    useEventListener(viewport, 'scroll', handleScroll)
   }
 })
 

packages/radix-vue/src/Select/SelectScrollUpButton.vue

@@ -7,6 +7,7 @@ export interface SelectScrollUpButtonProps extends PrimitiveProps {}
 
 <script setup lang="ts">
 import { ref, watch, watchEffect } from 'vue'
+import { useEventListener } from '@vueuse/core'
 import { SelectContentDefaultContextValue, injectSelectContentContext } from './SelectContentImpl.vue'
 import { injectSelectItemAlignedPositionContext } from './SelectItemAlignedPosition.vue'
 import SelectScrollButtonImpl from './SelectScrollButtonImpl.vue'
@@ -23,17 +24,15 @@ const { forwardRef, currentElement } = useForwardExpose()
 
 const canScrollUp = ref(false)
 
-watchEffect((cleanupFn) => {
+watchEffect(() => {
   if (contentContext.viewport?.value && contentContext.isPositioned?.value) {
     const viewport = contentContext.viewport.value
 
     function handleScroll() {
       canScrollUp.value = viewport.scrollTop > 0
     }
     handleScroll()
-    viewport.addEventListener('scroll', handleScroll)
-
-    cleanupFn(() => viewport.removeEventListener('scroll', handleScroll))
+    useEventListener(viewport, 'scroll', handleScroll)
   }
 })