diff --git a/README.md b/README.md index b40ae5d..241bd61 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ vim.g.symbols_outline = { goto_location = "", focus_location = "o", hover_symbol = "", - preview_symbol = "K", + toggle_preview = "K", rename_symbol = "r", code_actions = "a", }, @@ -103,16 +103,16 @@ vim.g.symbols_outline = { ### 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 | -| K | Show current symbol preview | -| r | Rename symbol | -| a | Code actions | -| ? | Show help message | +| 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 | +| K | Toggles the current symbol preview (Only when auto_preview is off) | +| r | Rename symbol | +| a | Code actions | +| ? | Show help message | ### Highlights | Highlight | Purpose | diff --git a/doc/symbols-outline.txt b/doc/symbols-outline.txt index 2b669af..e1460e3 100644 --- a/doc/symbols-outline.txt +++ b/doc/symbols-outline.txt @@ -58,7 +58,7 @@ or skip this section entirely if you want to roll with the defaults. goto_location = "", focus_location = "o", hover_symbol = "", - preview_symbol = "K", + toggle_preview = "K", rename_symbol = "r", code_actions = "a", }, @@ -218,8 +218,8 @@ symbol_blacklist ================================================================================ 5. COMMANDS *symbols-outline-commands* -| Command | Description | -| ---------------------- | ---------------------- | +| Command | Description | +| -------------------- | ---------------------- | | `:SymbolsOutline` | Toggle symbols outline | | `:SymbolsOutlineOpen` | Open symbols outline | | `:SymbolsOutlineClose` | Close symbols outline | @@ -227,16 +227,16 @@ symbol_blacklist ================================================================================ 6. DEFAULT KEYMAPS *symbols-outline-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 | -| K | Show current symbol preview | -| r | Rename symbol | -| a | Code actions | -| ? | Show help message | +| 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 | +| K | Toggles the current symbol preview (Only when auto_preview is off) | +| r | Rename symbol | +| a | Code actions | +| ? | Show help message | ================================================================================ 7. HIGHLIGHTS *symbols-outline-highlights* diff --git a/lua/symbols-outline.lua b/lua/symbols-outline.lua index e4b11ff..8b19609 100644 --- a/lua/symbols-outline.lua +++ b/lua/symbols-outline.lua @@ -22,9 +22,7 @@ local function setup_global_autocmd() vim.cmd( "au InsertLeave,WinEnter,BufEnter,BufWinEnter,TabEnter,BufWritePost * :lua require('symbols-outline')._refresh()") vim.cmd "au BufLeave * lua require'symbols-outline'._prevent_buffer_override()" - if config.options.auto_preview then - vim.cmd "au WinEnter * lua require'symbols-outline.preview'.close_if_not_in_outline()" - end + vim.cmd("au WinEnter * lua require'symbols-outline.preview'.close()") if config.options.highlight_hovered_item then vim.cmd( "autocmd CursorHold * :lua require('symbols-outline')._highlight_current_item()") @@ -34,8 +32,12 @@ end local function setup_buffer_autocmd() if config.options.auto_preview then vim.cmd( - "au CursorHold lua require'symbols-outline.preview'.show()") + "au CursorHold lua require'symbols-outline.preview'.show(true)") + else + vim.cmd( + "au CursorMoved lua require'symbols-outline.preview'.close()") end + end local function getParams() @@ -215,8 +217,8 @@ local function setup_keymaps(bufnr) nmap(config.options.keymaps.hover_symbol, ":lua require('symbols-outline.hover').show_hover()") -- preview symbol - nmap(config.options.keymaps.preview_symbol, - ":lua require('symbols-outline.preview').show()") + nmap(config.options.keymaps.toggle_preview, + ":lua require('symbols-outline.preview').toggle()") -- rename symbol nmap(config.options.keymaps.rename_symbol, ":lua require('symbols-outline.rename').rename()") diff --git a/lua/symbols-outline/config.lua b/lua/symbols-outline/config.lua index f1ea43e..c56cf51 100644 --- a/lua/symbols-outline/config.lua +++ b/lua/symbols-outline/config.lua @@ -16,7 +16,7 @@ local defaults = { goto_location = "", focus_location = "o", hover_symbol = "", - preview_symbol = "K", + toggle_preview = "K", rename_symbol = "r", code_actions = "a", show_help = "?", diff --git a/lua/symbols-outline/preview.lua b/lua/symbols-outline/preview.lua index f210050..084fb86 100644 --- a/lua/symbols-outline/preview.lua +++ b/lua/symbols-outline/preview.lua @@ -135,18 +135,6 @@ local function setup_hover_buf() update_hover() end -function M.close_if_not_in_outline() - if not is_current_win_outline() and has_code_win() then - if state.preview_win ~= nil and - vim.api.nvim_win_is_valid(state.preview_win) then - vim.api.nvim_win_close(state.preview_win, true) - end - if state.hover_win ~= nil and vim.api.nvim_win_is_valid(state.hover_win) then - vim.api.nvim_win_close(state.hover_win, true) - end - end -end - local function show_preview() if state.preview_win == nil and state.preview_buf == nil then state.preview_buf = vim.api.nvim_create_buf(false, true) @@ -198,12 +186,38 @@ local function show_hover() end end -function M.show() - if not is_current_win_outline() or #vim.api.nvim_list_wins() < 2 then +function M.show(force) + if not is_current_win_outline() or + #vim.api.nvim_list_wins() < 2 then return end + + if force ~= true and state.preview_win ~= nil then + return 1 + end + show_preview() show_hover() end +function M.close() + if has_code_win() then + if state.preview_win ~= nil and + vim.api.nvim_win_is_valid(state.preview_win) then + vim.api.nvim_win_close(state.preview_win, true) + end + if state.hover_win ~= nil and + vim.api.nvim_win_is_valid(state.hover_win) then + vim.api.nvim_win_close(state.hover_win, true) + end + end +end + +function M.toggle() + local code = M.show() + if code == 1 then + M.close() + end +end + return M