aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorluukvbaal <luukvbaal@gmail.com>2024-11-17 00:32:36 +0100
committerGitHub <noreply@github.com>2024-11-16 15:32:36 -0800
commitf85bc41c800d7f5c0256f29aa347a53600a7c8d5 (patch)
tree1f3c0bd41f196856945b363d7de0f0aaa3b4d5dd /runtime
parent29ded889579a9d590e8ea885a9a402ff4bae87be (diff)
downloadrneovim-f85bc41c800d7f5c0256f29aa347a53600a7c8d5.tar.gz
rneovim-f85bc41c800d7f5c0256f29aa347a53600a7c8d5.tar.bz2
rneovim-f85bc41c800d7f5c0256f29aa347a53600a7c8d5.zip
feat(ui): don't show unfocusable windows in :tabs, 'tabline' #27984
Problem: Floating windows with focusable set to false can reasonably be expected to be UI elements but are listed in some outputs that should contain only regular windows. Solution: Hide unfocusable floating windows from the default tabline and :tabs.
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/api.txt2
-rw-r--r--runtime/doc/windows.txt3
-rw-r--r--runtime/lua/vim/_meta/api.lua2
3 files changed, 4 insertions, 3 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index c9b84f5238..50c35a0fc6 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -3196,7 +3196,7 @@ nvim_open_win({buffer}, {enter}, {config}) *nvim_open_win()*
• focusable: Enable focus by user actions (wincmds, mouse
events). Defaults to true. Non-focusable windows can be
entered by |nvim_set_current_win()|, or, when the `mouse`
- field is set to true, by mouse events.
+ field is set to true, by mouse events. See |focusable|.
• mouse: Specify how this window interacts with mouse
events. Defaults to `focusable` value.
• If false, mouse events pass through this window.
diff --git a/runtime/doc/windows.txt b/runtime/doc/windows.txt
index 5729dd0874..24aa7b1b11 100644
--- a/runtime/doc/windows.txt
+++ b/runtime/doc/windows.txt
@@ -69,7 +69,8 @@ If a window is focusable, it is part of the "navigation stack", that is,
editor commands such as :windo, |CTRL-W|, etc., will consider the window as
one that can be made the "current window". A non-focusable window will be
skipped by such commands (though it can be explicitly focused by
-|nvim_set_current_win()|).
+|nvim_set_current_win()|). Non-focusable windows are not listed by |:tabs|, and
+are not counted by the default 'tabline'.
Windows (especially floating windows) can have many other |api-win_config|
properties such as "hide" and "fixed" which also affect behavior.
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index c28af7bbff..30654efdea 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1768,7 +1768,7 @@ function vim.api.nvim_open_term(buffer, opts) end
--- - focusable: Enable focus by user actions (wincmds, mouse events).
--- Defaults to true. Non-focusable windows can be entered by
--- `nvim_set_current_win()`, or, when the `mouse` field is set to true,
---- by mouse events.
+--- by mouse events. See `focusable`.
--- - mouse: Specify how this window interacts with mouse events.
--- Defaults to `focusable` value.
--- - If false, mouse events pass through this window.