docs » Carrier

Automatically hide apps that are out of focus.

Download: https://github.com/adammillerio/Spoons/raw/main/Spoons/Carrier.spoon.zip

This uses a hs.window.filter to detect windows that have gone out of focus. Then, if they are configured to be "swept" in the apps config, they will be automatically hidden if they remain out of focus after sweepCheckInterval (default 15 seconds).

README with example usage: README.md

API Overview

API Documentation

Variables

apps
Signature Carrier.apps
Type Variable
Description

Table containing each application's name and it's desired configuration. The
Source Source/Carrier.spoon/init.lua line 27
carryApps
Signature Carrier.carryApps
Type Variable
Description

Table containing the name of every app to carry on space change.
Source Source/Carrier.spoon/init.lua line 51
carryDelay
Signature Carrier.carryDelay
Type Variable
Description

Time in seconds to wait before carrying windows after space change. Default 5 seconds.
Source Source/Carrier.spoon/init.lua line 56
carryDelayTimer
Signature Carrier.carryDelayTimer
Type Variable
Description

Any running hs.timer instance for a delayed carry, if enabled.
Source Source/Carrier.spoon/init.lua line 61
logger
Signature Carrier.logger
Type Variable
Description

Logger object used within the Spoon. Can be accessed to set the default log
Source Source/Carrier.spoon/init.lua line 35
logLevel
Signature Carrier.logLevel
Type Variable
Description

Carrier specific log level override, see hs.logger.setLogLevel for options.
Source Source/Carrier.spoon/init.lua line 41
spaceWatcher
Signature Carrier.spaceWatcher
Type Variable
Description

hs.spaces.watcher instance used for monitoring for space changes.
Source Source/Carrier.spoon/init.lua line 46

Methods

init
Signature Carrier:init()
Type Method
Description

Spoon initializer method for Carrier.
Parameters
  • None
Returns
  • None
Source Source/Carrier.spoon/init.lua line 66
start
Signature Carrier:start()
Type Method
Description

Spoon start method for Carrier.
Parameters
  • None
Returns
  • None
Notes
  • Configures the window filter, and subscribes to all window unfocus events.
Source Source/Carrier.spoon/init.lua line 116
stop
Signature Carrier:stop()
Type Method
Description

Spoon stop method for Carrier.
Parameters
  • None
Returns
  • None
Notes
  • Unsubscribes the window filter from all subscribed functions.
Source Source/Carrier.spoon/init.lua line 154