usePointerLock

反应式 指针锁。

¥Reactive pointer lock.

示例

源代码

基本用法

¥Basic Usage

import { usePointerLock } from '@vueuse/core'

const { isSupported, lock, unlock, element, triggerElement } = usePointerLock()

组件用法

¥Component Usage

<template>
  <UsePointerLock v-slot="{ lock }">
    <canvas />
    <button @click="lock">
      Lock Pointer on Canvas
    </button>
  </UsePointerLock>
</template>

类型声明

export interface UsePointerLockOptions extends ConfigurableDocument {}
/**
 * Reactive pointer lock.
 *
 * @see https://vueuse.org/usePointerLock
 * @param target
 * @param options
 */
export declare function usePointerLock(
  target?: MaybeElementRef,
  options?: UsePointerLockOptions,
): {
  isSupported: ComputedRef<boolean>
  element: ShallowRef<MaybeElement, MaybeElement>
  triggerElement: ShallowRef<MaybeElement, MaybeElement>
  lock: (e: MaybeElementRef | Event) => Promise<HTMLElement | SVGElement>
  unlock: () => Promise<boolean>
}
export type UsePointerLockReturn = ReturnType<typeof usePointerLock>

源代码

源代码 • 示例 • 文档

变更日志

v12.6.0 on 2/14/2025

ce9e5 - fix(useMouse): check for MouseEvent instead of Touch to work with FF (#4457)

v12.4.0 on 1/10/2025

dd316 - feat: use passive event handlers everywhere is possible (#4477)