Giter Club home page Giter Club logo

awesome-keys's Introduction

AwesomeKeys

AwesomeKeys is a plugin for Hammerspoon, that allows customizing global and app-specific key bindings.

AwesomeKeys

Installation

Download AwesomeKeys.zip, unzip and open AwesomeKeys.spoon (it will auto-install the spoon).

Add the following to your the Hammerspoon config file (init.lua):

hs.loadSpoon("AwesomeKeys")

Usage

Initialization.

hs.loadSpoon("AwesomeKeys")

local keys = spoon.AwesomeKeys

Set global key bindings.

keys:setGlobalBindings(
  {key = "f5", fn = keys.fnutils.keyStroke({"command", "shift"}, "4")},
  {key = "f6", fn = keys.fnutils.keyStroke({"command", "shift"}, "5")},
  {
    key = "f7",
    fn = function()
      local result =
        hs.dialog.blockAlert("Hammerspoon", "You're about to reload hammerspoon config, are you sure?", "OK", "Cancel")

      if result == "OK" then
        hs.reload()
      end
    end
  },
  {key = "f8", fn = keys.fnutils.keyStroke({"command", "option"}, "space")},
  {
    key = "f10",
    fn = function()
      hs.spotify.previous()
    end
  },
  {
    key = "f11",
    fn = function()
      hs.spotify.playpause()
    end
  },
  {
    key = "f12",
    fn = function()
      hs.spotify.next()
    end
  }
)

Set custom app-specific key bindings.

keys:remapAppKeys(
  {
    app = "Code",
    keys = {
      {from = {key = "end"}, to = {mods = {"command"}, key = "down"}},
      {from = {key = "home"}, to = {mods = {"command"}, key = "up"}}
    }
  }
)

Activate a hyper mode. See more options here.

You can use Karabiner to map the caps lock key (or any other key that you rarely use) to F20 (or anything else).

Karabiner

local hyper =
  keys:createHyperBindings(
  {
    hyperKey = "f20",
    backgroundColor = {hex = "#000", alpha = 0.9},
    textColor = {hex = "#FFF", alpha = 0.8},
    modsColor = {hex = "#FA58B6"},
    keyColor = {hex = "#f5d76b"},
    fontFamily = "JetBrains Mono",
    separator = "(✌ ゚ βˆ€ ゚)☞ –––",
    position = {x = "center", y = "bottom"}
  }
)

Set global key bindings once the hyper mode is active.

hyper:setGlobalBindings(
  {
    key = "f1",
    label = "VS Code",
    fn = keys.fnutils.focusApp("Code")
  },
  {
    key = "f2",
    label = "iTerm2",
    fn = keys.fnutils.focusApp("iTerm")
  },
  {
    key = "f3",
    label = "Chrome",
    fn = keys.fnutils.focusApp("Google Chrome")
  },
  {
    key = "f4",
    label = "Slack",
    fn = keys.fnutils.focusApp("Slack")
  },
  {
    mods = {"command"},
    key = "-",
    label = "Zoom",
    fn = keys.fnutils.focusApp("zoom.us")
  },
  {
    mods = {"command"},
    key = "=",
    label = "Obsidian",
    fn = keys.fnutils.focusApp("Obsidian")
  },
  {
    mods = {"control"},
    key = "\\",
    label = "Sleep",
    fn = function()
      hs.caffeinate.systemSleep()
    end
  },
  {
    mods = {"control"},
    key = "]",
    label = "Lock",
    fn = function()
      hs.caffeinate.lockScreen()
    end
  }
)

Set app-specific key bindings once the hyper mode is active.

hyper:setAppBindings(
  {
    app = "Code",
    splitEvery = 8,
    keys = {
       {
        mods = {"command"},
        key = "1",
        label = "import react",
        fn = keys.fnutils.paste("import * as React from 'react'\n"),
        pattern = ".[t|j]sx?"
      },
      {
        mods = {"command"},
        key = "2",
        label = "import ts-belt",
        fn = keys.fnutils.paste("import { A } from '@mobily/ts-belt'\n"),
        pattern = ".[t|j]sx?"
      }
    }
  },
  {
    app = "iTerm2",
    keys = {
      {
        mods = {"option"},
        key = "1",
        label = "start android",
        fn = keys.fnutils.paste("yarn start:android"),
        pattern = "/native"
      },
      {
        mods = {"option"},
        key = "2",
        label = "start ios",
        fn = keys.fnutils.paste("yarn start:ios"),
        pattern = "/native"
      }
    }
  },
  {
    app = "Google Chrome",
    keys = {
      {
        mods = {"command"},
        key = "p",
        label = "pulls",
        fn = keys.fnutils.openURL("https://github.com/pulls/assigned")
      },
      {
        mods = {"command"},
        key = "i",
        label = "issues",
        fn = keys.fnutils.openURL("https://github.com/issues/assigned")
      }
    }
  },
  {
    app = "Slack",
    keys = {
      {
        mods = {"option"},
        key = "1",
        label = "πŸ‘€",
        fn = keys.fnutils.paste("πŸ‘€")
      },
      {
        mods = {"option"},
        key = "2",
        label = "πŸ˜‚",
        fn = keys.fnutils.paste("πŸ˜‚")
      },
      {
        mods = {"option"},
        key = "3",
        label = "❀️",
        fn = keys.fnutils.paste("❀️")
      }
    }
  }
)

API

spoon.AwesomeKeys:setGlobalBindings(...)

  • type: function
  • parameters: ...
{
  mods = {} -- a table containing the keyboard modifiers: "command", "cmd", "control", "ctrl", "option", "shift" (optjonal)
  key = "",
  fn = function()
  end,
  pressFn = function() -- optional if `fn` is set, a function that will be called when the hotkey has been pressed
  end,
  releaseFn = function() -- optional, a function that will be called when the hotkey has been released
  end
}

spoon.AwesomeKeys:remapAppKeys(...)

  • type: function
  • parameters: ...
{
  app = "", -- an app name as seen in the menubar
  keys = {
    {
      from = {
        mods = {}, -- a table containing the keyboard modifiers
        key = ""
      },
      to = {
        mods = {}, -- a table containing the keyboard modifiers
        key = ""
      }
    }
  }
}

spoon.AwesomeKeys.createHyperBindings(config)

  • type: constructor
  • parameters: config
{
  hyperKey = "f20" -- a key that activates the hyper mode
  hyperMods = {}, -- optional, a table containing the keyboard modifiers: "command", "cmd", "control", "ctrl", "option", "shift" (optjonal)
  hyperExitKey = "", -- optional, an additional key that deactivates the hyper mode (for instance `escape`)
  strokeWidth = 2,
  strokeColor = {white = 1, alpha = 0.1}, -- hs.drawing.color
  backgroundColor = {hex = "#000", alpha = 0.9}, -- hs.drawing.color
  textColor = {hex = "#fff", alpha = 0.8}, -- hs.drawing.color
  modsColor = {hex = "#FA58B6"}, -- hs.drawing.color
  keyColor = {hex = "#f5d76b"}, -- hs.drawing.color
  globalLabelColor = {hex = "#FA58B6"}, -- hs.drawing.color
  fontFamily = ".AppleSystemUIFont",
  fontSize = 15,
  radius = 0,
  padding = 24,
  position = {x = "center", y = "bottom", offsetY = 8, offsetX = 8} -- x: left/center/right, y: top/center/bottom,
  globalLabel = "",  -- a string visible previous to global labels
  spacer = " Β· ", -- a string visible between labels
  separator = "β€”β€”β€”", -- a string visible between global and app-specific key bindings
  splitEvery = 6,
  onEnter = function() -- a function that is called when the hyper mode is activated
  end,
  onExit = function() -- a function that is called when the hyper mode is deactivated
  end
}

hyper:setGlobalBindings(...)

  • type: method
  • parameters: ...
{
  mods = {}, -- optional
  key = "",
  label = "", -- optional, a key shortcut label
  fn = function()
  end,
  pressFn = function() -- optional if `fn` is set, a function that will be called when the hotkey has been pressed
  end,
  releaseFn = function() -- optional, a function that will be called when the hotkey has been released
  end
}

hyper:setAppBindings(...)

  • type: method
  • parameters: ...
{
  app = "", -- an app name
  keys = {
    {
      splitEvery = 6, -- optional, overrides a value passed to `createHyperBindings`
      mods = {}, -- optional
      key = "",
      label = "",  -- optional, a key shortcut label
      fn = function()
      end,
      pressFn = function() -- optional if `fn` is set, a function that will be called when the hotkey has been pressed
      end,
      releaseFn = function() -- optional, a function that will be called when the hotkey has been released
      end
      pattern = "" -- (de)activate a shortcut on window title change (internally it uses string.match)
    }
  }
}

spoon.AwesomeKeys.fnutils.openURL(url)

  • type: function
  • parameters: url (string)

spoon.AwesomeKeys.fnutils.paste(text)

  • type: function
  • parameters: text (string)

spoon.AwesomeKeys.fnutils.focusApp(name)

  • type: function
  • parameters: name (string)

spoon.AwesomeKeys.fnutils.keyStroke(mods, key)

  • type: function
  • parameters: mods (table), key (string)

spoon.AwesomeKeys.fnutils.keyStrokes(keys)

  • type: function
  • parameters: keys (string)

awesome-keys's People

Contributors

mobily avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.