docs » ArrangeDesktop

Utilities for arranging your desktop how you like it.

Positioning logic adapted from https://github.com/dploeger/hammerspoon-window-manager

API Overview

API Documentation

Variables

arrangements
Signature ArrangeDesktop.arrangements
Type Variable
Description

Contains the configured desktop arrangements

Source Source/ArrangeDesktop.spoon/init.lua
logger
Signature ArrangeDesktop.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/ArrangeDesktop.spoon/init.lua

Methods

addMenuItems
Signature ArrangeDesktop:addMenuItems(menuItems, arrangements)
Type Method
Description

Add menu items to a table for each configured desktop arrangment.

Parameters:

  • menuItems - table of menu items
  • arrangements - table of desktop arrangements

Returns: table of menu items

Source Source/ArrangeDesktop.spoon/init.lua
arrange
Signature ArrangeDesktop:arrange(arrangement)
Type Method
Description

Arrange the desktop based on a given configuration

Parameters:

  • arrangement - table of arrangement data
Source Source/ArrangeDesktop.spoon/init.lua
logCurrentArrangement
Signature ArrangeDesktop:logCurrentArrangement()
Type Method
Description

Build up the configuration for the current desktop arrangement and log it to the Hammerspoon console.

Parameters:

  • None
Source Source/ArrangeDesktop.spoon/init.lua