https://github.com/lukaspietzschmann/boo.nvim

Quickly pop-up lsp-powered infos of the thing your cursor is on
https://github.com/lukaspietzschmann/boo.nvim

neovim neovim-plugin

Last synced: 10 days ago
JSON representation

Quickly pop-up lsp-powered infos of the thing your cursor is on

• Host: GitHub
• URL: https://github.com/lukaspietzschmann/boo.nvim
• Owner: LukasPietzschmann
• License: bsd-3-clause
• Created: 2024-03-07T12:35:09.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-06-27T11:03:35.000Z (5 months ago)
• Last Synced: 2024-11-02T09:32:08.323Z (16 days ago)
• Topics: neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 40 KB
• Stars: 32
• Watchers: 1
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Boo 👻

Quickly pop-up some lsp-powered information of the thing your cursor is on.



  



## Installation

Install boo with your favorite package manager.

#### lazy.nvim

```lua

{

	'LukasPietzschmann/boo.nvim',

	opts = {

		-- here goes your config :)

	},

}

```

#### Others

With other package managers, you probably need to call the setup function yourself:

```lua

require('boo').setup({

	-- here goes your config :)

})

```

## Usage

1. You have to load boo

```lua

local boo = require('boo')

```

2. Then, you can call the `boo` function, which will show the pop-up

```lua

boo.boo()

```

3. You can also manually close the pop-up with

```lua

boo.close()

```

## Configuration

Here comes the default configuration with some explanation:

```lua

{

	-- win_opts will be used when creating the window. You can put everything here,

	-- that vim.api.nvim_open_win (https://neovim.io/doc/user/api.html#nvim_open_win())

	-- can handle.

	win_opts = {

		title = 'LSP Info',

		title_pos = 'center',

		relative = 'cursor',

		row = 1,

		col = 0,

		style = 'minimal',

		border = 'rounded',

		focusable = true,

	},

	-- The window will not be wider than max_width (in character cells)

	max_width = 80,

	-- The window will not be taller than max_height (in character cells)

	max_height = 20,

	-- When the boo window is focused, pressing one of these will close it.

	-- They will only be mapped in normalmode

	escape_mappings = { 'q', '' },

	-- Focus boo's window automatically after it's created

	focus_on_open = true,

	-- When the boo window is focused, and you'll focus another buffer,

	-- the window will be closed when this is set to true

	close_on_leave = true,

	-- When moving the cursor in the buffer that boo was opened from, boo

	-- will be closed. This makes most sense when paired with

	-- `focus_on_open = false`

	close_on_mouse_move = true,

}

```