#BIND A HOTKEY HAMMERSPOON INSTALL#
#BIND A HOTKEY HAMMERSPOON ZIP FILE#
#BIND A HOTKEY HAMMERSPOON MODS#
#BIND A HOTKEY HAMMERSPOON MAC#

msg - the hotkey message, if provided when the hotkey was created (prefixed with the keyboard combination).

idx - a string describing the keyboard combination for the hotkey.(usually, the global hotkey context, but it could be a modal hotkey context). enabled and not 'shadowed', in the current context A table containing the hotkeys that are active, i.e.Returns a list of all currently active hotkeys

#BIND A HOTKEY HAMMERSPOON MAC#

The most common reason a hotkey combination cannot be given an assignment by Hammerspoon is because it is in use by the Mac operating system - see the Shortcuts tab of Keyboard in the System Preferences application or hs.hotkey.systemAssigned.ĭeletes all previously set callbacks for a given keyboard combinationĭisables all previously set callbacks for a given keyboard combination.

a boolean value, true if the hotkey combination can be given an assignment by Hammerspoon or false if it cannot.

key - A string containing the name of a keyboard key (as found in hs.keycodes.map ), or a raw keycode number.

Which should be zero or more of the following:

#BIND A HOTKEY HAMMERSPOON MODS#

mods - A table or a string containing (as elements, or as substrings with any separator) the keyboard modifiers required,.

Hs.hotkey.assignable(mods, key) -> booleanĭetermines whether the hotkey combination can be assigned a callback through Hammerspoon. Hs.hotkey.alertDuration = 0 - hotkey alerts are disabled Hs.hotkey.alertDuration = 2.5 - alert stays on screen a bit longer

Methods - API calls which can only be made on an object returned by a constructorĪPI Documentation Variables alertDuration Signatureĭuration of the alert shown when a hotkey created with a message parameter is triggered, in seconds.

Constructors - API calls which return an object, typically one that offers API methods.

Functions - API calls offered directly by the extension.

For example, if you use the Seal spoon (a configurable launcher), you need to call its loadPlugins() method to specify which Seal plugins to use.Hammerspoon docs: hs.hotkey docs » hs.hotkeyĬreate and manage global keyboard shortcuts Submodules This can be used to execute other startup or configuration actions that are not covered by the other attributes. Start is a boolean value which indicates whether to call the Spoon’s start() method (if it has one) after configuring everything else.įn specifies a function which will be called with the freshly-loaded Spoon object as its first argument. The valid values for this attribute are ‘nothing’, ‘error’, ‘warning’, ‘info’, ‘debug’, or ‘verbose’. Loglevel sets the log level of the logger attribute within the spoon, if it exists. Type the following in the Hammerspoon console, or add it to your a file and reload the configuration: Once a Spoon is installed, you need to use the hs.loadSpoon() function to load it.

#BIND A HOTKEY HAMMERSPOON INSTALL#

Hammerspoon will install the Spoon under ~/.hammerspoon/Spoons/.

#BIND A HOTKEY HAMMERSPOON ZIP FILE#

To install the spoon, download its zip file from, unpack it, and double-click on the resulting MouseCircle.spoon file.

Using a Spoon to locate your mouseĪs a first example, we will use the MouseCircle spoon, which allows us to set up a hotkey that displays a color circle around the current location of the mouse pointer for a few seconds, to help you locate it. See also the first article in this series. They are also a good way to share your own work with other users.

Spoons provide a predefined API to configure and use them. In this second article about Hammerspoon, we look into Spoons, modules written in Lua which can be easily installed and loaded into Hammerspoon to provide ready-to-use functionality.

Bind a hotkey hammerspoon