diff options
| author | Oliver Marriott <rktjmp@users.noreply.github.com> | 2022-05-16 07:06:06 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-15 14:06:06 -0700 |
| commit | 5e3b16836a333d48f8977fc201c5e666767d61f1 (patch) | |
| tree | 1acf43493e84ccf59113f51b944c73042a97d5e4 /runtime | |
| parent | 0a3d615b1ca17cda978b89d66acef39b90ee7c81 (diff) | |
| download | rneovim-5e3b16836a333d48f8977fc201c5e666767d61f1.tar.gz rneovim-5e3b16836a333d48f8977fc201c5e666767d61f1.tar.bz2 rneovim-5e3b16836a333d48f8977fc201c5e666767d61f1.zip | |
docs(api): nvim_set_hl attributes #18558
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 45 |
1 files changed, 37 insertions, 8 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index b5ec9114de..812208ca31 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -1570,18 +1570,46 @@ nvim_set_current_win({window}) *nvim_set_current_win()* nvim_set_hl({ns_id}, {name}, {*val}) *nvim_set_hl()* Sets a highlight group. - Note: Unlike the `:highlight` command which can update a - highlight group, this function completely replaces the - definition. For example: `nvim_set_hl(0, 'Visual', {})` will - clear the highlight group 'Visual'. + Note: + Unlike the `:highlight` command which can update a + highlight group, this function completely replaces the + definition. For example: `nvim_set_hl(0, 'Visual', {})` + will clear the highlight group 'Visual'. + + Note: + The fg and bg keys also accept the string values `"fg"` or + `"bg"` which act as aliases to the corresponding + foreground and background values of the Normal group. If + the Normal group has not been defined, using these values + results in an error. Parameters: ~ {ns_id} Namespace id for this highlight |nvim_create_namespace()|. Use 0 to set a highlight group globally |:highlight|. {name} Highlight group name, e.g. "ErrorMsg" - {val} Highlight definition map, like |synIDattr()|. In - addition, the following keys are recognized: + {val} Highlight definition map, accepts the following + keys: + • fg (or foreground): color name or "#RRGGBB", + see note. + • bg (or background): color name or "#RRGGBB", + see note. + • sp (or special): color name or "#RRGGBB" + • blend: integer between 0 and 100 + • bold: boolean + • standout: boolean + • underline: boolean + • underlineline: boolean + • undercurl: boolean + • underdot: boolean + • underdash: boolean + • strikethrough: boolean + • italic: boolean + • reverse: boolean + • nocombine: boolean + • link: name of another highlight group to link + to, see |:hi-link|. Additionally, the following + keys are recognized: • default: Don't override existing definition |:hi-default| • ctermfg: Sets foreground of cterm color @@ -1589,8 +1617,9 @@ nvim_set_hl({ns_id}, {name}, {*val}) *nvim_set_hl()* • ctermbg: Sets background of cterm color |highlight-ctermbg| • cterm: cterm attribute map, like - |highlight-args|. Note: Attributes default to - those set for `gui` if not set. + |highlight-args|. If not set, cterm attributes + will match those from the attribute map + documented above. nvim_set_keymap({mode}, {lhs}, {rhs}, {*opts}) *nvim_set_keymap()* Sets a global |mapping| for the given mode. |