docs » MouseCircle

Draws a circle around the mouse pointer when a hotkey is pressed

Download: https://github.com/Hammerspoon/Spoons/raw/master/Spoons/MouseCircle.spoon.zip

API Overview

API Documentation

Variables

color
Signature MouseCircle.color
Type Variable
Description

An hs.drawing.color table defining the colour of the circle. Defaults to red.

Methods

bindHotkeys
Signature MouseCircle:bindHotkeys(mapping)
Type Method
Description

Binds hotkeys for MouseCircle

Parameters:

  • mapping - A table containing hotkey modifier/key details for the following items:
    • show - This will cause the mouse circle to be drawn
show
Signature MouseCircle:show()
Type Method
Description

Draws a circle around the mouse

Parameters:

  • None

Returns:

  • None