Skip to content

โœจ Smoothly navigate between neovim and terminal multiplexer(s) โœจ

License

Notifications You must be signed in to change notification settings

numToStr/Navigator.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

38 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Navigator.nvim

โœจ Smoothly navigate between neovim and multiplexer(s) โœจ

Navigator

Navigator.nvim provides set of functions and commands that allows you to seamlessly navigate between neovim and different terminal multiplexers.

๐Ÿš€ Installation

Neovim

use {
    'numToStr/Navigator.nvim',
    config = function()
        require('Navigator').setup()
    end
}
Plug 'numToStr/Navigator.nvim'

" Somewhere after plug#end()
lua require('Navigator').setup()

โš’๏ธ Setup

Neovim

require('Navigator').setup()
  • Keybindings

Note - This plugin doesn't provide any keybindings by default, feel free to use (and modify) the following or create your own keybindings.

vim.keymap.set({'n', 't'}, '<A-h>', '<CMD>NavigatorLeft<CR>')
vim.keymap.set({'n', 't'}, '<A-l>', '<CMD>NavigatorRight<CR>')
vim.keymap.set({'n', 't'}, '<A-k>', '<CMD>NavigatorUp<CR>')
vim.keymap.set({'n', 't'}, '<A-j>', '<CMD>NavigatorDown<CR>')
vim.keymap.set({'n', 't'}, '<A-p>', '<CMD>NavigatorPrevious<CR>')

Multiplexer(s)

Note - This plugin doesn't provide any configuration for multiplexers, feel free to use (and modify) the snippet for multiplexer of your choice by following the links below.

Configuration (optional)

Following options can be given when calling setup({config}). Below is the default configuration

{
    -- Save modified buffer(s) when moving to mux
    -- nil - Don't save (default)
    -- 'current' - Only save the current modified buffer
    -- 'all' - Save all the buffers
    auto_save = nil,

    -- Disable navigation when the current mux pane is zoomed in
    disable_on_zoom = false,

    -- Multiplexer to use
    -- 'auto' - Chooses mux based on priority (default)
    -- table - Custom mux to use
    mux = 'auto'
}

Read: How to create and integrate custom multiplexer?

๐Ÿ”ฅ Usage

Commands

  • NavigatorLeft - Go to left split/pane
  • NavigatorRight - Go to right split/pane
  • NavigatorUp - Go to upper split/pane
  • NavigatorDown - Go to down split/pane
  • NavigatorPrevious - Go to previous split/pane

Read :h navigator.commands for more info

Lua API

require('Navigator').left()
require('Navigator').right()
require('Navigator').up()
require('Navigator').down()
require('Navigator').previous()

Read :h navigator.api for more info

๐Ÿ’ Credits