docs » ArrangeDesktop

Contains the configured desktop arrangements

Defines where the config file is stored. Defaults to hs.spoons.scriptPath()/config.json

Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.

Builds the configuration for the current desktop arrangement.

• None

• A table containing the configuration data for the current desktop arrangement

Loads the configuration file.

• None

• A table containing the configured desktop arrangements, or nil if an error occurred

Positions all windows for an application based on the given configuration.

• app - A table of the application instance
• appTitle - The name of the application, e.g., Slack, Firefox, etc.
• screen - A table of the position of the screen (x, y integer pair) to place the application window into
• frame - A table of the frame details for the application window, e.g., {w=12, h=12, x=12, y=12}

Writes the configuration to a file.

• config - A table containing the configuration to write

• A boolean indicating if the write was successful

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

• menuItems - A table of menu items to append to

• A table of menu items

Arrange the desktop based on a given configuration

• arrangement - A table of arrangement data

Creates the desktop arrangement and saves it to the configuration file.

• None