Skip to content

Latest commit

 

History

History
123 lines (94 loc) · 3.46 KB

README.md

File metadata and controls

123 lines (94 loc) · 3.46 KB
Raw

🔍 Simple Zoom

A simple plugin to add a Tmux-like zoom functionality to Neovim.

simple-zoom-demo.mov

✨ Features

  • Zoom into a split similar to <prefix>z in Tmux
  • Toggle the zoom with a single command or mapping
  • Retain the view when toggling zoom
  • Can be integrated into the statusline

📚 Requirements

Neovim >= 0.7.0

📦 Installation

You can install the plugin with your preferred package manager:

{
    "fasterius/simple-zoom.nvim",
    config = true,
}

⚙️ Configuration

simple-zoom comes with the following options and their respective defaults:

{
    -- Hides the tabline when zooming. This is useful if you generally don't
    -- use tabs and would like the tabline to be hidden while zoomed, while not
    -- having to set a global `vim.o.showtabline = false` elsewhere in your
    -- config. If you DO have the tabline disabled globally you should also set
    -- this option to false.
    hide_tabline = true
}

A more complete installation and configuration could look like this:

{
    "fasterius/simple-zoom.nvim",
    opts = {
        hide_tabline = true
    },
}

🚀 Usage

This plugin does not set any key mappings by default, but instead provides the :SimpleZoomToggle command to toggle the zoom on or off. When toggling the zoom a new tab is created for the current split, for which a tab-specific variable is set. Upon toggling in a tab for which this tab-specific variable has been set, the tab is closed. The view is stored and loaded using mkview and loadview, respectively, which allows storage of e.g. cursor position, folds, etc.

If you want to create a key map for toggling zoom, you can do something like this:

vim.keymap.set('n', '<localleader>z', ':SimpleZoomToggle<CR>')

You can also access the underlying plugin function directly in a slightly more verbose way, if you prefer:

vim.keymap.set('n', '<localleader>z', require('simple-zoom').toggle_zoom)

🔥 Extras

Since Simple Zoom sets a tab-specific variable when zoomed in, it is possible to use this variable to set e.g. a statusline element to show when zoom is toggled. For example, this is how it could be done using the popular lualine.nvim plugin (the results of which are shown in the demo above):

local function IsZoomedIn()
    if vim.t['simple-zoom'] == nil then
        return ''
    elseif vim.t['simple-zoom']== 'zoom' then
        return '󰍉'
    end
end

require('lualine').setup {
    ...
    sections = {
        lualine_a = {
            { 'filename' },
            { IsZoomedIn },
        }
    }
    ...
}

📕 About

simple-zoom is very simple.

The aim of this plugin is to emulate the Tmux zoom functionality and nothing else, without extra functionality or additional bells and whistles. There are several other Neovim plugins that has similar functionality to simple-zoom, but that are also more fully-featured:

If you only care about the Tmux-like zoom functionality, simple-zoom is for you! If you are looking for something with additional features I recommend checking out the above mentioned plugins.