Skip to content

⬅️ Back to Table of Contents

📄 useKeyModifier

📊 Analysis Summary

Metric Count
🔧 Functions 1
📦 Imports 6
📊 Variables & Constants 1
📐 Interfaces 1
📑 Type Aliases 2

📚 Table of Contents

🛠️ File Location:

📂 packages/core/useKeyModifier/index.ts

📦 Imports

Name Source
ShallowRef vue
ConfigurableDocument ../_configurable
WindowEventName ../useEventListener
shallowRef vue
defaultDocument ../_configurable
useEventListener ../useEventListener

Variables & Constants

Name Type Kind Value Exported
defaultEvents WindowEventName[] const ['mousedown', 'mouseup', 'keydown', 'keyup'] ✗

Functions

useKeyModifier(modifier: KeyModifier, options: UseModifierOptions<Initial>): UseKeyModifierReturn<Initial>

Parameters:

  • modifier KeyModifier
  • options UseModifierOptions<Initial>

Returns: UseKeyModifierReturn<Initial>

Calls:

  • shallowRef (from vue)
  • events.forEach
  • useEventListener (from ../useEventListener)
  • evt.getModifierState
Code 
export function useKeyModifier<Initial extends boolean | null>(modifier: KeyModifier, options: UseModifierOptions<Initial> = {}): UseKeyModifierReturn<Initial> {
  const {
    events = defaultEvents,
    document = defaultDocument,
    initial = null,
  } = options

  const state = shallowRef(initial) as ShallowRef<boolean>

  if (document) {
    events.forEach((listenerEvent) => {
      useEventListener(document, listenerEvent, (evt: KeyboardEvent | MouseEvent) => {
        if (typeof evt.getModifierState === 'function')
          state.value = evt.getModifierState(modifier)
      }, { passive: true })
    })
  }

  return state
}

Interfaces

UseModifierOptions<Initial>

Interface Code 
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
}

Properties

Name Type Optional Description
events WindowEventName[] ✓ not shown
initial Initial ✓ not shown

Type Aliases

KeyModifier

type KeyModifier = 'Alt' | 'AltGraph' | 'CapsLock' | 'Control' | 'Fn' | 'FnLock' | 'Meta' | 'NumLock' | 'ScrollLock' | 'Shift' | 'Symbol' | 'SymbolLock';

UseKeyModifierReturn<Initial>

type UseKeyModifierReturn<Initial> = ShallowRef<Initial extends boolean ? boolean : boolean | null>;

Generated by Syntax Scribe