feat: make floating window zindex configurable (#104)

Author: deathbeam

README.md

@@ -194,6 +194,7 @@ Also see [here](/lua/CopilotChat/config.lua):
   -- default window options
   window = {
     layout = 'vertical', -- 'vertical', 'horizontal', 'float'
+    -- Options below only apply to floating windows
     relative = 'editor', -- 'editor', 'win', 'cursor', 'mouse'
     border = 'single', -- 'none', single', 'double', 'rounded', 'solid', 'shadow'
     width = 0.8, -- fractional width of parent
@@ -202,6 +203,7 @@ Also see [here](/lua/CopilotChat/config.lua):
     col = nil, -- column position of the window, default is centered
     title = 'Copilot Chat', -- title of chat window
     footer = nil, -- footer of chat window
+    zindex = 1, -- determines if window is on top or below other floating windows
   },
   -- default mappings
   mappings = {

lua/CopilotChat/config.lua

@@ -27,6 +27,7 @@ local select = require('CopilotChat.select')
 ---@field col number?
 ---@field title string?
 ---@field footer string?
+---@field zindex number?
 
 ---@class CopilotChat.config.mappings
 ---@field close string?
@@ -95,6 +96,7 @@ return {
   -- default window options
   window = {
     layout = 'vertical', -- 'vertical', 'horizontal', 'float'
+    -- Options below only apply to floating windows
     relative = 'editor', -- 'editor', 'win', 'cursor', 'mouse'
     border = 'single', -- 'none', single', 'double', 'rounded', 'solid', 'shadow'
     width = 0.8, -- fractional width of parent
@@ -103,6 +105,7 @@ return {
     col = nil, -- column position of the window, default is centered
     title = 'Copilot Chat', -- title of chat window
     footer = nil, -- footer of chat window
+    zindex = 1, -- determines if window is on top or below other floating windows
   },
   -- default mappings
   mappings = {

lua/CopilotChat/init.lua

@@ -84,6 +84,7 @@ local function show_diff_between_selection_and_copilot()
         row = 0,
         col = 0,
         width = vim.api.nvim_win_get_width(0) - 3,
+        zindex = M.config.window.zindex + 1,
       })
     end
   end
@@ -317,7 +318,7 @@ function M.open(config)
     local layout = config.window.layout
 
     if layout == 'float' then
-      win_opts.zindex = 1
+      win_opts.zindex = config.window.zindex
       win_opts.relative = config.window.relative
       win_opts.border = config.window.border
       win_opts.title = config.window.title
@@ -329,7 +330,7 @@ function M.open(config)
       win_opts.height = math.floor(vim.o.lines * config.window.height)
     elseif layout == 'vertical' then
       if is_stable() then
-        win_opts.zindex = 1
+        win_opts.zindex = config.window.zindex
         win_opts.relative = 'editor'
         win_opts.width = math.floor(vim.o.columns * 0.5) -- 50% width
         win_opts.height = vim.o.lines -- full height
@@ -343,7 +344,7 @@ function M.open(config)
       end
     elseif layout == 'horizontal' then
       if is_stable() then
-        win_opts.zindex = 1
+        win_opts.zindex = config.window.zindex
         win_opts.relative = 'editor'
         win_opts.height = math.floor(vim.o.lines * 0.5) -- 50% height
         win_opts.width = vim.o.columns -- full width