⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	2
📦 Imports	8
🟢 Vue Composition API	1

📚 Table of Contents

• Imports
• Vue Composition API
• Functions

🛠️ File Location:

📂 packages/core/useParentElement/index.ts

📦 Imports

Name	Source
MaybeRefOrGetter	vue
ShallowRef	vue
tryOnMounted	@vueuse/shared
shallowRef	vue
toValue	vue
watch	vue
unrefElement	../unrefElement
useCurrentElement	../useCurrentElement

---

Vue Composition API

Name	Type	Reactive Variables	Composables
watch	watch	none	none

---

Functions

useParentElement(element: MaybeRefOrGetter<HTMLElement | SVGElement | null | undefined>): Readonly<ShallowRef<HTMLElement | SVGElement | null | undefined>>

Code

export function useParentElement(
  element: MaybeRefOrGetter<HTMLElement | SVGElement | null | undefined> = useCurrentElement<HTMLElement | SVGAElement>(),
): Readonly<ShallowRef<HTMLElement | SVGElement | null | undefined>> {
  const parentElement = shallowRef<HTMLElement | SVGElement | null | undefined>()

  const update = () => {
    const el = unrefElement(element)
    if (el)
      parentElement.value = el.parentElement
  }

  tryOnMounted(update)
  watch(() => toValue(element), update)

  return parentElement
}

• Parameters:
• element: MaybeRefOrGetter<HTMLElement | SVGElement | null | undefined>
• Return Type: Readonly<ShallowRef<HTMLElement | SVGElement | null | undefined>>
• Calls:
• shallowRef (from vue)
• unrefElement (from ../unrefElement)
• tryOnMounted (from @vueuse/shared)
• watch (from vue)
• toValue (from vue)

update(): void

Code

() => {
    const el = unrefElement(element)
    if (el)
      parentElement.value = el.parentElement
  }

• Return Type: void
• Calls:
• unrefElement (from ../unrefElement)

---