useFocus

Category

Sensors

Export Size

718 B

Last Changed

3 hours ago

用于跟踪或设置 DOM 元素的焦点状态的响应式工具。状态变化反映了目标元素是否为焦点元素。从外部设置响应式值将触发对应于 true 和 false 值的 focus 和 blur 事件。

Demo

source

可获得焦点的段落

---

基本用法

import { useFocus } from '@vueuse/core'

const target = shallowRef()
const { focused } = useFocus(target)

watch(focused, (focused) => {
  if (focused)
    console.log('输入元素已获取焦点')
  else console.log('输入元素已失去焦点')
})

设置初始焦点

可以通过将 initialValue 选项设置为 true 来在首次渲染时让元素获得焦点。这将触发目标元素上的 focus 事件。

import { useFocus } from '@vueuse/core'

const target = shallowRef()
const { focused } = useFocus(target, { initialValue: true })

更改焦点状态

focused 响应式引用的更改将自动触发对应于 true 和 false 值的 focus 和 blur 事件。您可以利用这种行为来作为其他操作的结果使目标元素获得焦点（例如，当按钮被点击时，如下所示）。

<script>
import { useFocus } from '@vueuse/core'
import { shallowRef } from 'vue'

export default {
  setup() {
    const input = shallowRef()
    const { focused } = useFocus(input)

    return {
      input,
      focused,
    }
  },
}
</script>

<template>
  <div>
    <button type="button" @click="focused = true">
      单击我以使下面的输入框获得焦点
    </button>
    <input ref="input" type="text">
  </div>
</template>

Type Declarations

Show Type Declarations

export interface UseFocusOptions extends ConfigurableWindow {
  /**
   * Initial value. If set true, then focus will be set on the target
   *
   * @default false
   */
  initialValue?: boolean
  /**
   * Replicate the :focus-visible behavior of CSS
   *
   * @default false
   */
  focusVisible?: boolean
  /**
   * Prevent scrolling to the element when it is focused.
   *
   * @default false
   */
  preventScroll?: boolean
}
export interface UseFocusReturn {
  /**
   * If read as true, then the element has focus. If read as false, then the element does not have focus
   * If set to true, then the element will be focused. If set to false, the element will be blurred.
   */
  focused: WritableComputedRef<boolean>
}
/**
 * Track or set the focus state of a DOM element.
 *
 * @see https://vueuse.org/useFocus
 * @param target The target element for the focus and blur events.
 * @param options
 */
export declare function useFocus(
  target: MaybeElementRef,
  options?: UseFocusOptions,
): UseFocusReturn

Source

Source • Demo • Docs

Contributors

jorshen

Changelog

No recent changes