feat(ui): chat buffer can be sticky when navigating tabs (#1842)

Davidyz · web-flow · commit 71fb6a80894c · 2025-07-17T22:17:31.000+01:00
diff --git a/doc/configuration/chat-buffer.md b/doc/configuration/chat-buffer.md
@@ -331,6 +331,7 @@ require("codecompanion").setup({
         width = 0.45,
         relative = "editor",
         full_height = true, -- when set to false, vsplit will be used to open the chat buffer vs. botright/topleft vsplit
+        sticky = false, -- when set to true and `layout` is not `"buffer"`, the chat buffer will remain opened when switching tabs
         opts = {
           breakindent = true,
           cursorcolumn = false,
diff --git a/lua/codecompanion/config.lua b/lua/codecompanion/config.lua
@@ -1027,6 +1027,7 @@ You must create or modify a workspace file through a series of prompts over mult
         width = 0.45,
         relative = "editor",
         full_height = true,
+        sticky = false, -- chat buffer remains open when switching tabs
         opts = {
           breakindent = true,
           cursorcolumn = false,
diff --git a/lua/codecompanion/init.lua b/lua/codecompanion/init.lua
@@ -12,6 +12,24 @@ local CodeCompanion = {
   extensions = _extensions.manager,
 }
 
+---Keep the chat buffer open when switching tabs
+---@return nil
+local function setup_sticky_chat_buffer()
+  api.nvim_create_autocmd("TabEnter", {
+    group = api.nvim_create_augroup("codecompanion.sticky_buffer", { clear = true }),
+    callback = function(args)
+      local chat = CodeCompanion.last_chat()
+      if chat and chat.ui:is_visible_non_curtab() then
+        chat.context = context_utils.get(args.buf)
+        vim.schedule(function()
+          CodeCompanion.close_last_chat()
+          chat.ui:open({ toggled = true })
+        end)
+      end
+    end,
+  })
+end
+
 ---Register an extension with setup and exports
 ---@param name string The name of the extension
 ---@param extension CodeCompanion.Extension The extension implementation
@@ -360,6 +378,11 @@ CodeCompanion.setup = function(opts)
       end
     end
   end
+
+  local window_config = config.display.chat.window
+  if window_config.sticky and (window_config.layout ~= "buffer") then
+    setup_sticky_chat_buffer()
+  end
 end
 
 return CodeCompanion
diff --git a/tests/test_cmds.lua b/tests/test_cmds.lua
@@ -39,4 +39,27 @@ T["cmds"][":CodeCompanionChat Toggle"] = function()
   expect.reference_screenshot(child.get_screenshot())
 end
 
+T["cmds"]["sticky chat window"] = function()
+  child.lua([[
+    require('codecompanion').setup({
+      display = {
+        chat = {
+          window = {
+            layout = "vertical",
+            sticky = true
+          }
+        }
+      }
+    })
+    vim.cmd("CodeCompanionChat")
+    vim.cmd("tabnew")
+  ]])
+
+  -- expect.reference_screenshot(child.get_screenshot())
+  -- window opened
+  h.eq(true, child.lua_get("require('codecompanion').last_chat().ui:is_visible()"))
+  -- window opened in the current tab (in other words, NOT in NON_CURRENT tab)
+  h.eq(false, child.lua_get("require('codecompanion').last_chat().ui:is_visible_non_curtab()"))
+end
+
 return T
