checkKeyCodes() — vue Function Reference

Architecture documentation for the checkKeyCodes() function in check-keycodes.ts from the vue codebase.

Function typescript VueCore Instance calls 1

Entity Profile

VueCore→ Instance→ checkKeyCodes() — vue Function Reference

Dependency Diagram

graph TD
  3b312040_8fbe_05d2_065f_9a730caa65ba["checkKeyCodes()"]
  2ec34eb8_958a_e78a_50f2_177bff9c3445["check-keycodes.ts"]
  3b312040_8fbe_05d2_065f_9a730caa65ba -->|defined in| 2ec34eb8_958a_e78a_50f2_177bff9c3445
  b3ef88fb_ad8a_bf6f_e9ef_7f29df1549a7["isKeyNotMatch()"]
  3b312040_8fbe_05d2_065f_9a730caa65ba -->|calls| b3ef88fb_ad8a_bf6f_e9ef_7f29df1549a7
  style 3b312040_8fbe_05d2_065f_9a730caa65ba fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/core/instance/render-helpers/check-keycodes.ts lines 17–33

export function checkKeyCodes(
  eventKeyCode: number,
  key: string,
  builtInKeyCode?: number | Array<number>,
  eventKeyName?: string,
  builtInKeyName?: string | Array<string>
): boolean | null | undefined {
  const mappedKeyCode = config.keyCodes[key] || builtInKeyCode
  if (builtInKeyName && eventKeyName && !config.keyCodes[key]) {
    return isKeyNotMatch(builtInKeyName, eventKeyName)
  } else if (mappedKeyCode) {
    return isKeyNotMatch(mappedKeyCode, eventKeyCode)
  } else if (eventKeyName) {
    return hyphenate(eventKeyName) !== key
  }
  return eventKeyCode === undefined
}