colorschemes.everforest.settings

The configuration options for everforest without the everforest_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal everforest_foo_bar=1
  • hello = "world" -> :setglobal everforest_hello="world"
  • some_toggle = true -> :setglobal everforest_some_toggle
  • other_toggle = false -> :setglobal noeverforest_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  background = "hard";
  colors_override = {
    bg0 = [
      "#202020"
      "234"
    ];
    bg2 = [
      "#282828"
      "235"
    ];
  };
  dim_inactive_windows = 1;
}

Declared by:

colorschemes.everforest.settings.enable_italic

To enable italic in this color scheme, set this option to 1.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

colorschemes.everforest.settings.background

The background contrast used in this color scheme.

Type: null or one of “hard”, “medium”, “soft” or raw lua code

Default: null

Plugin default: "medium"

Declared by:

colorschemes.everforest.settings.colors_override

Override color palette. The available keys can be found in the plugin’s source code

Type: null or (attribute set of ((list of string) or raw lua code))

Default: null

Plugin default: { }

Declared by:

colorschemes.everforest.settings.current_word

Some plugins can highlight the word under current cursor, you can use this option to control their behavior.

Default value: 'grey background' when not in transparent mode, 'bold' when in transparent mode.

Currently, the following plugins are supported:

Type: null or one of “grey background”, “bold”, “underline”, “italic” or raw lua code

Default: null

Plugin default: "grey background"

Declared by:

colorschemes.everforest.settings.cursor

Customize the cursor color, only works in GUI clients.

Type: null or one of “auto”, “red”, “orange”, “yellow”, “green”, “aqua”, “blue”, “purple” or raw lua code

Default: null

Plugin default: "auto"

Declared by:

colorschemes.everforest.settings.diagnostic_line_highlight

Some plugins support highlighting error/warning/info/hint lines, but this feature is disabled by default in this color scheme. To enable this feature, set this option to 1.

Currently, the following plugins are supported:

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

colorschemes.everforest.settings.diagnostic_text_highlight

Some plugins support highlighting error/warning/info/hint texts, by default these texts are only underlined, but you can use this option to also highlight the background of them.

Currently, the following plugins are supported:

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

colorschemes.everforest.settings.diagnostic_virtual_text

Some plugins can use the virtual text feature of Neovim to display error/warning/info/hint information. You can use this option to adjust the way these virtual texts are highlighted.

Currently, the following plugins are supported:

Type: null or one of “grey”, “colored”, “highlighted” or raw lua code

Default: null

Plugin default: "grey"

Declared by:

colorschemes.everforest.settings.dim_inactive_windows

Dim inactive windows. Only works in Neovim currently.

When this option is used in conjunction with |g:everforest_show_eob| set to 0, the end of the buffer will only be hidden inside the active window. Inside inactive windows, the end of buffer filler characters will be visible in dimmed symbols. This is due to the way Vim and Neovim handle |hl-EndOfBuffer|.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

colorschemes.everforest.settings.disable_italic_comment

By default, italic is enabled in Comment. To disable italic in Comment, set this option to 1

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

colorschemes.everforest.settings.disable_terminal_colors

Setting this option to 1 will disable terminal colors provided by this color scheme so you can remain terminal colors the same when using |:terminal| in vim and outside of vim.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

colorschemes.everforest.settings.float_style

Style used to make floating windows stand out from other windows. 'bright' makes the background of these windows lighter than |hl-Normal|, whereas 'dim' makes it darker.

Floating windows include for instance diagnostic pop-ups, scrollable documentation windows from completion engines, overlay windows from installers, etc.

Type: null or one of “bright”, “dim” or raw lua code

Default: null

Plugin default: "bright"

Declared by:

colorschemes.everforest.settings.inlay_hints_background

Inlay hints are special markers that are displayed inline with the code to provide you with additional information. You can use this option to customize the background color of inlay hints.

Currently, the following LSP clients are supported:

Type: null or one of “none”, “dimmed” or raw lua code

Default: null

Plugin default: "none"

Declared by:

colorschemes.everforest.settings.lightline_disable_bold

By default, bold is enabled in lightline color scheme. To disable bold in lightline color scheme, set this option to 1.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

colorschemes.everforest.settings.show_eob

Whether to show |hl-EndOfBuffer|.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 1

Declared by:

colorschemes.everforest.settings.sign_column_background

By default, the color of sign column background is the same as normal text background, but you can use a grey background by setting this option to 'grey'.

Type: null or one of “none”, “grey” or raw lua code

Default: null

Plugin default: "none"

Declared by:

colorschemes.everforest.settings.spell_foreground

By default, this color scheme won’t color the foreground of |spell|, instead colored under curls will be used. If you also want to color the foreground, set this option to 'colored'.

Type: null or one of “none”, “colored” or raw lua code

Default: null

Plugin default: "none"

Declared by:

colorschemes.everforest.settings.transparent_background

To use transparent background, set this option to 1.

If you want more ui components to be transparent (for example, status line background), set this option to 2.

Type: null or one of 0, 1, 2 or raw lua code

Default: null

Plugin default: 0

Declared by:

colorschemes.everforest.settings.ui_contrast

The contrast of line numbers, indent lines, etc.

Type: null or one of “low”, “high” or raw lua code

Default: null

Plugin default: "low"

Declared by: