Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chabou/hyper-pane
Extension for Hyper.app to enhance pane navigation.
https://github.com/chabou/hyper-pane
hyper hyperterm plugin shell
Last synced: 3 minutes ago
JSON representation
Extension for Hyper.app to enhance pane navigation.
- Host: GitHub
- URL: https://github.com/chabou/hyper-pane
- Owner: chabou
- License: mit
- Created: 2017-02-04T23:27:08.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-05-10T16:17:41.000Z (over 3 years ago)
- Last Synced: 2025-01-14T05:09:41.969Z (7 days ago)
- Topics: hyper, hyperterm, plugin, shell
- Language: JavaScript
- Homepage:
- Size: 287 KB
- Stars: 192
- Watchers: 5
- Forks: 13
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# hyper-pane
[](https://circleci.com/gh/chabou/hyper-pane)
[](https://www.npmjs.com/package/hyper-pane)
[](https://conventionalcommits.org)
Extension for Hyper.app to enhance pane navigation. Navigate through panes with arrows, jump directly to a specific pane with digit, change focus on mouse hover or temporarily maximize a pane.
Navigation with arrows:
Maximize pane:
Inspired by https://github.com/iamstarkov/hyper-panes-iterm2-hotkeys
## Install
To install, execute:
```
hyper i hyper-pane
```
Or edit `~/.hyper.js` manually and add `"hyper-pane"` to `plugins`:
```
plugins: [
"hyper-pane",
],
```
## Configuration
### Default configuration:
``` js
module.exports = {
config: {
// other configs...
paneNavigation: {
debug: false,
hotkeys: {
navigation: {
up: 'ctrl+alt+up',
down: 'ctrl+alt+down',
left: 'ctrl+alt+left',
right: 'ctrl+alt+right'
},
jump_prefix: 'ctrl+alt', // completed with 1-9 digits
permutation_modifier: 'shift', // Added to jump and navigation hotkeys for pane permutation
maximize: 'meta+enter'
},
showIndicators: true, // Show pane number
indicatorPrefix: '^⌥', // Will be completed with pane number
indicatorStyle: { // Added to indicator
position: 'absolute',
top: 0,
left: 0,
fontSize: '10px'
},
focusOnMouseHover: false,
inactivePaneOpacity: 0.6 // Set to 1 to disable inactive panes dimming
}
}
//...
};
```
### Supported keys
For modifier keys you can use `shift`, `ctrl`, `alt`, or `meta`. You can substitute `option` for `alt` and `command` for `meta`.
Other special keys are `backspace`, `tab`, `enter`, `return`, `capslock`, `esc`, `escape`, `space`, `pageup`, `pagedown`, `end`, `home`, `left`, `up`, `right`, `down`, `ins`, `del`, and `plus`.
Any other key you should be able to reference by name like `a`, `/`, `$`, `*`, or `=`.
**⚠ Warning**: Use `ctrl+alt` or `cmd+alt` modifier only with arrow and digit key. Otherwise, shortcut will not be detected by Hyper.
## Usage
### Navigation with arrows
Use `ctrl+alt+` (or your configured hotkeys) to navigate to a neighbor pane.
### Jump with digit
Use `ctrl+alt+<1-9>` (or your configured hotkeys) to jump directly to a numbered pane.
Panes are ordered "first child descendent" and `9` is reserved to the last pane.
Hotkey indicators are displayed on top left corner of each pane from 2 panes opened.
You can change its content, its style or hide them completly.
### Pane permutation
Adding `shift` key (or your configured key) to previous hotkeys cause a pane switching.
### Focus on mouse hover
Set `config.paneNavigation.focusOnMouseHover` to `true` and focus will change when mouse cursor enters into an another pane.
### Maximize a pane
You can temporarily maximize pane with `meta+enter` (or your configured key) and restore it with the same key.
You can have one maximized pane per tab.
### Dim inactive panes
By default, inactive panes are dimmed (opacity: 0.6).
You can disable this by setting `inactivePaneOpacity` to `1`.