README.md

🪟 winresize.nvim

A neovim plugin which provide apis for resizing window as we expected.

📋 Requirements

• Neovim >= 0.10.0

📓 Introduction

When we editing files with multiple windows, you may notice a window is small for editing the file and will try to resize it.

The neovim provides keymaps such that CTRL-W_+, CTRL-W_-, CTRL-W_> and CTRL-W_<. But these are a little bit hard to press, so you will define keymaps like below.

vim.keymap.set("n", "rh", "<C-w><")
vim.keymap.set("n", "rj", "<C-w>+")
vim.keymap.set("n", "rk", "<C-w>-")
vim.keymap.set("n", "rl", "<C-w>>")

This keymaps works well when we are here of such layout, as rh and rl moves right edge of the window, and rj and rk moves bottom edge of the window.

+-------------+-------------+
|             |             |
|    here     |             |
|             |             |
+-------------+-------------+
|                           |
|                           |
|                           |
+---------------------------+

But unfortunately, the keymaps doesn't works when we are here of the layout, as the movement of rh and rl inverted compare to as we expected.

+-------------+-------------+
|             |             |
|             |    here     |
|             |             |
+-------------+-------------+
|                           |
|                           |
|                           |
+---------------------------+

So, this plugin provide resize function for such purpose. You can use it as follow.

local resize = function(win, amt, dir)
    return function()
        require("winresize").resize(win, amt, dir)
    end
end
vim.keymap.set("n", "rh", resize(0, 2, "left"))
vim.keymap.set("n", "rj", resize(0, 1, "down"))
vim.keymap.set("n", "rk", resize(0, 1, "up"))
vim.keymap.set("n", "rl", resize(0, 2, "right"))

With it, you can resize window intutively.

📥 Installation

With lazy.nvim

return {
    "pogyomo/winresize.nvim",
}

💡 Examples

Use this with submode.nvim

local submode = require("submode")
local resize = require("winresize").resize
submode.create("WinResize", {
    mode = "n",
    enter = "<Leader>r",
    leave = { "q", "<ESC>" },
}, {
    lhs = "h",
    rhs = function() resize(0, 2, "left") end,
}, {
    lhs = "j",
    rhs = function() resize(0, 1, "down") end,
}, {
    lhs = "k",
    rhs = function() resize(0, 1, "up") end,
}, {
    lhs = "l",
    rhs = function() resize(0, 2, "right") end,
})

🖥️ APIS

• resize(win, amount, dir)
  • Resize the window which is either normal window or floating window.
  • win: integer Window handle for resize. 0 for current window.
  • amount: integer How much to resize window. Must be positive.
  • dir: "left" | "right" | "up" | "down" Type of direction key to be used to resize.