コンテンツへスキップ

usePointerLock

カテゴリー
エクスポートサイズ
1.36 kB
最終更新
先週

リアクティブなポインターロック

デモ

基本Usage

js
import { usePointerLock } from '@vueuse/core'

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

コンポーネントのUsage

この関数は、@vueuse/componentsパッケージを介してレンダリングレスコンポーネントバージョンも提供します。使用法について詳しくはこちら

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

型宣言

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

ソース

ソースデモドキュメント

貢献者

Anthony Fu
Anthony Fu
Sergey Danilchenko

変更履歴

v12.0.0-beta.1 2024/11/21
0a9ed - feat!: Vue 2のサポートを削除、バンドルを最適化し、クリーンアップしました (#4349)
v10.8.0 2024/02/20
a086e - fix: より厳格な型
v9.11.0 2023/01/17
ae69f - feat: 新しい関数 (#2590)

MITライセンスの下でリリースされています。