docs » KSheet

Keybindings cheatsheet for current application

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

API Overview

API Documentation

Methods

bindHotkeys
Signature KSheet:bindHotkeys(mapping)
Type Method
Description

Binds hotkeys for KSheet

Parameters:

  • mapping - A table containing hotkey modifier/key details for the following items:
    • show - Show the keybinding view
    • hide - Hide the keybinding view
    • toggle - Show if hidden, hide if shown
Source Source/KSheet.spoon/init.lua
hide
Signature KSheet:hide()
Type Method
Description

Hide the cheatsheet view.

Parameters:

  • None
Source Source/KSheet.spoon/init.lua
init
Signature KSheet:init()
Type Method
Description

Initialize the spoon

Parameters:

  • None
Source Source/KSheet.spoon/init.lua
show
Signature KSheet:show()
Type Method
Description

Show current application's keybindings in a view.

Parameters:

  • None
Source Source/KSheet.spoon/init.lua
toggle
Signature KSheet:toggle()
Type Method
Description

Alternatively show/hide the cheatsheet view.

Parameters:

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