mirror of
https://github.com/tiyn/action-hints.nvim.git
synced 2025-11-13 13:59:45 +01:00
74 lines
1.3 KiB
Markdown
74 lines
1.3 KiB
Markdown
# :zap: Action Hints
|
|
|
|
|
|
|
|
A Neovim plugin to show information about the word under the cursor.
|
|
|
|
Available hints:
|
|
|
|
- go-to-definition (`gd`) is available
|
|
- reference list (`gr`) available / number of references
|
|
|
|
## Installation
|
|
|
|
### Lazy
|
|
|
|
```lua
|
|
{
|
|
"roobert/action-hints.nvim",
|
|
config = function()
|
|
require("action-hints").setup()
|
|
end,
|
|
},
|
|
```
|
|
|
|
### Packer
|
|
|
|
```lua
|
|
use({
|
|
"roobert/action-hints.nvim",
|
|
config = function()
|
|
require("action-hints").setup()
|
|
end,
|
|
})
|
|
```
|
|
|
|
## Configuration
|
|
|
|
```lua
|
|
{
|
|
"roobert/action-hints.nvim",
|
|
config = function()
|
|
require("action-hints").setup({
|
|
template = {
|
|
{ " ⊛", "ActionHintsDefinition" },
|
|
{ " ↱%s", "ActionHintsReferences" },
|
|
},
|
|
use_virtual_text = true,
|
|
})
|
|
end,
|
|
},
|
|
```
|
|
|
|
Adjust highlight colours for virtual text:
|
|
|
|
```
|
|
highlight ActionHintsDefinition guifg=#add8e6
|
|
highlight ActionHintsReferences guifg=#ff6666
|
|
```
|
|
|
|
## Usage
|
|
|
|
Note that for now the component must be included in the lualine for the virtual text to
|
|
be updated.
|
|
|
|
As a lualine component:
|
|
|
|
```lua
|
|
require('lualine').setup {
|
|
sections = {
|
|
lualine_x = { require("action-hints").statusline },
|
|
}
|
|
}
|
|
```
|