useKeyModifier

分類

感測器

導出大小

644 B

最後變更

3 週前

反應式 Modifier State。追蹤任何支援的修飾鍵狀態 - 請參閱瀏覽器相容性注意事項。

通過 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> = ShallowRef<
  Initial extends boolean ? boolean : boolean | null
>
export declare function useKeyModifier<Initial extends boolean | null>(
  modifier: KeyModifier,
  options?: UseModifierOptions<Initial>,
): UseKeyModifierReturn<Initial>