docs » WindowGrid

Configure and assign hotkey for hs.grid

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

API Overview

API Documentation

Variables

gridGeometries
Signature WindowGrid.gridGeometries
Type Variable
Description

Table containing a list of arguments to be passed to grid.setGrid(). Each element in the table is itself a table with 1-3 arguments as defined for hs.grid.setGrid(). Defaults to an empty list, which results in the default 3x3 grid for all screen from hs.grid.
Source Source/WindowGrid.spoon/init.lua line 25
logger
Signature WindowGrid.logger
Type Variable
Description

Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.
Source Source/WindowGrid.spoon/init.lua line 20

Methods

bindHotkeys
Signature WindowGrid:bindHotkeys(mapping)
Type Method
Description

Binds hotkeys for WindowGrid
Parameters
  • mapping - A table containing hotkey objifier/key details for the following items:
    • show_grid - show the grid overlay
Returns
Source Source/WindowGrid.spoon/init.lua line 30
start
Signature WindowGrid:start()
Type Method
Description

Sets the grid configuration according to WindowGrid.gridGeometries.
Parameters
  • None
Returns
Source Source/WindowGrid.spoon/init.lua line 46