Avoid scrolling the selection into view on refresh

stefanhaller · stefanhaller · commit efd4298b5e91 · 2025-12-23T15:34:38.000+01:00
It is possible to scroll the selection out of view using the mouse wheel; after
doing this, it would sometimes scroll into view by itself again, for example
when a background fetch occurred. In the files panel this would even happen
every 10s with every regular files refresh.

Fix this by adding a scrollIntoView parameter to HandleFocus, which is false by
default, and is only set to true from controllers that change the selection.
diff --git a/go.mod b/go.mod
@@ -18,7 +18,7 @@ require (
 	github.com/integrii/flaggy v1.4.0
 	github.com/jesseduffield/generics v0.0.0-20250517122708-b0b4a53a6f5c
 	github.com/jesseduffield/go-git/v5 v5.14.1-0.20250407170251-e1a013310ccd
-	github.com/jesseduffield/gocui v0.3.1-0.20251214132308-02ab34c1c624
+	github.com/jesseduffield/gocui v0.3.1-0.20251223143206-950739ccd44a
 	github.com/jesseduffield/lazycore v0.0.0-20221012050358-03d2e40243c5
 	github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0
 	github.com/karimkhaleel/jsonschema v0.0.0-20231001195015-d933f0d94ea3
diff --git a/go.sum b/go.sum
@@ -194,8 +194,8 @@ github.com/jesseduffield/generics v0.0.0-20250517122708-b0b4a53a6f5c h1:tC2Paiis
 github.com/jesseduffield/generics v0.0.0-20250517122708-b0b4a53a6f5c/go.mod h1:F2fEBk0ddf6ixrBrJjY7phfQ3hL9rXG0uSjvwYe50bE=
 github.com/jesseduffield/go-git/v5 v5.14.1-0.20250407170251-e1a013310ccd h1:ViKj6qth8FgcIWizn9KiACWwPemWSymx62OPN0tHT+Q=
 github.com/jesseduffield/go-git/v5 v5.14.1-0.20250407170251-e1a013310ccd/go.mod h1:lRhCiBr6XjQrvcQVa+UYsy/99d3wMXn/a0nSQlhnhlA=
-github.com/jesseduffield/gocui v0.3.1-0.20251214132308-02ab34c1c624 h1:30mIX4f52zrO4fWfZQKHJG29t2apcSOtR/sbd3BNsVE=
-github.com/jesseduffield/gocui v0.3.1-0.20251214132308-02ab34c1c624/go.mod h1:sLIyZ2J42R6idGdtemZzsiR3xY5EF0KsvYEGh3dQv3s=
+github.com/jesseduffield/gocui v0.3.1-0.20251223143206-950739ccd44a h1:XRsyqrSljes4TlaPczQViIAA4xqdnB0fKEEpZdqWWTA=
+github.com/jesseduffield/gocui v0.3.1-0.20251223143206-950739ccd44a/go.mod h1:sLIyZ2J42R6idGdtemZzsiR3xY5EF0KsvYEGh3dQv3s=
 github.com/jesseduffield/lazycore v0.0.0-20221012050358-03d2e40243c5 h1:CDuQmfOjAtb1Gms6a1p5L2P8RhbLUq5t8aL7PiQd2uY=
 github.com/jesseduffield/lazycore v0.0.0-20221012050358-03d2e40243c5/go.mod h1:qxN4mHOAyeIDLP7IK7defgPClM/z1Kze8VVQiaEjzsQ=
 github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
diff --git a/pkg/gui/context/list_context_trait.go b/pkg/gui/context/list_context_trait.go
@@ -25,8 +25,8 @@ type ListContextTrait struct {
 
 func (self *ListContextTrait) IsListContext() {}
 
-func (self *ListContextTrait) FocusLine() {
-	self.Context.FocusLine()
+func (self *ListContextTrait) FocusLine(scrollIntoView bool) {
+	self.Context.FocusLine(scrollIntoView)
 
 	// Doing this at the end of the layout function because we need the view to be
 	// resized before we focus the line, otherwise if we're in accordion mode
@@ -36,7 +36,7 @@ func (self *ListContextTrait) FocusLine() {
 		oldOrigin, _ := self.GetViewTrait().ViewPortYBounds()
 
 		self.GetViewTrait().FocusPoint(
-			self.ModelIndexToViewIndex(self.list.GetSelectedLineIdx()))
+			self.ModelIndexToViewIndex(self.list.GetSelectedLineIdx()), scrollIntoView)
 
 		selectRangeIndex, isSelectingRange := self.list.GetRangeStartIdx()
 		if isSelectingRange {
@@ -75,7 +75,7 @@ func formatListFooter(selectedLineIdx int, length int) string {
 }
 
 func (self *ListContextTrait) HandleFocus(opts types.OnFocusOpts) {
-	self.FocusLine()
+	self.FocusLine(opts.ScrollSelectionIntoView)
 
 	self.GetViewTrait().SetHighlight(self.list.Len() > 0)
 
diff --git a/pkg/gui/context/simple_context.go b/pkg/gui/context/simple_context.go
@@ -54,7 +54,7 @@ func (self *SimpleContext) HandleFocusLost(opts types.OnFocusLostOpts) {
 	}
 }
 
-func (self *SimpleContext) FocusLine() {
+func (self *SimpleContext) FocusLine(scrollIntoView bool) {
 }
 
 func (self *SimpleContext) HandleRender() {
diff --git a/pkg/gui/context/view_trait.go b/pkg/gui/context/view_trait.go
@@ -17,8 +17,8 @@ func NewViewTrait(view *gocui.View) *ViewTrait {
 	return &ViewTrait{view: view}
 }
 
-func (self *ViewTrait) FocusPoint(yIdx int) {
-	self.view.FocusPoint(self.view.OriginX(), yIdx)
+func (self *ViewTrait) FocusPoint(yIdx int, scrollIntoView bool) {
+	self.view.FocusPoint(self.view.OriginX(), yIdx, scrollIntoView)
 }
 
 func (self *ViewTrait) SetRangeSelectStart(yIdx int) {
diff --git a/pkg/gui/controllers/helpers/cherry_pick_helper.go b/pkg/gui/controllers/helpers/cherry_pick_helper.go
@@ -101,7 +101,7 @@ func (self *CherryPickHelper) Paste() error {
 				// below the selection.
 				if commit := self.c.Contexts().LocalCommits.GetSelected(); commit != nil && !commit.IsTODO() {
 					self.c.Contexts().LocalCommits.MoveSelection(len(cherryPickedCommits))
-					self.c.Contexts().LocalCommits.FocusLine()
+					self.c.Contexts().LocalCommits.FocusLine(true)
 				}
 
 				// If we're in the cherry-picking state at this point, it must
diff --git a/pkg/gui/controllers/helpers/refs_helper.go b/pkg/gui/controllers/helpers/refs_helper.go
@@ -35,6 +35,9 @@ func (self *RefsHelper) SelectFirstBranchAndFirstCommit() {
 	self.c.Contexts().Branches.SetSelection(0)
 	self.c.Contexts().ReflogCommits.SetSelection(0)
 	self.c.Contexts().LocalCommits.SetSelection(0)
+	self.c.Contexts().Branches.GetView().SetOriginY(0)
+	self.c.Contexts().ReflogCommits.GetView().SetOriginY(0)
+	self.c.Contexts().LocalCommits.GetView().SetOriginY(0)
 }
 
 func (self *RefsHelper) CheckoutRef(ref string, options types.CheckoutRefOptions) error {
diff --git a/pkg/gui/controllers/list_controller.go b/pkg/gui/controllers/list_controller.go
@@ -116,7 +116,7 @@ func (self *ListController) handleLineChangeAux(f func(int), change int) error {
 	}
 
 	if cursorMoved || rangeBefore != rangeAfter {
-		self.context.HandleFocus(types.OnFocusOpts{})
+		self.context.HandleFocus(types.OnFocusOpts{ScrollSelectionIntoView: true})
 	}
 
 	return nil
@@ -173,6 +173,8 @@ func (self *ListController) handlePageChange(delta int) error {
 		}
 	}
 
+	// Since we are maintaining the scroll position ourselves above, there's no point in passing
+	// ScrollSelectionIntoView=true here.
 	self.context.HandleFocus(types.OnFocusOpts{})
 
 	return nil
diff --git a/pkg/gui/controllers/local_commits_controller.go b/pkg/gui/controllers/local_commits_controller.go
@@ -869,7 +869,7 @@ func (self *LocalCommitsController) revert(commits []*models.Commit, start, end
 					return err
 				}
 				self.context().MoveSelection(len(commits))
-				self.context().HandleFocus(types.OnFocusOpts{})
+				self.context().HandleFocus(types.OnFocusOpts{ScrollSelectionIntoView: true})
 
 				if mustStash {
 					if err := self.c.Git().Stash.Pop(0); err != nil {
diff --git a/pkg/gui/controllers/stash_controller.go b/pkg/gui/controllers/stash_controller.go
@@ -205,7 +205,7 @@ func (self *StashController) handleRenameStashEntry(stashEntry *models.StashEntr
 				return err
 			}
 			self.context().SetSelection(0) // Select the renamed stash
-			self.context().FocusLine()
+			self.context().FocusLine(true)
 			self.c.Refresh(types.RefreshOptions{Scope: []types.RefreshableView{types.STASH}})
 			return nil
 		},
diff --git a/pkg/gui/types/context.go b/pkg/gui/types/context.go
@@ -109,7 +109,7 @@ type Context interface {
 
 	HandleFocus(opts OnFocusOpts)
 	HandleFocusLost(opts OnFocusLostOpts)
-	FocusLine()
+	FocusLine(scrollIntoView bool)
 	HandleRender()
 	HandleRenderToMain()
 }
@@ -201,7 +201,7 @@ type IPatchExplorerContext interface {
 }
 
 type IViewTrait interface {
-	FocusPoint(yIdx int)
+	FocusPoint(yIdx int, scrollIntoView bool)
 	SetRangeSelectStart(yIdx int)
 	CancelRangeSelect()
 	SetViewPortContent(content string)
@@ -221,8 +221,9 @@ type IViewTrait interface {
 }
 
 type OnFocusOpts struct {
-	ClickedWindowName  string
-	ClickedViewLineIdx int
+	ClickedWindowName       string
+	ClickedViewLineIdx      int
+	ScrollSelectionIntoView bool
 }
 
 type OnFocusLostOpts struct {
diff --git a/pkg/gui/view_helpers.go b/pkg/gui/view_helpers.go
@@ -140,7 +140,7 @@ func (gui *Gui) postRefreshUpdate(c types.Context) {
 		// non-focused views to ensure that an inactive selection is painted
 		// correctly, and that integration tests see the up to date selection
 		// state.
-		c.FocusLine()
+		c.FocusLine(false)
 
 		currentCtx := gui.State.ContextMgr.Current()
 		if currentCtx.GetKey() == context.NORMAL_MAIN_CONTEXT_KEY || currentCtx.GetKey() == context.NORMAL_SECONDARY_CONTEXT_KEY {
diff --git a/pkg/integration/clients/tui.go b/pkg/integration/clients/tui.go
@@ -51,7 +51,7 @@ func RunTUI(raceDetector bool) {
 		if err != nil {
 			return err
 		}
-		listView.FocusPoint(0, app.itemIdx)
+		listView.FocusPoint(0, app.itemIdx, true)
 		return nil
 	}); err != nil {
 		log.Panicln(err)
@@ -66,7 +66,7 @@ func RunTUI(raceDetector bool) {
 		if err != nil {
 			return err
 		}
-		listView.FocusPoint(0, app.itemIdx)
+		listView.FocusPoint(0, app.itemIdx, true)
 		return nil
 	}); err != nil {
 		log.Panicln(err)
diff --git a/vendor/github.com/jesseduffield/gocui/view.go b/vendor/github.com/jesseduffield/gocui/view.go
diff --git a/vendor/modules.txt b/vendor/modules.txt
@@ -221,7 +221,7 @@ github.com/jesseduffield/go-git/v5/utils/merkletrie/internal/frame
 github.com/jesseduffield/go-git/v5/utils/merkletrie/noder
 github.com/jesseduffield/go-git/v5/utils/sync
 github.com/jesseduffield/go-git/v5/utils/trace
-# github.com/jesseduffield/gocui v0.3.1-0.20251214132308-02ab34c1c624
+# github.com/jesseduffield/gocui v0.3.1-0.20251223143206-950739ccd44a
 ## explicit; go 1.12
 github.com/jesseduffield/gocui
 # github.com/jesseduffield/lazycore v0.0.0-20221012050358-03d2e40243c5

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ func (self *SimpleContext) HandleFocusLost(opts types.OnFocusLostOpts) {`
`54`	`54`	`}`
`55`	`55`	`}`
`56`	`56`
`57`		`-func (self *SimpleContext) FocusLine() {`
	`57`	`+func (self *SimpleContext) FocusLine(scrollIntoView bool) {`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`func (self *SimpleContext) HandleRender() {`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,8 @@ func NewViewTrait(view gocui.View) ViewTrait {`
`17`	`17`	`return &ViewTrait{view: view}`
`18`	`18`	`}`
`19`	`19`
`20`		`-func (self *ViewTrait) FocusPoint(yIdx int) {`
`21`		`- self.view.FocusPoint(self.view.OriginX(), yIdx)`
	`20`	`+func (self *ViewTrait) FocusPoint(yIdx int, scrollIntoView bool) {`
	`21`	`+ self.view.FocusPoint(self.view.OriginX(), yIdx, scrollIntoView)`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`func (self *ViewTrait) SetRangeSelectStart(yIdx int) {`
Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ func (self *CherryPickHelper) Paste() error {`
`101`	`101`	`// below the selection.`
`102`	`102`	`if commit := self.c.Contexts().LocalCommits.GetSelected(); commit != nil && !commit.IsTODO() {`
`103`	`103`	`self.c.Contexts().LocalCommits.MoveSelection(len(cherryPickedCommits))`
`104`		`- self.c.Contexts().LocalCommits.FocusLine()`
	`104`	`+ self.c.Contexts().LocalCommits.FocusLine(true)`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`// If we're in the cherry-picking state at this point, it must`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,9 @@ func (self *RefsHelper) SelectFirstBranchAndFirstCommit() {`
`35`	`35`	`self.c.Contexts().Branches.SetSelection(0)`
`36`	`36`	`self.c.Contexts().ReflogCommits.SetSelection(0)`
`37`	`37`	`self.c.Contexts().LocalCommits.SetSelection(0)`
	`38`	`+ self.c.Contexts().Branches.GetView().SetOriginY(0)`
	`39`	`+ self.c.Contexts().ReflogCommits.GetView().SetOriginY(0)`
	`40`	`+ self.c.Contexts().LocalCommits.GetView().SetOriginY(0)`
`38`	`41`	`}`
`39`	`42`
`40`	`43`	`func (self *RefsHelper) CheckoutRef(ref string, options types.CheckoutRefOptions) error {`
Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ func (self *ListController) handleLineChangeAux(f func(int), change int) error {`
`116`	`116`	`}`
`117`	`117`
`118`	`118`	`if cursorMoved \|\| rangeBefore != rangeAfter {`
`119`		`- self.context.HandleFocus(types.OnFocusOpts{})`
	`119`	`+ self.context.HandleFocus(types.OnFocusOpts{ScrollSelectionIntoView: true})`
`120`	`120`	`}`
`121`	`121`
`122`	`122`	`return nil`
`@@ -173,6 +173,8 @@ func (self *ListController) handlePageChange(delta int) error {`
`173`	`173`	`}`
`174`	`174`	`}`
`175`	`175`
	`176`	`+ // Since we are maintaining the scroll position ourselves above, there's no point in passing`
	`177`	`+ // ScrollSelectionIntoView=true here.`
`176`	`178`	`self.context.HandleFocus(types.OnFocusOpts{})`
`177`	`179`
`178`	`180`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -869,7 +869,7 @@ func (self LocalCommitsController) revert(commits []models.Commit, start, end`
`869`	`869`	`return err`
`870`	`870`	`}`
`871`	`871`	`self.context().MoveSelection(len(commits))`
`872`		`- self.context().HandleFocus(types.OnFocusOpts{})`
	`872`	`+ self.context().HandleFocus(types.OnFocusOpts{ScrollSelectionIntoView: true})`
`873`	`873`
`874`	`874`	`if mustStash {`
`875`	`875`	`if err := self.c.Git().Stash.Pop(0); err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -205,7 +205,7 @@ func (self StashController) handleRenameStashEntry(stashEntry models.StashEntr`
`205`	`205`	`return err`
`206`	`206`	`}`
`207`	`207`	`self.context().SetSelection(0) // Select the renamed stash`
`208`		`- self.context().FocusLine()`
	`208`	`+ self.context().FocusLine(true)`
`209`	`209`	`self.c.Refresh(types.RefreshOptions{Scope: []types.RefreshableView{types.STASH}})`
`210`	`210`	`return nil`
`211`	`211`	`},`