leigh/outline.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(config): Allow configuring keymaps

Browse Source 
Closes #1
This commit is contained in:
simrat39
2021-04-28 15:03:40 -07:00
parent abe479fe69
commit 067fd91f16
3 changed files with 58 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@@ -27,22 +27,40 @@ vim.g.symbols_outline = {
highlight_hovered_item = true,
show_guides = true,
position = 'right',
keymaps = {
close = "<Esc>",
goto_location = "<Cr>",
focus_location = "o",
hover_symbol = "<C-space>",
rename_symbol = "r",
code_actions = "a",
},
}
```
```vim
" init.vim
let g:symbols_outline = {}
let g:symbols_outline.highlight_hovered_item = v:true
let g:symbols_outline.show_guides = v:true
let g:symbols_outline.position = 'right'
let g:symbols_outline = {
\ "highlight_hovered_item": v:true,
\ "show_guides": v:true,
\ "position": 'right',
\ "keymaps": {
\ "close": "<Esc>",
\ "goto_location": "<Cr>",
\ "focus_location": "o",
\ "hover_symbol": "<C-space>",
\ "rename_symbol": "r",
\ "code_actions": "a",
\ },
\ }
```
| Property | Description | Type | Default |
| --- | -- | -- | -- |
| highlight_hovered_item | Whether to highlight the currently hovered symbol (high cpu usage) | boolean | true |
| show_guides | Wether to show outline guides | boolean | true |
| position | Where to open the split window | 'right' or 'left' | 'right' |
| Property | Description | Type | Default |
| ---------------------- | ------------------------------------------------------------------ | ----------------- | ------------------------ |
| highlight_hovered_item | Whether to highlight the currently hovered symbol (high cpu usage) | boolean | true |
| show_guides | Wether to show outline guides | boolean | true |
| position | Where to open the split window | 'right' or 'left' | 'right' |
| keymaps | Which keys do what | table | [here](#default-keymaps) |
### Commands
@@ -52,14 +70,14 @@ let g:symbols_outline.position = 'right'
| `:SymbolsOutlineOpen` | Open symbols outline |
| `:SymbolsOutlineClose` | Close symbols outline |
### Keymaps
### Default keymaps
| Key | Action |
| -- | -- |
| Escape | Close outline |
| Enter | Go to symbol location in code |
| o | Go to symbol location in code without losing focus |
| Ctrl+Space | Hover current symbol |
| r | Rename symbol |
| a | Code actions |
| Key | Action |
| ---------- | -------------------------------------------------- |
| Escape | Close outline |
| Enter | Go to symbol location in code |
| o | Go to symbol location in code without losing focus |
| Ctrl+Space | Hover current symbol |
| r | Rename symbol |
| a | Code actions |