useKeyModifier

カテゴリ

センサー

エクスポートサイズ

587 B

最終変更

先週

リアクティブな修飾子状態。サポートされている修飾子のいずれかの状態を追跡します - ブラウザ互換性の注意事項を参照してください。

Vue Schoolの無料ビデオレッスンでuseKeyModifierを学びましょう！

デモ

ソース

capsLock

numLock

scrollLock

shift

control

alt

使用方法

import { useKeyModifier } from '@vueuse/core'

const capsLockState = useKeyModifier('CapsLock')

console.log(capsLockState.value)

イベント

状態の更新を促すイベントをカスタマイズできます。デフォルトでは、mouseup、mousedown、keyup、keydownです。これらのイベントをカスタマイズするには

import { useKeyModifier } from '@vueuse/core'

const capsLockState = useKeyModifier('CapsLock', { events: ['mouseup', 'mousedown'] })

console.log(capsLockState) // null

// Caps Lock turned on with key press
console.log(capsLockState) // null

// Mouse button clicked
console.log(capsLockState) // true

初期状態

デフォルトでは、最初のイベントを受信するまで、返されたrefはRef<null>になります。初期状態を明示的に渡すには

const capsLockState1 = useKeyModifier('CapsLock') // Ref<boolean | null>
const capsLockState2 = useKeyModifier('CapsLock', { initial: false }) // Ref<boolean>

型宣言

typescript

export type KeyModifier =
  | "Alt"
  | "AltGraph"
  | "CapsLock"
  | "Control"
  | "Fn"
  | "FnLock"
  | "Meta"
  | "NumLock"
  | "ScrollLock"
  | "Shift"
  | "Symbol"
  | "SymbolLock"
export interface UseModifierOptions<Initial> extends ConfigurableDocument {
  /**
   * Event names that will prompt update to modifier states
   *
   * @default ['mousedown', 'mouseup', 'keydown', 'keyup']
   */
  events?: WindowEventName[]
  /**
   * Initial value of the returned ref
   *
   * @default null
   */
  initial?: Initial
}
export type UseKeyModifierReturn<Initial> = Ref<
  Initial extends boolean ? boolean : boolean | null
>
export declare function useKeyModifier<Initial extends boolean | null>(
  modifier: KeyModifier,
  options?: UseModifierOptions<Initial>,
): UseKeyModifierReturn<Initial>