feat(keymapping): replace help bar with popup

Author: tanvirtin

lua/vgit/controller.lua

@@ -126,6 +126,7 @@ local toggle_tracing = loop.coroutine(function()
 end)
 
 local function help()
+  if screen_manager.help() then return end
   vim.cmd('h vgit')
 end
 

lua/vgit/features/screens/DiffScreen/init.lua

@@ -6,7 +6,7 @@ local Window = require('vgit.core.Window')
 local Buffer = require('vgit.core.Buffer')
 local console = require('vgit.core.console')
 local DiffView = require('vgit.ui.views.DiffView')
-local KeyHelpBarView = require('vgit.ui.views.KeyHelpBarView')
+local KeyHelpPopup = require('vgit.ui.popups.KeyHelpPopup')
 local Model = require('vgit.features.screens.DiffScreen.Model')
 local diff_preview_setting = require('vgit.settings.diff_preview')
 
@@ -36,34 +36,21 @@ function DiffScreen:create_diff_view(scene, model)
       },
     })
   end
-  return DiffView(scene, props, { row = 1 }, {
+
+  return DiffView(scene, props, {}, {
     elements = {
       header = true,
       footer = false,
     },
   })
 end
 
-function DiffScreen:create_app_bar_view(scene, model)
-  if model:is_hunk() then return nil end
-  return KeyHelpBarView(scene, {
-    keymaps = function()
-      local keymaps = diff_preview_setting:get('keymaps')
-      if model:is_staged() then
-        return {
-          { 'Unstage', keymaps['buffer_unstage'] },
-          { 'Unstage hunk', keymaps['buffer_hunk_unstage'] },
-          { 'Switch to Staged View', keymaps['toggle_view'] },
-        }
-      end
-      return {
-        { 'Stage', keymaps['buffer_stage'] },
-        { 'Stage hunk', keymaps['buffer_hunk_stage'] },
-        { 'Reset', keymaps['reset'] },
-        { 'Switch to Unstage View', keymaps['toggle_view'] },
-      }
-    end,
-  })
+function DiffScreen:help()
+  KeyHelpPopup({
+    config = {
+      keymaps = diff_preview_setting:get('keymaps')
+    }
+  }):mount()
 end
 
 function DiffScreen:constructor(opts)
@@ -75,7 +62,6 @@ function DiffScreen:constructor(opts)
     scene = scene,
     model = model,
     diff_view = DiffScreen:create_diff_view(scene, model),
-    app_bar_view = DiffScreen:create_app_bar_view(scene, model),
   }
 end
 
@@ -105,7 +91,6 @@ function DiffScreen:toggle_view(buffer)
 
     self.diff_view:render()
     self.diff_view:move_to_hunk(1, 'center')
-    if self.app_bar_view then self.app_bar_view:render() end
 
     return
   end
@@ -120,7 +105,6 @@ function DiffScreen:toggle_view(buffer)
 
   self.diff_view:render()
   self.diff_view:move_to_hunk(1, 'center')
-  if self.app_bar_view then self.app_bar_view:render() end
 end
 
 function DiffScreen:reset(buffer)
@@ -345,11 +329,6 @@ function DiffScreen:create(opts)
     return false
   end
 
-  if self.app_bar_view then
-    self.app_bar_view:define()
-    self.app_bar_view:mount()
-  end
-
   self.diff_view:define()
   self.diff_view:mount()
   self.diff_view:render()
@@ -359,8 +338,6 @@ function DiffScreen:create(opts)
   local mark_index = self.diff_view:get_relative_mark_index(lnum)
   self.diff_view:move_to_hunk(mark_index, 'center')
 
-  if self.app_bar_view then self.app_bar_view:render() end
-
   return true
 end
 

lua/vgit/features/screens/ProjectDiffScreen/init.lua

@@ -7,8 +7,8 @@ local Object = require('vgit.core.Object')
 local Window = require('vgit.core.Window')
 local console = require('vgit.core.console')
 local DiffView = require('vgit.ui.views.DiffView')
+local KeyHelpPopup = require('vgit.ui.popups.KeyHelpPopup')
 local StatusListView = require('vgit.ui.views.StatusListView')
-local KeyHelpBarView = require('vgit.ui.views.KeyHelpBarView')
 local Model = require('vgit.features.screens.ProjectDiffScreen.Model')
 local project_diff_preview_setting = require('vgit.settings.project_diff_preview')
 
@@ -24,22 +24,6 @@ function ProjectDiffScreen:constructor(opts)
     name = 'Project Diff Screen',
     scene = scene,
     model = model,
-    app_bar_view = KeyHelpBarView(scene, {
-      keymaps = function()
-        local keymaps = project_diff_preview_setting:get('keymaps')
-        return {
-          { 'Stage', keymaps['buffer_stage'] },
-          { 'Unstage', keymaps['buffer_unstage'] },
-          { 'Reset', keymaps['buffer_reset'] },
-          { 'Stage hunk', keymaps['buffer_hunk_stage'] },
-          { 'Unstage hunk', keymaps['buffer_hunk_unstage'] },
-          { 'Stage all', keymaps['stage_all'] },
-          { 'Unstage all', keymaps['unstage_all'] },
-          { 'Reset all', keymaps['reset_all'] },
-          { 'Commit', keymaps['commit'] },
-        }
-      end,
-    }),
     diff_view = DiffView(scene, {
       layout_type = function()
         return model:get_layout_type()
@@ -54,7 +38,6 @@ function ProjectDiffScreen:constructor(opts)
         return model:get_diff()
       end,
     }, {
-      row = 1,
       col = '25vw',
       width = '75vw',
     }, {
@@ -67,10 +50,7 @@ function ProjectDiffScreen:constructor(opts)
       entries = function()
         return model:get_entries()
       end,
-    }, {
-      row = 1,
-      width = '25vw',
-    }, {
+    }, { width = '25vw' }, {
       elements = {
         header = false,
         footer = true,
@@ -79,6 +59,14 @@ function ProjectDiffScreen:constructor(opts)
   }
 end
 
+function ProjectDiffScreen:help()
+  KeyHelpPopup({
+    config = {
+      keymaps = project_diff_preview_setting:get('keymaps')
+    }
+  }):mount()
+end
+
 function ProjectDiffScreen:hunk_up()
   self.diff_view:prev()
 end
@@ -528,12 +516,10 @@ function ProjectDiffScreen:create()
     return false
   end
 
-  self.app_bar_view:define()
   self.diff_view:define()
   self.status_list_view:define()
 
   self.diff_view:mount()
-  self.app_bar_view:mount()
   self.status_list_view:mount({
     event_handlers = {
       on_enter = function()
@@ -545,7 +531,6 @@ function ProjectDiffScreen:create()
     },
   })
 
-  self.app_bar_view:render()
   self.status_list_view:render()
 
   self:setup_keymaps()

lua/vgit/features/screens/ProjectStashScreen/init.lua

@@ -4,8 +4,8 @@ local utils = require('vgit.core.utils')
 local Object = require('vgit.core.Object')
 local console = require('vgit.core.console')
 local DiffView = require('vgit.ui.views.DiffView')
+local KeyHelpPopup = require('vgit.ui.popups.KeyHelpPopup')
 local StatusListView = require('vgit.ui.views.StatusListView')
-local KeyHelpBarView = require('vgit.ui.views.KeyHelpBarView')
 local Model = require('vgit.features.screens.ProjectStashScreen.Model')
 local project_stash_preview_setting = require('vgit.settings.project_stash_preview')
 
@@ -21,26 +21,11 @@ function ProjectStashScreen:constructor(opts)
     name = 'Stash Screen',
     scene = scene,
     model = model,
-    app_bar_view = KeyHelpBarView(scene, {
-      keymaps = function()
-        local keymaps = project_stash_preview_setting:get('keymaps')
-        return {
-          { 'Add stash', keymaps['add'] },
-          { 'Apply stash', keymaps['apply'] },
-          { 'Pop stash', keymaps['pop'] },
-          { 'Drop stash', keymaps['drop'] },
-          { 'Clear stash', keymaps['clear'] },
-        }
-      end,
-    }),
     status_list_view = StatusListView(scene, {
       entries = function()
         return model:get_entries()
       end,
-    }, {
-      row = 1,
-      width = '25vw',
-    }, {
+    }, { width = '25vw' }, {
       elements = {
         header = false,
         footer = true,
@@ -61,7 +46,6 @@ function ProjectStashScreen:constructor(opts)
         return model:get_diff()
       end,
     }, {
-      row = 1,
       col = '25vw',
       width = '75vw',
     }, {
@@ -73,6 +57,14 @@ function ProjectStashScreen:constructor(opts)
   }
 end
 
+function ProjectStashScreen:help()
+  KeyHelpPopup({
+    config = {
+      keymaps = project_stash_preview_setting:get('keymaps')
+    }
+  }):mount()
+end
+
 ProjectStashScreen.render_diff_view_debounced = loop.debounce_coroutine(function(self)
   self.diff_view:render()
   self.diff_view:move_to_hunk()
@@ -278,11 +270,9 @@ function ProjectStashScreen:create(opts)
   end
 
   self.diff_view:define()
-  self.app_bar_view:define()
   self.status_list_view:define()
 
   self.diff_view:mount()
-  self.app_bar_view:mount()
   self.status_list_view:mount({
     event_handlers = {
       on_move = function()
@@ -291,7 +281,6 @@ function ProjectStashScreen:create(opts)
     },
   })
 
-  self.app_bar_view:render()
   self.status_list_view:render()
 
   self:setup_keymaps()