aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/api.txt
diff options
context:
space:
mode:
authorluukvbaal <luukvbaal@gmail.com>2025-01-14 14:02:46 +0100
committerGitHub <noreply@github.com>2025-01-14 05:02:46 -0800
commit25d8c3a5ad7e9c5668841e66540ebe34ceda73a7 (patch)
tree139f1495e3b947676e9f011c50dd6ad525347a01 /runtime/doc/api.txt
parente8ddb7a46938f8843abc1c321cfd83cee2ba0020 (diff)
downloadrneovim-25d8c3a5ad7e9c5668841e66540ebe34ceda73a7.tar.gz
rneovim-25d8c3a5ad7e9c5668841e66540ebe34ceda73a7.tar.bz2
rneovim-25d8c3a5ad7e9c5668841e66540ebe34ceda73a7.zip
feat(api): nvim_open_win() relative to tabline and laststatus #32006
Problem: Anchoring a floating window to the tabline and laststatus is cumbersome; requiring autocommands and looping over all windows/tabpages. Solution: Add new "tabline" and "laststatus" options to the `relative` field of nvim_open_win() to place a window relative to.
Diffstat (limited to 'runtime/doc/api.txt')
-rw-r--r--runtime/doc/api.txt8
1 files changed, 5 insertions, 3 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 572e5e4267..5a6361d45f 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -3150,11 +3150,13 @@ nvim_open_win({buffer}, {enter}, {config}) *nvim_open_win()*
• {config} Map defining the window configuration. Keys:
• relative: Sets the window layout to "floating", placed at
(row,col) coordinates relative to:
- • "editor" The global editor grid
+ • "cursor" Cursor position in current window.
+ • "editor" The global editor grid.
+ • "laststatus" 'laststatus' if present, or last row.
+ • "mouse" Mouse position.
+ • "tabline" Tabline if present, or first row.
• "win" Window given by the `win` field, or current
window.
- • "cursor" Cursor position in current window.
- • "mouse" Mouse position
• win: |window-ID| window to split, or relative window when
creating a float (relative="win").
• anchor: Decides which corner of the float to place at