Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

declancm/maximize.nvim

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

70 Commits
70 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

maximize.nvim

Maximize Neovim windows.

✨ Features

  • Toggle maximizing the current window without any ugly borders.
  • Has builtin integration for the following plugins:
    • aerial.nvim
    • nvim-dap-ui
    • nvim-tree.lua

🛠️ Requirements

  • Neovim >= 0.8.0 (use a tagged version for older Neovim versions)

📦 Installation

Install with your favourite plugin manager and run the setup function.

Packer

use {
  'declancm/maximize.nvim',
  config = function() require('maximize').setup() end
}

Lazy

return {
  'declancm/maximize.nvim',
  config = true
}

ℹ️ Usage

Vim Commands

  • Toggle maximizing the current window:

    :Maximize

Lua API

  • Toggle maximizing the current window:

    require('maximize').toggle()

  • Maximize the current window:

    require('maximize').maximize()

  • Restore windows:

    require('maximize').restore()

⚙️ Configuration

A settings table can be passed into the setup function for custom options.

Default Options

{
  plugins = {
    aerial = { enable = true }, -- enable aerial.nvim integration
    dapui = { enable = true },  -- enable nvim-dap-ui integration
    tree = { enable = true },   -- enable nvim-tree.lua integration
  }
}

📅 User Events

The following user events are triggered:

  • WindowMaximizeStart: before maximizing
  • WindowRestoreEnd: after restoring

🚥 statusline & winbar

Use the variable vim.t.maximized to check whether the tab has a maximized window.

Lualine

local function maximize_status()
  return vim.t.maximized and '' or ''
end

require('lualine').setup {
  sections = {
    lualine_c = { maximize_status }
  }
}

winbar

-- ~/.config/nvim/lua/winbar.lua
local M = {}

M.maximize_status = function()
  return vim.t.maximized and '' or ''
end

return M

-- ~/.config/nvim/init.lua
vim.o.winbar = "%{%v:lua.require('winbar').maximize_status()%}"

About

Maximize window splits. A Neovim plugin written in Lua!

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.