Skip to content

Key

Parsed key press information.

Received by useInput handlers, onKeyPress callbacks, and Keybind matching.

PropertyTypeDescription
alt?booleantrue when Alt / Option is held.
ctrl?booleantrue when Ctrl is held.
meta?booleantrue when Meta / Cmd / Super / Win is held.
namestringKey name ("a", "return", "escape", "up", "space", …).
sequencestringRaw byte sequence from the terminal.
shift?booleantrue when Shift is held.