Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nvchad/menu
Menu ui for neovim ( supports nested menus ) made using volt
https://github.com/nvchad/menu
lua menu neovim neovim-plugin nvchad
Last synced: 3 months ago
JSON representation
Menu ui for neovim ( supports nested menus ) made using volt
- Host: GitHub
- URL: https://github.com/nvchad/menu
- Owner: NvChad
- License: gpl-3.0
- Created: 2024-09-11T04:55:04.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-09T14:18:09.000Z (4 months ago)
- Last Synced: 2024-10-12T11:06:33.374Z (3 months ago)
- Topics: lua, menu, neovim, neovim-plugin, nvchad
- Language: Lua
- Homepage:
- Size: 36.1 KB
- Stars: 313
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Menu
Menu ui for neovim ( supports nested menus )
https://github.com/user-attachments/assets/89d96170-e039-4d3d-9640-0fdc3358a833
## Install
```lua
{ "nvchad/volt" , lazy = true },
{ "nvchad/menu" , lazy = true },
```
## Usage
```lua
require("menu").open(options, opts)
```
- options is a table or string, if string then it will look at the table from menus* module of this repo
- opts : { mouse = true, border = false }"
### For keyboard users
- Use `h` `l` to move between windows
- Use `q` to close the window
- Press the keybind defined for menu item or scroll to it and press enter, to execute it
### Examples
- Keyboard users can run the mapping when inside the menu, mouse users can click.
```lua
-- Keyboard users
vim.keymap.set("n", "", function()
require("menu").open("default")
end, {})
-- mouse users + nvimtree users!
vim.keymap.set("n", "", function()
vim.cmd.exec '"normal! \\"'
local options = vim.bo.ft == "NvimTree" and "nvimtree" or "default"
require("menu").open(options, { mouse = true })
end, {})
```
Check example of [defaults menu](https://github.com/NvChad/menu/blob/main/lua/menus/default.lua) to see know syntax of options table.
### Why?
I know a lot of you all would be infuriated by this plugin. here are some reasons for me to use it:
- There are times when i'd want to perform some action but i dont want to set command/mapping for it, like one of those gitsigns commands, they're very useful and so many commands but i rarely use them. So a menu option with quick mouse click
or menu opened from keybind would suffice!
- I already got so many keybinds, I dont want to add more if I dont use it too frequently so I could use this menu!
- I use my pc for more than 10 hours a day ( including, for the remote job I got ) and my keyboard usage is very high cuz of Vim so at times my fingers hurt and using mouse would tone it down.