stack/v1/packages/mosaic/framework/skills/vueuse-functions/references/usePointerLock.md

category

category
Sensors

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>

Type Declarations

export interface UsePointerLockOptions extends ConfigurableDocument {}
/**
 * Reactive pointer lock.
 *
 * @see https://vueuse.org/usePointerLock
 * @param target
 * @param options
 *
 * @__NO_SIDE_EFFECTS__
 */
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>;