🚁 HoverSplit

Overview

A Neovim plugin designed to enhance the Language Server Protocol (LSP) experience by providing hover information in a split window. With this plugin, it is possible to quickly access additional context, documentation, or information related to code symbols directly within Neovim without disrupting your workflow.

Features

• Hover Information: Get detailed hover information about symbols, functions, types, and more in a separate split window.
• Auto Update: The content automatically updates as the cursor moves to new targets.
• Flexible Display: Choose between horizontal and vertical splits
• Flexible Focus: Control whether the cursor remains focused on the split or returns to the original buffer.
• Toggle Splits: Easily toggle the split window open and closed using configurable key bindings.

Installation

Install hoversplit.nvim using any preferred plugin manager.

Example with lazy.nvim:

{
  "roobert/hoversplit.nvim",
  config = function()
    require("hoversplit").setup()
  end
}

The defaults are:

require("hoversplit").setup({
  conceallevel = 3,
  key_bindings_disabled = false,
  key_bindings = {
    split = "<leader>hS",
    vsplit = "<leader>hV",
    split_remain_focused = "<leader>hs",
    vsplit_remain_focused = "<leader>hv",
  },
})

Usage

Key Bindings

Configure key bindings for different functionalities. The default setup options are:

{
  "roobert/hoversplit.nvim",
  config = function()
    require("hoversplit").setup({
      key_bindings = {
        split = "<leader>hS",
        vsplit = "<leader>hV",
        split_remain_focused = "<leader>hs",
        vsplit_remain_focused = "<leader>hv",
      },
    })
  end,
}

Functions

• split: Opens a horizontal split with hover information, focusing on the split.
• vsplit: Opens a vertical split with hover information, focusing on the split.
• split_remain_focused: Opens a horizontal split without moving the focus from the original buffer.
• vsplit_remain_focused: Opens a vertical split without moving the focus from the original buffer.