4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
62 lines
1.5 KiB
Markdown
62 lines
1.5 KiB
Markdown
---
|
|
category: Component
|
|
---
|
|
|
|
# useCurrentElement
|
|
|
|
Get the DOM element of current component as a ref.
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { useCurrentElement } from '@vueuse/core'
|
|
|
|
const el = useCurrentElement() // ComputedRef<Element>
|
|
```
|
|
|
|
Or pass a specific vue component
|
|
|
|
```vue
|
|
<script setup lang="ts">
|
|
import { useCurrentElement, VueInstance } from '@vueuse/core'
|
|
import { shallowRef } from 'vue'
|
|
|
|
const componentRef = shallowRef<VueInstance>(null as unknown as VueInstance)
|
|
|
|
const el = useCurrentElement(componentRef) // ComputedRef<Element>
|
|
</script>
|
|
|
|
<template>
|
|
<div>
|
|
<OtherVueComponent ref="componentRef" />
|
|
<p>Hello world</p>
|
|
</div>
|
|
</template>
|
|
```
|
|
|
|
## Caveats
|
|
|
|
This functions uses [`$el` under the hood](https://vuejs.org/api/component-instance.html#el).
|
|
|
|
Value of the ref will be `undefined` until the component is mounted.
|
|
|
|
- For components with a single root element, it will point to that element.
|
|
- For components with text root, it will point to the text node.
|
|
- For components with multiple root nodes, it will be the placeholder DOM node that Vue uses to keep track of the component's position in the DOM.
|
|
|
|
It's recommend to only use this function for components with **a single root element**.
|
|
|
|
## Type Declarations
|
|
|
|
```ts
|
|
export declare function useCurrentElement<
|
|
T extends MaybeElement = MaybeElement,
|
|
R extends VueInstance = VueInstance,
|
|
E extends MaybeElement = MaybeElement extends T
|
|
? IsAny<R["$el"]> extends false
|
|
? R["$el"]
|
|
: T
|
|
: T,
|
|
>(rootComponent?: MaybeElementRef<R>): ComputedRefWithControl<E>
|
|
```
|