https://github.com/meeehdi-dev/win-picker.nvim
🎯 Simple window picker for Neovim
https://github.com/meeehdi-dev/win-picker.nvim
lua neovim neovim-lua neovim-plugin neovim-plugins window-picker
Last synced: 11 months ago
JSON representation
🎯 Simple window picker for Neovim
- Host: GitHub
- URL: https://github.com/meeehdi-dev/win-picker.nvim
- Owner: meeehdi-dev
- License: mit
- Created: 2023-09-03T12:06:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-10T15:18:20.000Z (over 1 year ago)
- Last Synced: 2024-07-10T18:29:32.929Z (over 1 year ago)
- Topics: lua, neovim, neovim-lua, neovim-plugin, neovim-plugins, window-picker
- Language: Lua
- Homepage:
- Size: 33.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Win-picker.nvim
Win-picker allows you to quickly focus any window in your tabpane.
It was first inspired by the default window picker of [nvim-tree](https://github.com/nvim-tree/nvim-tree.lua).
And then I decided to move to the float mode inspired by [nvim-window](https://github.com/yorickpeterse/nvim-window).
### So, why use this picker instead of those mentioned ones or any other one, you might ask?
I just wanted to create my first neovim plugin and keep it as simple as possible (~100LOC), so that anyone curious can tinker with it easily.
## Configuration
Here is the default configuration.
- `chars` is a string defining the characters used to select the window.
- `filter` is a function receiving a win_id as parameter and returning a boolean to filter out a window.
- `hl_group` is a string designating a predefined highlight group.
```lua
require('win-picker').setup({
chars = "1234567890",
filter = nil,
hl_group = nil,
})
```
## Usage
Install and configure using [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
'meeehdi-dev/win-picker.nvim',
config = true, -- setup with default options
keys = {
{
"!",
function()
local win_id = require("win-picker").pick_win()
if win_id then
vim.api.nvim_set_current_win(win_id)
end
end,
},
},
}
-- or
{
'meeehdi-dev/win-picker.nvim',
opts = {
chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
filter = function(id)
local bufid = vim.api.nvim_win_get_buf(id)
local ft = vim.api.nvim_buf_get_option(bufid, "filetype")
return not vim.tbl_contains({ "noice", "notify" }, ft)
end,
hl_group = "WinPicker",
},
config = function (_, opts)
vim.api.nvim_command("hi def WinPicker gui=bold guifg=#1d202f guibg=#7aa2f7")
require("win-picker").setup(opts)
end,
keys = {
{
"w",
function()
local win_id = require("win-picker").pick_win()
if win_id then
vim.api.nvim_set_current_win(win_id)
end
end,
},
},
}
```
It can also be used as the window picker for nvim-tree
```lua
{
"nvim-tree/nvim-tree.lua",
dependencies = {
{
"meeehdi-dev/win-picker.nvim",
config = true,
},
},
opts = {
actions = {
open_file = {
window_picker = {
picker = function()
return require("win-picker").pick_win({
-- you can set the same options as in the config
hl_group = "lualine_a_normal", -- use lualine normal mode hl group
})
end,
},
},
},
},
-- ...
},
```