Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kizza/actionmenu.nvim
A nice context menu for vim
https://github.com/kizza/actionmenu.nvim
coc intellisense menu neovim nvim plugin popup
Last synced: 11 days ago
JSON representation
A nice context menu for vim
- Host: GitHub
- URL: https://github.com/kizza/actionmenu.nvim
- Owner: kizza
- Created: 2019-06-20T07:42:08.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-07-13T03:12:55.000Z (12 months ago)
- Last Synced: 2024-05-11T07:32:27.644Z (about 2 months ago)
- Topics: coc, intellisense, menu, neovim, nvim, plugin, popup
- Language: TypeScript
- Size: 161 KB
- Stars: 115
- Watchers: 6
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Lists
- awesome-stars - kizza/actionmenu.nvim - A nice context menu for vim (TypeScript)
- awesome-stars - actionmenu.nvim
- awesome-stars - kizza/actionmenu.nvim - A nice context menu for vim (TypeScript)
README
# A nice context menu for vim.
[](https://github.com/kizza/actionmenu.nvim/actions/workflows/tests.yml)
This is intended for use within vim plugins or scripts, to open a context menu and provide a callback with the selected item.
## Usage
The menu is opened with a simple function. It will open at the current cursor location with whatever items your provide.
```vim
call actionmenu#open(items, callback, {opts})
```
- `items` each item can be a string or a dictionary (see [complete-items](http://vimdoc.sourceforge.net/htmldoc/insert.html#complete-items))
- `callback` either a string or a [funcref()](http://vimdoc.sourceforge.net/htmldoc/eval.html#Funcref)
- Will be invoked with the selected `index` (zero based) and `item`
- Cancelling a selection will invoke the callback with an `index` of -1
- `opts` _(optional)_ Currently allows you to specify the icon for the menu
## A simple example
Just paste the snippet below into your `.vimrc` then execute `:call Demo()`
```vim
func! Demo()
call actionmenu#open(['First', 'Second', 'Third'], 'Callback')
endfunc
func! Callback(index, item)
echo "I selected index " . a:index
endfunc
```
## Example with Coc Code Actions (ie. context menu for a language server)
Use the actionmenu to list and execue available code actions [from coc.nvim plugin](https://github.com/neoclide/coc.nvim)
Once both `actionmenu.nvim` and `coc.nvim` are installed, put the folowing in your `.vimrc` file
```vim
let s:code_actions = []
func! ActionMenuCodeActions() abort
if coc#float#has_float()
call coc#float#close_all()
endif
let s:code_actions = CocAction('codeActions')
let l:menu_items = map(copy(s:code_actions), { index, item -> item['title'] })
call actionmenu#open(l:menu_items, 'ActionMenuCodeActionsCallback')
endfunc
func! ActionMenuCodeActionsCallback(index, item) abort
if a:index >= 0
let l:selected_code_action = s:code_actions[a:index]
let l:response = CocAction('doCodeAction', l:selected_code_action)
endif
endfunc
```
then map it to a keybinding eg. perhaps `s`
```vim
nnoremap s :call ActionMenuCodeActions()
```
[](https://asciinema.org/a/LjjAko5LGx2xUZtom0BVxih3c)
## More examples
Below is an example using vim's `complete-items` allowing you to pass in more complex data
```vim
func! Demo()
let l:items = [
\ { 'word': 'First', 'abbr': '1st', 'user_data': 'Custom data 1' },
\ { 'word': 'Second', 'abbr': '2nd', 'user_data': 'Custom data 2' },
\ { 'word': 'Third', 'abbr': '3rd', 'user_data': 'Custom data 3' }
\ ]
call actionmenu#open(
\ l:items,
\ { index, item -> Callback(index, item) }
\ )
endfunc
func! Callback(index, item)
if a:index >= 0
echo "Custom data is ". a:item['user_data']
endif
endfunc
```
You can open the actionmenu with a custom icon (i've recently been using [nerdfonts](http://nerdfonts.com/) for this)
```vim
func! Demo()
call actionmenu#open(
\ ['First', 'Second', 'Third'],
\ 'Callback',
\ { 'icon': { 'character': 'X', 'foreground': 'yellow' } }
\ )
endfunc
func! Callback(index, item)
echo "I selected index " . a:index
endfunc
```
## Requirements
The [latest version of neovim](https://github.com/neovim/neovim/wiki/Installing-Neovim) (which provides the "popup window" functionaity that is leveraged)
```
brew install --HEAD neovim
```
and this plugin (show below using [vim-plug](https://github.com/junegunn/vim-plug) installation - don't forget to run `:PlugInstall`)
```vim
if has('nvim')
Plug 'kizza/actionmenu.nvim'
endif
```
Once installed, you can try it out by running `:call actionmenu#example()`
## Finally
Build it into your existing plugin or useful scripts however you like!