Skip to content
@pierre/ecs

Key

const Key: object

Defined in: src/modules/input/key-codes.ts:26

Frozen record of common KeyboardEvent.code values, organised by category. Use Key.ArrowLeft instead of 'ArrowLeft' in createInput(...) maps to get compile-time typo protection and IDE autocomplete:

import { createInput, Key } from '@pierre/ecs/modules/input';


createInput({
  jump:  [Key.Space, Key.ArrowUp, Key.KeyW],
  left:  [Key.ArrowLeft, Key.KeyA],
  right: [Key.ArrowRight, Key.KeyD],
}, [new KeyboardProvider()]);

.code values are physical-position-based (US-QWERTY labelled), so Key.KeyW fires for the key at the physical top-left letter position on AZERTY, QWERTZ, Dvorak, Colemak, etc. This gives “WASD” ergonomics on every layout.

Passing raw strings still works — this const is purely an ergonomics layer for the keyboard provider. Custom providers (gamepad, touch, test harnesses) are free to emit any string codes.

Type Declaration

Section titled “Type Declaration”

AltLeft

Section titled “AltLeft”

readonly AltLeft: "AltLeft" = 'AltLeft'

AltRight

Section titled “AltRight”

readonly AltRight: "AltRight" = 'AltRight'

ArrowDown

Section titled “ArrowDown”

readonly ArrowDown: "ArrowDown" = 'ArrowDown'

ArrowLeft

Section titled “ArrowLeft”

readonly ArrowLeft: "ArrowLeft" = 'ArrowLeft'

ArrowRight

Section titled “ArrowRight”

readonly ArrowRight: "ArrowRight" = 'ArrowRight'

ArrowUp

Section titled “ArrowUp”

readonly ArrowUp: "ArrowUp" = 'ArrowUp'

Backquote

Section titled “Backquote”

readonly Backquote: "Backquote" = 'Backquote'

Backslash

Section titled “Backslash”

readonly Backslash: "Backslash" = 'Backslash'

Backspace

Section titled “Backspace”

readonly Backspace: "Backspace" = 'Backspace'

BracketLeft

Section titled “BracketLeft”

readonly BracketLeft: "BracketLeft" = 'BracketLeft'

BracketRight

Section titled “BracketRight”

readonly BracketRight: "BracketRight" = 'BracketRight'

Comma

Section titled “Comma”

readonly Comma: "Comma" = 'Comma'

ControlLeft

Section titled “ControlLeft”

readonly ControlLeft: "ControlLeft" = 'ControlLeft'

ControlRight

Section titled “ControlRight”

readonly ControlRight: "ControlRight" = 'ControlRight'

Delete

Section titled “Delete”

readonly Delete: "Delete" = 'Delete'

Digit0

Section titled “Digit0”

readonly Digit0: "Digit0" = 'Digit0'

Digit1

Section titled “Digit1”

readonly Digit1: "Digit1" = 'Digit1'

Digit2

Section titled “Digit2”

readonly Digit2: "Digit2" = 'Digit2'

Digit3

Section titled “Digit3”

readonly Digit3: "Digit3" = 'Digit3'

Digit4

Section titled “Digit4”

readonly Digit4: "Digit4" = 'Digit4'

Digit5

Section titled “Digit5”

readonly Digit5: "Digit5" = 'Digit5'

Digit6

Section titled “Digit6”

readonly Digit6: "Digit6" = 'Digit6'

Digit7

Section titled “Digit7”

readonly Digit7: "Digit7" = 'Digit7'

Digit8

Section titled “Digit8”

readonly Digit8: "Digit8" = 'Digit8'

Digit9

Section titled “Digit9”

readonly Digit9: "Digit9" = 'Digit9'

Enter

Section titled “Enter”

readonly Enter: "Enter" = 'Enter'

Equal

Section titled “Equal”

readonly Equal: "Equal" = 'Equal'

Escape

Section titled “Escape”

readonly Escape: "Escape" = 'Escape'

F1

Section titled “F1”

readonly F1: "F1" = 'F1'

F10

Section titled “F10”

readonly F10: "F10" = 'F10'

F11

Section titled “F11”

readonly F11: "F11" = 'F11'

F12

Section titled “F12”

readonly F12: "F12" = 'F12'

F2

Section titled “F2”

readonly F2: "F2" = 'F2'

F3

Section titled “F3”

readonly F3: "F3" = 'F3'

F4

Section titled “F4”

readonly F4: "F4" = 'F4'

F5

Section titled “F5”

readonly F5: "F5" = 'F5'

F6

Section titled “F6”

readonly F6: "F6" = 'F6'

F7

Section titled “F7”

readonly F7: "F7" = 'F7'

F8

Section titled “F8”

readonly F8: "F8" = 'F8'

F9

Section titled “F9”

readonly F9: "F9" = 'F9'

KeyA

Section titled “KeyA”

readonly KeyA: "KeyA" = 'KeyA'

KeyB

Section titled “KeyB”

readonly KeyB: "KeyB" = 'KeyB'

KeyC

Section titled “KeyC”

readonly KeyC: "KeyC" = 'KeyC'

KeyD

Section titled “KeyD”

readonly KeyD: "KeyD" = 'KeyD'

KeyE

Section titled “KeyE”

readonly KeyE: "KeyE" = 'KeyE'

KeyF

Section titled “KeyF”

readonly KeyF: "KeyF" = 'KeyF'

KeyG

Section titled “KeyG”

readonly KeyG: "KeyG" = 'KeyG'

KeyH

Section titled “KeyH”

readonly KeyH: "KeyH" = 'KeyH'

KeyI

Section titled “KeyI”

readonly KeyI: "KeyI" = 'KeyI'

KeyJ

Section titled “KeyJ”

readonly KeyJ: "KeyJ" = 'KeyJ'

KeyK

Section titled “KeyK”

readonly KeyK: "KeyK" = 'KeyK'

KeyL

Section titled “KeyL”

readonly KeyL: "KeyL" = 'KeyL'

KeyM

Section titled “KeyM”

readonly KeyM: "KeyM" = 'KeyM'

KeyN

Section titled “KeyN”

readonly KeyN: "KeyN" = 'KeyN'

KeyO

Section titled “KeyO”

readonly KeyO: "KeyO" = 'KeyO'

KeyP

Section titled “KeyP”

readonly KeyP: "KeyP" = 'KeyP'

KeyQ

Section titled “KeyQ”

readonly KeyQ: "KeyQ" = 'KeyQ'

KeyR

Section titled “KeyR”

readonly KeyR: "KeyR" = 'KeyR'

KeyS

Section titled “KeyS”

readonly KeyS: "KeyS" = 'KeyS'

KeyT

Section titled “KeyT”

readonly KeyT: "KeyT" = 'KeyT'

KeyU

Section titled “KeyU”

readonly KeyU: "KeyU" = 'KeyU'

KeyV

Section titled “KeyV”

readonly KeyV: "KeyV" = 'KeyV'

KeyW

Section titled “KeyW”

readonly KeyW: "KeyW" = 'KeyW'

KeyX

Section titled “KeyX”

readonly KeyX: "KeyX" = 'KeyX'

KeyY

Section titled “KeyY”

readonly KeyY: "KeyY" = 'KeyY'

KeyZ

Section titled “KeyZ”

readonly KeyZ: "KeyZ" = 'KeyZ'

MetaLeft

Section titled “MetaLeft”

readonly MetaLeft: "MetaLeft" = 'MetaLeft'

MetaRight

Section titled “MetaRight”

readonly MetaRight: "MetaRight" = 'MetaRight'

Minus

Section titled “Minus”

readonly Minus: "Minus" = 'Minus'

Numpad0

Section titled “Numpad0”

readonly Numpad0: "Numpad0" = 'Numpad0'

Numpad1

Section titled “Numpad1”

readonly Numpad1: "Numpad1" = 'Numpad1'

Numpad2

Section titled “Numpad2”

readonly Numpad2: "Numpad2" = 'Numpad2'

Numpad3

Section titled “Numpad3”

readonly Numpad3: "Numpad3" = 'Numpad3'

Numpad4

Section titled “Numpad4”

readonly Numpad4: "Numpad4" = 'Numpad4'

Numpad5

Section titled “Numpad5”

readonly Numpad5: "Numpad5" = 'Numpad5'

Numpad6

Section titled “Numpad6”

readonly Numpad6: "Numpad6" = 'Numpad6'

Numpad7

Section titled “Numpad7”

readonly Numpad7: "Numpad7" = 'Numpad7'

Numpad8

Section titled “Numpad8”

readonly Numpad8: "Numpad8" = 'Numpad8'

Numpad9

Section titled “Numpad9”

readonly Numpad9: "Numpad9" = 'Numpad9'

NumpadAdd

Section titled “NumpadAdd”

readonly NumpadAdd: "NumpadAdd" = 'NumpadAdd'

NumpadDecimal

Section titled “NumpadDecimal”

readonly NumpadDecimal: "NumpadDecimal" = 'NumpadDecimal'

NumpadDivide

Section titled “NumpadDivide”

readonly NumpadDivide: "NumpadDivide" = 'NumpadDivide'

NumpadEnter

Section titled “NumpadEnter”

readonly NumpadEnter: "NumpadEnter" = 'NumpadEnter'

NumpadMultiply

Section titled “NumpadMultiply”

readonly NumpadMultiply: "NumpadMultiply" = 'NumpadMultiply'

NumpadSubtract

Section titled “NumpadSubtract”

readonly NumpadSubtract: "NumpadSubtract" = 'NumpadSubtract'

Period

Section titled “Period”

readonly Period: "Period" = 'Period'

Quote

Section titled “Quote”

readonly Quote: "Quote" = 'Quote'

Semicolon

Section titled “Semicolon”

readonly Semicolon: "Semicolon" = 'Semicolon'

ShiftLeft

Section titled “ShiftLeft”

readonly ShiftLeft: "ShiftLeft" = 'ShiftLeft'

ShiftRight

Section titled “ShiftRight”

readonly ShiftRight: "ShiftRight" = 'ShiftRight'

Slash

Section titled “Slash”

readonly Slash: "Slash" = 'Slash'

Space

Section titled “Space”

readonly Space: "Space" = 'Space'

Tab

Section titled “Tab”

readonly Tab: "Tab" = 'Tab'