useActiveElement

类别

元素

导出体积

1.18 kB

上次更改

7 minutes ago

响应式的 document.activeElement。返回一个浅层的 ref，当焦点改变时更新。

示例

源码playground (beta)

选择下面的 input 查看当前激活的元素

当前激活的元素: null

用法

<script setup lang="ts">
import { useActiveElement } from '@vueuse/core'
import { watch } from 'vue'

const activeElement = useActiveElement()

watch(activeElement, (el) => {
  console.log('当前活动元素是', el)
})
</script>

Shadow DOM 支持

默认情况下，useActiveElement 会遍历进入 shadow DOM 来查找深层活动元素。设置 deep: false 可禁用此行为。

import { useActiveElement } from '@vueuse/core'

// 只获取 shadow host，而不是 shadow DOM 内部的元素
const activeElement = useActiveElement({ deep: false })

跟踪元素移除

设置 triggerOnRemoval: true，则当当前活动元素从 DOM 中移除时也会更新活动元素。这是通过底层的 MutationObserver 实现的。

import { useActiveElement } from '@vueuse/core'

const activeElement = useActiveElement({ triggerOnRemoval: true })

组件用法

<template>
  <UseActiveElement v-slot="{ element }">
    当前活动元素是 {{ element?.dataset.id }}
  </UseActiveElement>
</template>

类型声明

export interface UseActiveElementOptions
  extends ConfigurableWindow, ConfigurableDocumentOrShadowRoot {
  /**
   * 在 shadow dom 中深度搜索活动元素
   *
   * @default true
   */
  deep?: boolean
  /**
   * Track active element when it's removed from the DOM
   * Using a MutationObserver under the hood
   * @default false
   */
  triggerOnRemoval?: boolean
}
/**
 * Reactive `document.activeElement`
 *
 * @see https://vueuse.org/useActiveElement
 * @param options
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useActiveElement<T extends HTMLElement>(
  options?: UseActiveElementOptions,
): ShallowRef<T | null | undefined, T | null | undefined>
export type UseActiveElementReturn = ReturnType<typeof useActiveElement>

源码

源码 • 演示 • 文档

贡献者

一纸忘忧

更新日志

没有最近的更新日志