diff options
| author | Evgeni Chasnovski <evgeni.chasnovski@gmail.com> | 2023-08-25 10:53:39 +0300 |
|---|---|---|
| committer | Evgeni Chasnovski <evgeni.chasnovski@gmail.com> | 2023-08-26 19:37:43 +0300 |
| commit | 986bf7e78d09286e198b696630254eb097ad0875 (patch) | |
| tree | d0915f863f81409785b2f51ac91741b3e14258e9 /runtime | |
| parent | 35570e4a11bef061777d741929f74fa66ba3f45a (diff) | |
| download | rneovim-986bf7e78d09286e198b696630254eb097ad0875.tar.gz rneovim-986bf7e78d09286e198b696630254eb097ad0875.tar.bz2 rneovim-986bf7e78d09286e198b696630254eb097ad0875.zip | |
feat(highlight): add `FloatFooter` highlight group
Problem: No clear separation of floating title and footer highlighting.
Solution: Add new `FloatFooter` highlight group.
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 3 | ||||
| -rw-r--r-- | runtime/doc/news.txt | 2 | ||||
| -rw-r--r-- | runtime/doc/syntax.txt | 2 | ||||
| -rw-r--r-- | runtime/doc/vim_diff.txt | 1 | ||||
| -rw-r--r-- | runtime/lua/vim/_meta/api.lua | 2 |
5 files changed, 7 insertions, 3 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 53d4282ec5..e68aafe051 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -479,6 +479,7 @@ to disable various visual features such as the 'number' column. Other highlight groups specific to floating windows: - |hl-FloatBorder| for window's border - |hl-FloatTitle| for window's title +- |hl-FloatFooter| for window's footer Currently, floating windows don't support some widgets like scrollbar. @@ -3146,7 +3147,7 @@ nvim_open_win({buffer}, {enter}, {*config}) *nvim_open_win()* 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 `FloatTitle`. + 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"`. diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index c28ccb191e..4f9f362b1e 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -156,7 +156,7 @@ The following new APIs and features were added. support fully MessagePack-RPC compliant clients. • Floating windows can now show footer with new `footer` and `footer_pos` - config fields. + config fields. Uses |hl-FloatFooter| by default. ============================================================================== CHANGED FEATURES *news-changed* diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt index 59f8235ad2..6c0c542737 100644 --- a/runtime/doc/syntax.txt +++ b/runtime/doc/syntax.txt @@ -5273,6 +5273,8 @@ NormalFloat Normal text in floating windows. FloatBorder Border of floating windows. *hl-FloatTitle* FloatTitle Title of floating windows. + *hl-FloatFooter* +FloatFooter Footer of floating windows. *hl-NormalNC* NormalNC Normal text in non-current windows. *hl-Pmenu* diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt index 29a7c50585..ab5e795c16 100644 --- a/runtime/doc/vim_diff.txt +++ b/runtime/doc/vim_diff.txt @@ -258,6 +258,7 @@ Highlight groups: |hl-NormalFloat| highlights floating window |hl-FloatBorder| highlights border of a floating window |hl-FloatTitle| highlights title of a floating window + |hl-FloatFooter| highlights footer of a floating window |hl-NormalNC| highlights non-current windows |hl-MsgArea| highlights messages/cmdline area |hl-MsgSeparator| highlights separator for scrolled messages diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index 7704a60cf8..dd67fdb38b 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -1559,7 +1559,7 @@ function vim.api.nvim_open_term(buffer, opts) end --- 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 `FloatTitle`. +--- 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"`. |