Skip to content
Andrzej Grzeslak edited this page Oct 25, 2022 · 26 revisions

Options

In order to change these options, type let g:gruvbox_(option) = '(value)' in your .vimrc (with quotes). All settings must go before the command colorscheme gruvbox.

g:gruvbox_colors

An dictionary containing overrides for colors in the palette.

If a value in the dictionary is a string, it must be in hexidecimal rgb color format. It will overwrite the gui value of the palette color indicated by the key.

If the value is a number, it must be between 0-255. It will overwrite the terminal color.

If the value is a list, it must contain the gui color followed by the terminal color. It will replace both colors.

Possible palette colors:

  • dark0_hard
  • dark0
  • dark0_soft
  • dark1
  • dark2
  • dark3
  • dark4
  • dark4_256
  • gray_245
  • gray_244
  • light0_hard
  • light0
  • light0_soft
  • light1
  • light2
  • light3
  • light4
  • light4_256
  • bright_red
  • bright_green
  • bright_yellow
  • bright_blue
  • bright_purple
  • bright_aqua
  • bright_orange
  • neutral_red
  • neutral_green
  • neutral_yellow
  • neutral_blue
  • neutral_purple
  • neutral_aqua
  • neutral_orange
  • faded_red
  • faded_green
  • faded_yellow
  • faded_blue
  • faded_purple
  • faded_aqua
  • faded_orange
  • bg0
  • bg1
  • bg2
  • bg3
  • bg4
  • gray
  • fg0
  • fg1
  • fg2
  • fg3
  • fg4
  • fg4_256
  • red
  • green
  • yellow
  • blue
  • purple
  • aqua
  • orange

g:gruvbox_bold

Enables bold text.
default: 1

g:gruvbox_italic

Enables italic text.
default: gui 1, term 0

g:gruvbox_underline

Enables underlined text.
default: 1

g:gruvbox_undercurl

Enables undercurled text.
default: 1

g:gruvbox_termcolors

Uses 256-color palette (suitable to pair with gruvbox-palette shell script). If you're dissatisfied with that, set option value to 16 to fallback base colors to your terminal palette. Refer here and here for details.
default: 256

[DEPRECATED] g:gruvbox_contrast

Possible values are soft, medium and hard.
default: medium

g:gruvbox_contrast_dark

Changes dark mode contrast. Overrides g:gruvbox_contrast option. Possible values are soft, medium and hard.
default: medium

g:gruvbox_contrast_light

Changes light mode contrast. Overrides g:gruvbox_contrast option. Possible values are soft, medium and hard.
default: medium

g:gruvbox_hls_cursor

Changes cursor background while search is highlighted. Possible values are any of gruvbox palette.
default: orange

g:gruvbox_hls_highlight

Changes search highlight color foreground. Possible values are any of gruvbox palette.
default: yellow

g:gruvbox_number_column

Changes number column background color. Possible values are any of gruvbox palette.
default: none

g:gruvbox_sign_column

Changes sign column background color. Possible values are any of gruvbox palette.
default: bg1

g:gruvbox_color_column

Changes color column background color. Possible values are any of gruvbox palette.
default: bg1

g:gruvbox_vert_split

Changes vertical split background color. Possible values are any of gruvbox palette.
default: bg0

g:gruvbox_cursorline

Changes cursorline background color. Possible values are any of gruvbox palette.
default: bg1

g:gruvbox_italicize_comments

Enables italic for comments.
default: 1

g:gruvbox_italicize_strings

Enables italic for strings.
default: 0

g:gruvbox_invert_selection

Inverts selected text.
default: 1

g:gruvbox_invert_signs

Inverts GitGutter and Syntastic signs. Useful to rapidly focus on.
default: 0

g:gruvbox_invert_indent_guides

Inverts indent guides. Could be nice paired with set list so it would highlight only tab symbols instead of it's background.
default: 0

g:gruvbox_invert_tabline

Inverts tabline highlights, providing distinguishable tabline-fill.
default: 0

g:gruvbox_tabline_sel

Changes the color of the currently selected tab foreground color. Possible values are any of gruvbox palette.
default: green

g:gruvbox_improved_strings

Extrahighlighted strings
default: 0

g:gruvbox_improved_warnings

Extrahighlighted warnings
default: 0

g:gruvbox_guisp_fallback

Delegates guisp colorings to guifg or guibg. This is handy for terminal vim. Uses guifg or guibg for colors originally assigned to guisp. guisp concerns the colors of underlines and strikethroughs. Terminal vim cannot color underlines and strikethroughs, only gVim can. This option instructs vim to color guifg or guibg as a fallback.

default: 'NONE'

Possible Values: 'fg', 'bg'

Functions

gruvbox#invert_signs_toggle()

(...)

gruvbox#hls_show()

(...)

gruvbox#hls_show_cursor()

(...)

gruvbox#hls_hide()

(...)

gruvbox#hls_hide_cursor()

(...)

gruvbox#hls_toggle()

(...)