neovim

commit 7900a8b7131f18c3991db64b06a0291c818f6784
parent cf68f0a51202342163825015602bdf78b783c777
Author: Andrey Mishchenko <mishchea@gmail.com>
Date:   Wed, 11 May 2022 19:49:19 -0400

docs(api): how to check if window is floating #18503


Diffstat:
M
runtime/doc/api.txt
 | 
8
++++++++

1 file changed, 8 insertions(+), 0 deletions(-)
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
@@ -426,6 +426,14 @@ Two ways to create a floating window:
 
 To close it use |nvim_win_close()| or a command such as |:close|.
 
+To check whether a window is floating, check whether the `relative` option in
+its config is non-empty: >
+
+    if vim.api.nvim_win_get_config(window_id).relative ~= '' then
+      -- window with this window_id is floating
+    end
+>
+
 Buffer text can be highlighted by typical mechanisms (syntax highlighting,
 |api-highlights|). The |hl-NormalFloat| group highlights normal text;
 'winhighlight' can be used as usual to override groups locally. Floats inherit