https://github.com/gbrlsnchs/winpick.nvim

Simple window picker for Neovim
https://github.com/gbrlsnchs/winpick.nvim

neovim plugin

Last synced: 8 days ago
JSON representation

Simple window picker for Neovim

• Host: GitHub
• URL: https://github.com/gbrlsnchs/winpick.nvim
• Owner: gbrlsnchs
• License: mit
• Created: 2021-10-29T21:36:52.000Z (about 3 years ago)
• Default Branch: trunk
• Last Pushed: 2022-08-23T20:55:53.000Z (about 2 years ago)
• Last Synced: 2024-08-02T13:33:22.709Z (3 months ago)
• Topics: neovim, plugin
• Language: Lua
• Homepage:
• Size: 44.9 KB
• Stars: 46
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# winpick.nvim

[![winpick.nvim

CI](https://github.com/gbrlsnchs/winpick.nvim/actions/workflows/ci.yml/badge.svg)](https://github.com/gbrlsnchs/winpick.nvim/actions/workflows/ci.yml)

![Example of how winpick works](https://i.imgur.com/4xACRUJ.png)

Plugin that helps with picking windows.

## Installation

Use whichever plugin management practices you prefer. Personally I like Neovim's built-in plugin

management system (`:help packages`) combined with Git submodules, but that choice is up to you!

## Usage

> Note: use `:help winpick.txt` for a Vim friendly documentation.

This plugin is a single-function library that helps with picking a window inside Neovim.

Basically, it shows visual cues with labels assigned to them. Meanwhile, it also prompts the user

with a label. Once the user presses the respective key to a label, the function returns the selected

window's ID and its corresponding buffer ID, or just `nil` if no window is selected.

## Setup

Here an example with all default options:

```lua

winpick.setup({

	border = "double",

	filter = nil, -- doesn't ignore any window by default

	prompt = "Pick a window: ",

	format_label = winpick.defaults.format_label, -- formatted as ": "

	chars = nil,

})

```

## Options

From `:help winpick-options`:

```vimhelp

• border (string) Style of visual cues' borders. Defaults to `double`.

• filter (function) Predicate function that receives a target window's

corresponding ID and buffer ID and returns whether that window is eligible

for being picked. Defaults to `nil`, thus not ignoring any window.

• prompt (string) Prompt message when cues are visible.

• format_label (function) Function that formats the labels for visual

cues. It receives the target window ID as first parameter and the

corresponding label for the visual cue (A, B, C, etc). Defaults to

printing the respective label and the buffer name, if any.

• chars (table) List containing `n` characters that will be used for labels

in the first `n` visual cues opened. For a number of windows greater than

`n`, complementary characters will be additionally used. Defaults to `nil`,

and a default alphabet is used.

```

## Some examples

Moving to a window

```lua

local winid = winpick.select()

if winid then

	vim.api.nvim_set_current_win(winid)

end

```

Copying a buffer's path

```lua

local winid, bufnr = winpick.select({

	filter = function(winid, bufnr, default_filter)

		if vim.api.nvim_buf_get_option(bufnr, "buftype") == "terminal" then

			return false

		end

		return default_filter(winid, bufnr)

	end,

})

if not winid then

	return

end

local name = api.nvim_buf_get_name(bufnr)

if name then

	vim.fn.setreg("+", vim.fn.fnamemodify(name, ":~:."))

end

```