implement custom hl groups

mcchrish · Oct 12, 2021 · 2661052 · 2661052
1 parent 4c47437
commit 2661052
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -79,8 +79,8 @@ let g:nnn#layout = 'new' " or vnew, tabnew etc.
 " Or pass a dictionary with window size
 let g:nnn#layout = { 'left': '~20%' } " or right, up, down
 
-" Floating window.
-let g:nnn#layout = { 'window': { 'width': 0.9, 'height': 0.6, 'highlight': 'Debug' } }
+" Floating window. This is the default
+let g:nnn#layout = { 'window': { 'width': 0.9, 'height': 0.6, 'highlight': 'Comment' } }
 ```
 
 ### Action

diff --git a/autoload/nnn.vim b/autoload/nnn.vim
@@ -12,6 +12,18 @@ else
     let s:local_ses .= substitute(tempname(), '/', '_', 'g')
 endif
 
+" nnn highlight groups
+if !hlexists('NnnBorder')
+    if hlexists('FloatBorder')
+        highlight! link NnnBorder FloatBorder
+    else
+        highlight! link NnnBorder Comment
+    endif
+endif
+if !hlexists('NnnNormal')
+    highlight! link NnnNormal Normal
+endif
+
 function! s:statusline()
     setlocal statusline=%#StatusLineTerm#\ nnn\ %#StatusLineTermNC#
 endfunction
@@ -115,8 +127,7 @@ function! s:popup(opts, term_opts)
     let col += !has('nvim')
 
     let l:border = get(a:opts, 'border', 'rounded')
-    let l:default_hl = hlexists('FloatBorder') ? 'FloatBorder' : 'Comment'
-    let l:highlight = get(a:opts, 'highlight', l:default_hl)
+    let l:highlight = get(a:opts, 'highlight', 'NnnBorder')
 
     if has('nvim')
         let l:borderchars = l:border ==# 'none' ? 'none' : map(l:border ==# 'rounded'
@@ -133,8 +144,7 @@ function! s:popup(opts, term_opts)
                     \ 'relative': 'editor',
                     \ 'style': 'minimal'
                     \ })
-        call setwinvar(l:win, '&winhighlight', 'NormalFloat:Normal')
-        call setwinvar(l:win, '&colorcolumn', '')
+        call setwinvar(l:win, '&winhighlight', 'NormalFloat:NnnNormal')
         return { 'buf': s:create_term_buf(a:term_opts), 'winhandle': l:win }
     else
         let l:buf = s:create_term_buf(extend(a:term_opts, #{ curwin: 0, hidden: 1 }))
@@ -146,6 +156,7 @@ function! s:popup(opts, term_opts)
                     \ col: col,
                     \ minwidth: width,
                     \ minheight: height,
+                    \ highlight: 'NnnNormal',
                     \ border: l:border ==# 'none' ? [0, 0, 0, 0] : [],
                     \ borderhighlight: [l:highlight],
                     \ borderchars: l:borderchars,

diff --git a/doc/nnn.txt b/doc/nnn.txt
@@ -18,6 +18,7 @@ CONTENTS *nnn-help*
     Mappings .............................. |nnn-mappings|
     Configurations ........................ |nnn-config|
     Functions ............................. |nnn-func|
+    Highlights ............................ |nnn-hl|
   Miscellaneous ......................... |nnn-misc|
   Credits ............................... |nnn-credits|
 
@@ -237,6 +238,14 @@ nnn#pick([{dir}][,{opts}])                                         *nnn#pick()*
                   call nnn#pick('~/some-directory', { 'edit': 'vertical split' })
 <
 
+-----------------------------------------------------------------------------
+Highlights                                                             *nnn-hl*
+
+The following are the highlight groups that are used:
+
+NnnNormal: window hl group. Linked to |hl-Normal|.
+NnnBorder: floating window border. Linked to |hl-FloatBorder| or |hl-Comment|.
+
 =============================================================================
 Miscellaneous                                                        *nnn-misc*