hs.hotkey - Hammerspoon 2 API

Module for creating and managing system-wide hotkeys

Types

This module provides the following types:

This module has no properties.

Bind a hotkey

hs.hotkey.bind(mods, key, callbackPressed, callbackReleased) -> HSHotkey

mods JSValue
An array of modifier key strings (e.g., ["cmd", "shift"])
key string
The key name or character (e.g., "a", "space", "return")
callbackPressed JSValue
A JavaScript function to call when the hotkey is pressed
callbackReleased JSValue
A JavaScript function to call when the hotkey is released

A hotkey object, or nil if binding failed

Bind a hotkey with a message description

hs.hotkey.bindSpec(mods, key, message, callbackPressed, callbackReleased) -> HSHotkey

mods JSValue
An array of modifier key strings
key string
The key name or character
message string
A description of what this hotkey does (currently unused, for future features)
callbackPressed JSValue
A JavaScript function to call when the hotkey is pressed
callbackReleased JSValue
A JavaScript function to call when the hotkey is released

A hotkey object, or nil if binding failed

Get the system-wide mapping of key names to key codes

hs.hotkey.getKeyCodeMap() -> {[key: string]: number}

None

A dictionary mapping key names to numeric key codes

Get the mapping of modifier names to modifier flags

hs.hotkey.getModifierMap() -> {[key: string]: number}

None

A dictionary mapping modifier names to their numeric values