IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #14813 from neovim/marvim/api-doc-update/master

Browse Source 
docs: regenerate
This commit is contained in:
Thomas Vigouroux 2021-06-14 22:56:23 +02:00 committed by GitHub
commit 32c6ad02b7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
runtime/doc/api.txt
View File

@ -1325,33 +1325,37 @@ nvim_open_win({buffer}, {enter}, {config}) *nvim_open_win()*
and clearing the |EndOfBuffer| region in and clearing the |EndOfBuffer| region in
'winhighlight'. 'winhighlight'.
• `border`: style of (optional) window border. This can • `border`: Style of (optional) window border. This can
either be a string or an array. the string either be a string or an array. The string
values are: values are
• "none" No border. This is the default • "none": No border (default).
• "single" a single line box • "single": A single line box.
• "double" a double line box • "double": A double line box.
• "shadow" a drop shadow effect by blending • "rounded": Like "single", but with rounded
with the background. If it is an array it corners ("╭" etc.).
should be an array of eight items or any • "solid": Adds padding by a single whitespace
divisor of eight. The array will specifify cell.
the eight chars building up the border in a • "shadow": A drop shadow effect by blending
clockwise fashion starting with the top-left with the background.
corner. As, an example, the double box style • If it is an array, it should have a length
could be specified as: [ "╔", "═" ,"╗", "║", of eight or any divisor of eight. The array
"╝", "═", "╚", "║" ] if the number of chars will specifify the eight chars building up
are less than eight, they will be repeated. the border in a clockwise fashion starting
Thus an ASCII border could be specified as: with the top-left corner. As an example, the
[ "/", "-", "\\", "|" ] or all chars the double box style could be specified as [
same as: [ "x" ] An empty string can be used "╔", "═" ,"╗", "║", "╝", "═", "╚", "║" ]. If
to turn off a specific border, for instance: the number of chars are less than eight,
[ "", "", "", ">", "", "", "", "<" ] will they will be repeated. Thus an ASCII border
only make vertical borders but not could be specified as [ "/", "-", "\\", "|"
horizontal ones. By default `FloatBorder` ], or all chars the same as [ "x" ]. An
highlight is used which links to `VertSplit` empty string can be used to turn off a
when not defined. It could also be specified specific border, for instance, [ "", "", "",
by character: [ {"+", "MyCorner"}, {"x", ">", "", "", "", "<" ] will only make
"MyBorder"} ] vertical borders but not horizontal ones. By
default, `FloatBorder` highlight is used,
which links to `VertSplit` when not defined.
It could also be specified by character: [
{"+", "MyCorner"}, {"x", "MyBorder"} ].
• `noautocmd` : If true then no buffer-related • `noautocmd` : If true then no buffer-related
autocommand events such as |BufEnter|, autocommand events such as |BufEnter|,