Hotkeys management for Hyper
JavaScript
Latest commit 8205d91 Jan 9, 2017 @iamstarkov committed on GitHub Merge pull request #4 from mwolson/readme-npm-install-fix
Fix #3: README.md: Recommend `npm install hpm-cli` instead of `npm install hpm`

README.md

hyper-keymap

NPM version Build Status Coveralls Status Dependency Status

Hotkeys management for Hyper

Install

Open your Hyper preferences and add hyper-keymap to plugin list:

plugins: [
  'hyper-keymap'
],

Or use hpm

npm install -g hpm-cli
hpm i hyper-keymap

🤔 Caveats

Some hotkeys can still not be working, like CmdOrCtrl+Alt+Left, because right now Hyper (v0.8.3) is binding this and several others keys. Those keys are semi-working.

Though, 🎉 good news, i submitted pull-request to Hyper to fix that. Check it out, and if you want comment there what do you think about it 🗯. Any feedback is welcomed.

Usage

There is a default keymap, which is used by Hyper.

In order to change hotkeys you are unhappy with, add keymap object to your config:

module.exports = {
  config: {

    // other configuration

    keymap: {
      // just examples, see below for detailed explanation
      'CmdOrCtrl+Alt+Left':  'prev-pane',
      'CmdOrCtrl+Alt+Right': 'next-pane',
    },
  },

  plugins: [
    'hyper-keymap'
    // you can have another plugins as well
  ],
};

Keymap is an object of Electron's accelerator and Hyper's command.

keymap: {
  // 'accelerator'    :  'Hyper command'
  'CmdOrCtrl+Alt+Left':  'prev-pane',
}

Your keymap has prio over default one.

Electron's accelerators

It is a way to define keyboard shortcuts.

Accelerators can contain multiple modifiers and key codes, combined by the + character.

Examples:

  • CommandOrControl+A
  • CommandOrControl+Shift+Z

Check out Electron's accelerators documentation.

List of supported Hyper commands

  • show-settings
  • new-window
  • new-tab
  • split-vertical
  • split-horizontal
  • close
  • close-window
  • clear
  • show-settings
  • reload
  • reload-full
  • toggle-devtools
  • zoom-reset
  • zoom-in
  • zoom-out
  • update-plugins
  • prev-tab
  • next-tab
  • prev-pane
  • next-pane

License

MIT © Vladimir Starkov