diff options
Diffstat (limited to 'runtime/doc/api.txt')
| -rw-r--r-- | runtime/doc/api.txt | 49 |
1 files changed, 24 insertions, 25 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index eba4bc9562..ccfc117040 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -3492,40 +3492,39 @@ nvim_open_win({buffer}, {enter}, {config}) *nvim_open_win()* empty. The end-of-buffer region is hidden by setting `eob` flag of 'fillchars' to a space char, and clearing the |hl-EndOfBuffer| region in 'winhighlight'. - • border: Style of (optional) window border. This can either - be a string or an array. The string values are the same as - those described in 'winborder'. If it is an array, it - should have a length of eight or any divisor of eight. The - array will specify the eight chars building up the border - in a clockwise fashion starting with the top-left corner. - As an example, the double box style could be specified as: > - [ "╔", "═" ,"╗", "║", "╝", "═", "╚", "║" ]. + • border: (`string|string[]`) (defaults to 'winborder' + option) Window border. The string form accepts the same + values as the 'winborder' option. The array form must have + a length of eight or any divisor of eight, specifying the + chars that form the border in a clockwise fashion starting + from the top-left corner. For example, the double-box + style can be specified as: > + [ "╔", "═" ,"╗", "║", "╝", "═", "╚", "║" ]. < - If the number of chars are less than eight, they will be - repeated. Thus an ASCII border could be specified as > - [ "/", "-", \"\\\\\", "|" ], + If fewer than eight chars are given, they will be + repeated. An ASCII border could be specified as: > + [ "/", "-", \"\\\\\", "|" ], < - or all chars the same as > - [ "x" ]. + Or one char for all sides: > + [ "x" ]. < - An empty string can be used to turn off a specific border, - for instance, > - [ "", "", "", ">", "", "", "", "<" ] + Empty string can be used to hide a specific border. This + example will show only vertical borders, not horizontal: > + [ "", "", "", ">", "", "", "", "<" ] < - will only make vertical borders but not horizontal ones. - By default, `FloatBorder` highlight is used, which links - to `WinSeparator` when not defined. It could also be - specified by character: > - [ ["+", "MyCorner"], ["x", "MyBorder"] ]. + By default, |hl-FloatBorder| highlight is used, which + links to |hl-WinSeparator| when not defined. Each border + side can specify an optional highlight: > + [ ["+", "MyCorner"], ["x", "MyBorder"] ]. < - • title: Title (optional) in window border, string or list. + • title: (optional) Title in window border, string or list. List should consist of `[text, highlight]` tuples. If string, or a tuple lacks a highlight, the default highlight group is `FloatTitle`. • title_pos: Title position. Must be set with `title` option. Value can be one of "left", "center", or "right". Default is `"left"`. - • footer: Footer (optional) in window border, string or + • footer: (optional) Footer in window border, string or list. List should consist of `[text, highlight]` tuples. If string, or a tuple lacks a highlight, the default highlight group is `FloatFooter`. @@ -3773,8 +3772,8 @@ nvim_create_autocmd({event}, {opts}) *nvim_create_autocmd()* • callback (function|string) optional: Lua function (or Vimscript function name, if string) called when the event(s) is triggered. Lua callback can return a truthy - value (not `false` or `nil`) to delete the autocommand. - Receives one argument, a table with these keys: + value (not `false` or `nil`) to delete the autocommand, and + receives one argument, a table with these keys: *event-args* • id: (number) autocommand id • event: (string) name of the triggered event |