colorschemes.kanagawa.settings

Options provided to the require('kanagawa').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  colors = {
    palette = {
      fujiWhite = "#FFFFFF";
      sumiInk0 = "#000000";
    };
    theme = {
      all = {
        ui = {
          bg_gutter = "none";
        };
      };
      dragon = {
        syn = {
          parameter = "yellow";
        };
      };
      wave = {
        ui = {
          float = {
            bg = "none";
          };
        };
      };
    };
  };
  commentStyle = {
    italic = true;
  };
  compile = false;
  dimInactive = false;
  functionStyle = { };
  overrides = "function(colors) return {} end";
  terminalColors = true;
  theme = "wave";
  transparent = false;
  undercurl = true;
}

Declared by:

colorschemes.kanagawa.settings.commentStyle

Highlight options for comments.

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

Default: null

Plugin default:

{
  italic = true;
}

Declared by:

colorschemes.kanagawa.settings.compile

Enable compiling the colorscheme.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

colorschemes.kanagawa.settings.dimInactive

Whether dim inactive window :h hl-NormalNC.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

colorschemes.kanagawa.settings.functionStyle

Highlight options for functions.

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

Default: null

Plugin default: { }

Declared by:

colorschemes.kanagawa.settings.keywordStyle

Highlight options for keywords.

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

Default: null

Plugin default:

{
  italic = true;
}

Declared by:

colorschemes.kanagawa.settings.overrides

The body of a function that add/modify hihlights. It takes as input a colors argument which is a table of this form:

  colors = {
    palette = {
      foo = "#RRGGBB",
      bar = "#RRGGBB"
    },
    theme = {
      foo = "#RRGGBB",
      bar = "#RRGGBB"
    }
  }

It should return a table of highlights.

  function(colors)
    CONTENT_OF_OVERRIDE_OPTION
  end

Type: null or lua function string

Default: null

Plugin default:

''
  function(colors)
    return {}
  end
''

Declared by:

colorschemes.kanagawa.settings.statementStyle

Highlight options for statements.

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

Default: null

Plugin default:

{
  bold = true;
}

Declared by:

colorschemes.kanagawa.settings.terminalColors

If true, defines vim.g.terminal_color_{0,17}.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

colorschemes.kanagawa.settings.theme

The theme to load when background is not set.

Type: null or string or raw lua code

Default: null

Plugin default: "wave"

Declared by:

colorschemes.kanagawa.settings.transparent

Whether to set a background color.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

colorschemes.kanagawa.settings.typeStyle

Highlight options for types.

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

Default: null

Plugin default: { }

Declared by:

colorschemes.kanagawa.settings.undercurl

Enable undercurls.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: