feat: avoid taking up space when scrollbar is hidden

Author: Saghen

lua/blink/cmp/windows/lib/init.lua

@@ -155,7 +155,9 @@ function win:get_border_size()
 
   local border = self.config.border
   if border == 'none' then
-    if self.config.scrollbar then return { vertical = 0, horizontal = 1, left = 0, right = 1, top = 0, bottom = 0 } end
+    if self.scrollbar and self.scrollbar:is_visible() then
+      return { vertical = 0, horizontal = 1, left = 0, right = 1, top = 0, bottom = 0 }
+    end
     return { vertical = 0, horizontal = 0, left = 0, right = 0, top = 0, bottom = 0 }
   elseif border == 'padded' then
     return { vertical = 0, horizontal = 2, left = 1, right = 1, top = 0, bottom = 0 }
@@ -182,7 +184,9 @@ function win:get_border_size()
     return { vertical = top + bottom, horizontal = left + right, left = left, right = right, top = top, bottom = bottom }
   end
 
-  if self.config.scrollbar then return { vertical = 0, horizontal = 1, left = 0, right = 1, top = 0, bottom = 0 } end
+  if self.scrollbar and self.scrollbar:is_visible() then
+    return { vertical = 0, horizontal = 1, left = 0, right = 1, top = 0, bottom = 0 }
+  end
   return { vertical = 0, horizontal = 0, left = 0, right = 0, top = 0, bottom = 0 }
 end
 

lua/blink/cmp/windows/lib/scrollbar/geometry.lua

@@ -29,7 +29,7 @@ local function get_win_buf_height(target_win)
 end
 
 --- @param target_win number
---- @return { should_hide_thumb: boolean, thumb: blink.cmp.ScrollbarGeometry, gutter: blink.cmp.ScrollbarGeometry }
+--- @return { should_hide: boolean, thumb: blink.cmp.ScrollbarGeometry, gutter: blink.cmp.ScrollbarGeometry }
 function M.get_geometry(target_win)
   local width = vim.api.nvim_win_get_width(target_win)
   local height = vim.api.nvim_win_get_height(target_win)
@@ -52,7 +52,7 @@ function M.get_geometry(target_win)
   }
 
   return {
-    should_hide_thumb = height >= buf_height,
+    should_hide = height >= buf_height,
     thumb = vim.tbl_deep_extend('force', common_geometry, { height = thumb_height, zindex = zindex + 2 }),
     gutter = vim.tbl_deep_extend('force', common_geometry, { row = 0, height = height, zindex = zindex + 1 }),
   }

lua/blink/cmp/windows/lib/scrollbar/init.lua

@@ -7,6 +7,7 @@
 --- @field autocmd? number
 ---
 --- @field new fun(opts: blink.cmp.ScrollbarConfig): blink.cmp.Scrollbar
+--- @field is_visible fun(self: blink.cmp.Scrollbar): boolean
 --- @field is_mounted fun(self: blink.cmp.Scrollbar): boolean
 --- @field mount fun(self: blink.cmp.Scrollbar, target_win: number)
 --- @field unmount fun(self: blink.cmp.Scrollbar)
@@ -21,6 +22,8 @@ function scrollbar.new(opts)
   return self
 end
 
+function scrollbar:is_visible() return self.win:is_visible() end
+
 function scrollbar:is_mounted() return self.autocmd ~= nil end
 
 function scrollbar:mount(target_win)
@@ -40,12 +43,10 @@ function scrollbar:mount(target_win)
     if not vim.api.nvim_win_is_valid(target_win) then return self:unmount() end
 
     local updated_geometry = require('blink.cmp.windows.lib.scrollbar.geometry').get_geometry(target_win)
+    if updated_geometry.should_hide then return self.win:hide() end
+
+    self.win:show_thumb(updated_geometry.thumb)
     self.win:show_gutter(updated_geometry.gutter)
-    if updated_geometry.should_hide_thumb then
-      self.win:hide_thumb()
-    else
-      self.win:show_thumb(updated_geometry.thumb)
-    end
   end
   -- HACK: for some reason, the autocmds don't fire on the initial mount
   -- so we apply after on the next event loop iteration after the windows are definitely setup

lua/blink/cmp/windows/lib/scrollbar/win.lua

@@ -7,6 +7,7 @@
 --- @field buf? number
 ---
 --- @field new fun(opts: blink.cmp.ScrollbarConfig): blink.cmp.ScrollbarWin
+--- @field is_visible fun(self: blink.cmp.ScrollbarWin): boolean
 --- @field show_thumb fun(self: blink.cmp.ScrollbarWin, geometry: blink.cmp.ScrollbarGeometry)
 --- @field show_gutter fun(self: blink.cmp.ScrollbarWin, geometry: blink.cmp.ScrollbarGeometry)
 --- @field hide_thumb fun(self: blink.cmp.ScrollbarWin)
@@ -18,6 +19,8 @@ local scrollbar_win = {}
 
 function scrollbar_win.new(opts) return setmetatable(opts, { __index = scrollbar_win }) end
 
+function scrollbar_win:is_visible() return self.thumb_win ~= nil and vim.api.nvim_win_is_valid(self.thumb_win) end
+
 function scrollbar_win:show_thumb(geometry)
   -- create window if it doesn't exist
   if self.thumb_win == nil or not vim.api.nvim_win_is_valid(self.thumb_win) then