aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorRaphael <glephunter@gmail.com>2022-11-06 18:59:43 +0800
committerGitHub <noreply@github.com>2022-11-06 11:59:43 +0100
commit1af4bd04f9ad157edbfea30642250e854c5cb5d2 (patch)
tree96d28408eec2ad387965065f771427179c2b7f8c /runtime
parenta79d28e4d7939c13f38cf4ce63ff240011bca96d (diff)
downloadrneovim-1af4bd04f9ad157edbfea30642250e854c5cb5d2.tar.gz
rneovim-1af4bd04f9ad157edbfea30642250e854c5cb5d2.tar.bz2
rneovim-1af4bd04f9ad157edbfea30642250e854c5cb5d2.zip
feat(ui): add support to display a title in the border of a float (#20184)
add "title" and "title_pos" keys to win config dict.
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/api.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 8928650a39..e2a5291f7f 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -3068,6 +3068,11 @@ nvim_open_win({buffer}, {enter}, {*config}) *nvim_open_win()*
specified by character: [ {"+", "MyCorner"}, {"x",
"MyBorder"} ].
+ • title: Title (optional) in window border, String or list.
+ List is [text, highlight] tuples. if is string the default
+ highlight group is `FloatBorderTitle`.
+ • title_pos: Title position must set with title option.
+ value can be of `left` `center` `right` default is left.
• noautocmd: If true then no buffer-related autocommand
events such as |BufEnter|, |BufLeave| or |BufWinEnter| may
fire from calling this function.