diff options
| author | bfredl <bjorn.linse@gmail.com> | 2023-08-26 19:41:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-26 19:41:52 +0200 |
| commit | a6d0535c15374599e0dd9ca891d9fbc7b5774403 (patch) | |
| tree | d0915f863f81409785b2f51ac91741b3e14258e9 /runtime/lua/vim/_meta/api.lua | |
| parent | afd0c648a89ff88c9bff1b24c37e139813ec13c9 (diff) | |
| parent | 986bf7e78d09286e198b696630254eb097ad0875 (diff) | |
| download | rneovim-a6d0535c15374599e0dd9ca891d9fbc7b5774403.tar.gz rneovim-a6d0535c15374599e0dd9ca891d9fbc7b5774403.tar.bz2 rneovim-a6d0535c15374599e0dd9ca891d9fbc7b5774403.zip | |
Merge pull request #24739 from echasnovski/win-footer
feature: add floating window footer text
Diffstat (limited to 'runtime/lua/vim/_meta/api.lua')
| -rw-r--r-- | runtime/lua/vim/_meta/api.lua | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index fdf5016b68..dd67fdb38b 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -1551,11 +1551,18 @@ function vim.api.nvim_open_term(buffer, opts) end --- 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 `FloatTitle`. ---- • title_pos: Title position must set with title option. ---- value can be of `left` `center` `right` default is left. +--- • title: Title (optional) in window border, string or list. +--- List should consist of `[text, highlight]` tuples. If +--- string, 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 +--- list. List should consist of `[text, highlight]` tuples. +--- If string, the default highlight group is `FloatFooter`. +--- • footer_pos: Footer position. Must be set with `footer` +--- option. Value can be one of "left", "center", or "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. |