1---
2category: Elements
3---
4 
5# useActiveElement
6 
7Reactive `document.activeElement`. Returns a shallow ref that updates when focus changes.
8 
9## Usage
10 
11```vue
12<script setup lang="ts">
13import { useActiveElement } from '@vueuse/core'
14import { watch } from 'vue'
15 
16const activeElement = useActiveElement()
17 
18watch(activeElement, (el) => {
19  console.log('focus changed to', el)
20})
21</script>
22```
23 
24### Shadow DOM Support
25 
26By default, `useActiveElement` will traverse into shadow DOM to find the deeply active element. Set `deep: false` to disable this behavior.
27 
28```ts
29import { useActiveElement } from '@vueuse/core'
30 
31// Only get the shadow host, not the element inside shadow DOM
32const activeElement = useActiveElement({ deep: false })
33```
34 
35### Track Element Removal
36 
37Set `triggerOnRemoval: true` to update the active element when the currently active element is removed from the DOM. This uses a `MutationObserver` under the hood.
38 
39```ts
40import { useActiveElement } from '@vueuse/core'
41 
42const activeElement = useActiveElement({ triggerOnRemoval: true })
43```
44 
45## Component Usage
46 
47```vue
48<template>
49  <UseActiveElement v-slot="{ element }">
50    Active element is {{ element?.dataset.id }}
51  </UseActiveElement>
52</template>
53```
54 
55## Type Declarations
56 
57```ts
58export interface UseActiveElementOptions
59  extends ConfigurableWindow, ConfigurableDocumentOrShadowRoot {
60  /**
61   * Search active element deeply inside shadow dom
62   *
63   * @default true
64   */
65  deep?: boolean
66  /**
67   * Track active element when it's removed from the DOM
68   * Using a MutationObserver under the hood
69   * @default false
70   */
71  triggerOnRemoval?: boolean
72}
73export type UseActiveElementReturn<T extends HTMLElement = HTMLElement> =
74  ShallowRef<T | null | undefined>
75/**
76 * Reactive `document.activeElement`
77 *
78 * @see https://vueuse.org/useActiveElement
79 * @param options
80 *
81 * @__NO_SIDE_EFFECTS__
82 */
83export declare function useActiveElement<T extends HTMLElement>(
84  options?: UseActiveElementOptions,
85): UseActiveElementReturn<T>
86```
87