docs » Lightspot

Lightweight, consistent, and fast Spotlight replacement.

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

README: README.md

API Overview

Variables - Configurable values

chooser
defaultHotkeys
logger
logLevel

Methods - API calls which can only be made on an object returned by a constructor

init
start
stop

API Documentation

Variables

chooser

Signature	`Lightspot.chooser`
Type	Variable
Description	hs.chooser object representing the chooser.
Source	Source/Lightspot.spoon/init.lua line 39

defaultHotkeys

Signature	`Lightspot.defaultHotkeys`
Type	Variable
Description	Default hotkey to use for the chooser when "hotkeys" = "default".
Source	Source/Lightspot.spoon/init.lua line 23

logger

Signature	`Lightspot.logger`
Type	Variable
Description	Logger object used within the Spoon. Can be accessed to set the default log
Source	Source/Lightspot.spoon/init.lua line 28

logLevel

Signature	`Lightspot.logLevel`
Type	Variable
Description	Lightspot specific log level override, see hs.logger.setLogLevel for options.
Source	Source/Lightspot.spoon/init.lua line 34

Methods

init

Signature	`Lightspot:init()`
Type	Method
Description	Spoon initializer method for Lightspot.
Parameters	None
Returns	None
Source	Source/Lightspot.spoon/init.lua line 44

start

Signature	`Lightspot:start()`
Type	Method
Description	Spoon start method for Lightspot.
Parameters	None
Returns	None
Notes	Starts the hs.chooser which is then bound to the "chooser" hotkey.
Source	Source/Lightspot.spoon/init.lua line 151

stop

Signature	`Lightspot:stop()`
Type	Method
Description	Spoon stop method for Lightspot.
Parameters	None
Returns	None
Notes	Stops the hs.chooser.
Source	Source/Lightspot.spoon/init.lua line 181