Skip to content

Add an optional ShouldHandleMouseEvent hook #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stefanhaller merged 2 commits into from
Mar 8, 2026
Merged

Add an optional ShouldHandleMouseEvent hook #100

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0124962
Handle hyperlinks earlier, and tabs later
stefanhaller Mar 7, 2026
00c06c4
Add an optional ShouldHandleMouseEvent hook
stefanhaller Feb 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 29 additions & 17 deletions gui.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,8 @@ type Gui struct {

ErrorHandler func(error) error

ShouldHandleMouseEvent func(view *View, key Key) bool

screen tcell.Screen
suspendedMutex sync.Mutex
suspended bool
Expand Down Expand Up @@ -1329,19 +1331,6 @@ func (g *Gui) onKey(ev *GocuiEvent) error {
if err != nil {
break
}
if v.Frame && my == v.y0 {
if len(v.Tabs) > 0 {
tabIndex := v.GetClickedTabIndex(mx - v.x0)

if tabIndex >= 0 {
for _, binding := range g.tabClickBindings {
if binding.viewName == v.Name() {
return binding.handler(tabIndex)
}
}
}
}
}

// newCx and newCy are relative to the view port, i.e. to the visible area of the view
newCx := mx - v.x0 - 1
Expand All @@ -1368,6 +1357,23 @@ func (g *Gui) onKey(ev *GocuiEvent) error {
newCx = visibleLineWidth - v.ox
}
}

if ev.Key == MouseLeft && (ev.Mod&ModMotion) == 0 && !v.Editable && g.openHyperlink != nil {
if newY >= 0 && newY <= len(v.viewLines)-1 && newX >= 0 && newX <= len(v.viewLines[newY].line)-1 {
if link := v.viewLines[newY].line[newX].hyperlink; link != "" {
return g.openHyperlink(link, v.name)
}
}
}

if g.ShouldHandleMouseEvent != nil {
if !g.ShouldHandleMouseEvent(v, ev.Key) {
// Give clients a chance to reject clicks, for example clicks in inactive views
// when a modal panel is open.
break
}
}

if !IsMouseScrollKey(ev.Key) {
v.SetCursor(newCx, newCy)
if v.Editable {
Expand All @@ -1381,10 +1387,16 @@ func (g *Gui) onKey(ev *GocuiEvent) error {
}
}

if ev.Key == MouseLeft && (ev.Mod&ModMotion) == 0 && !v.Editable && g.openHyperlink != nil {
if newY >= 0 && newY <= len(v.viewLines)-1 && newX >= 0 && newX <= len(v.viewLines[newY].line)-1 {
if link := v.viewLines[newY].line[newX].hyperlink; link != "" {
return g.openHyperlink(link, v.name)
if v.Frame && my == v.y0 {
if len(v.Tabs) > 0 {
tabIndex := v.GetClickedTabIndex(mx - v.x0)

if tabIndex >= 0 {
for _, binding := range g.tabClickBindings {
if binding.viewName == v.Name() {
return binding.handler(tabIndex)
}
}
}
}
}
Expand Down