Skip to content

feat: add option that pauses autoscrolling while browsing term buf #670

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

Open
Run1e wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −1
Open

feat: add option that pauses autoscrolling while browsing term buf #670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6500760
feat: add option that pauses autoscrolling while browsing term buf
Run1e May 10, 2026
91564fb
fix: move conditional_auto_scroll loginc into Terminal::scroll_bottom…
Run1e May 15, 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
1 change: 1 addition & 0 deletions lua/toggleterm/config.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ local config = {
shell = vim.o.shell,
autochdir = false,
auto_scroll = true,
conditional_auto_scroll = false,
winbar = {
enabled = false,
name_formatter = function(term) return fmt("%d:%s", term.id, term:_display_name()) end,
Expand Down
11 changes: 10 additions & 1 deletion lua/toggleterm/terminal.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ local terminals = {}
--- @field hidden boolean whether or not to include this terminal in the terminals list
--- @field close_on_exit boolean? whether or not to close the terminal window when the process exits
--- @field auto_scroll boolean? whether or not to scroll down on terminal output
--- @field conditional_auto_scroll boolean? whether to pause autoscrolling while navigating terminal buffer
--- @field float_opts table<string, any>?
--- @field display_name string?
--- @field env table<string, string> environmental variables passed to jobstart()
Expand Down Expand Up @@ -210,6 +211,8 @@ function Terminal:new(term)
term.float_opts = vim.tbl_deep_extend("keep", term.float_opts or {}, conf.float_opts)
term.clear_env = vim.F.if_nil(term.clear_env, conf.clear_env)
term.auto_scroll = vim.F.if_nil(term.auto_scroll, conf.auto_scroll)
term.conditional_auto_scroll =
vim.F.if_nil(term.conditional_auto_scroll, conf.conditional_auto_scroll)
term.env = vim.F.if_nil(term.env, conf.env)
term.hidden = vim.F.if_nil(term.hidden, false)
term.on_create = vim.F.if_nil(term.on_create, conf.on_create)
Expand Down Expand Up @@ -310,7 +313,13 @@ end

function Terminal:scroll_bottom()
if not api.nvim_buf_is_loaded(self.bufnr) or not api.nvim_buf_is_valid(self.bufnr) then return end
if ui.term_has_open_win(self) then api.nvim_buf_call(self.bufnr, ui.scroll_to_bottom) end
if ui.term_has_open_win(self) then
if self.conditional_auto_scroll then
local cursor = vim.api.nvim_win_get_cursor(self.window)
if cursor[1] < vim.api.nvim_buf_line_count(self.bufnr) then return end
end
api.nvim_buf_call(self.bufnr, ui.scroll_to_bottom)
end
end

function Terminal:is_focused() return self.window == api.nvim_get_current_win() end
Expand Down