aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorGregory Anders <8965202+gpanders@users.noreply.github.com>2021-11-29 15:37:55 -0700
committerGitHub <noreply@github.com>2021-11-29 15:37:55 -0700
commitfff8827908494a9c4bd5de10c409189929b3db56 (patch)
tree2eb6d3da035460f9d6254f5d89dadbd9a23ebad9 /runtime/doc
parentb16b7021efe905a0e69731ffa13e6d187fdddb8d (diff)
downloadrneovim-fff8827908494a9c4bd5de10c409189929b3db56.tar.gz
rneovim-fff8827908494a9c4bd5de10c409189929b3db56.tar.bz2
rneovim-fff8827908494a9c4bd5de10c409189929b3db56.zip
feat(lsp): add 'focus' option to open_floating_preview (#16465)
When the 'focusable' and 'focus_id' parameters are set, `open_floating_preview` assumes that it should always move focus to an existing floating window with the same 'focus_id'. However, there are cases where we want to make a floating window focusable, but do not want to focus it upon calling `open_floating_preview`. To distinguish these cases, add a boolean parameter 'focus' that, when false, prevents moving focus.
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/lsp.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
index 6482309b8a..2be0fc0569 100644
--- a/runtime/doc/lsp.txt
+++ b/runtime/doc/lsp.txt
@@ -1631,6 +1631,10 @@ open_floating_preview({contents}, {syntax}, {opts})
closes the floating window
• focusable: (boolean, default true) Make
float focusable
+ • focus: (boolean, default true) If `true` ,
+ and if {focusable} is also `true` , focus an
+ existing floating window with the same
+ {focus_id}
Return: ~
bufnr,winnr buffer and window number of the newly created