colorschemes.catppuccin.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  color_overrides = {
    mocha = {
      base = "#1e1e2f";
    };
  };
  disable_underline = true;
  flavour = "mocha";
  integrations = {
    cmp = true;
    gitsigns = true;
    mini = {
      enabled = true;
      indentscope_color = "";
    };
    notify = false;
    nvimtree = true;
    treesitter = true;
  };
  styles = {
    booleans = [
      "bold"
      "italic"
    ];
    conditionals = [
      "bold"
    ];
  };
  term_colors = true;
}

Declared by:

colorschemes.catppuccin.settings.compile_path

Set the compile cache directory.

Type: null or string or raw lua code

Default: null

Plugin default:

{
  __raw = "vim.fn.stdpath 'cache' .. '/catppuccin'";
}

Declared by:

colorschemes.catppuccin.settings.custom_highlights

Override specific highlight groups to use other groups or a hex color. You can provide either a lua function or directly an attrs.

Example:

  function(colors)
    return {
      Comment = { fg = colors.flamingo },
      ["@constant.builtin"] = { fg = colors.peach, style = {} },
      ["@comment"] = { fg = colors.surface2, style = { "italic" } },
    }
  end

Default: {}

Type: null or lua function string or attribute set of anything

Default: null

Declared by:

colorschemes.catppuccin.settings.default_integrations

Some integrations are enabled by default, you can control this behaviour with this option.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

colorschemes.catppuccin.settings.flavour

Theme flavour.

Type: null or one of “latte”, “mocha”, “frappe”, “macchiato”, “auto”

Default: null

Declared by:

colorschemes.catppuccin.settings.integrations

Catppuccin provides theme support for other plugins in the Neovim ecosystem and extended Neovim functionality through integrations.

To enable/disable an integration you just need to set it to true/false.

Example:

  {
    cmp = true;
    gitsigns = true;
    nvimtree = true;
    treesitter = true;
    notify = false;
    mini = {
      enabled = true;
      indentscope_color = "";
    };
  }

Default: see plugin source.

Type: null or (attribute set of anything)

Default: null

Declared by:

colorschemes.catppuccin.settings.no_bold

Force no bold.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

colorschemes.catppuccin.settings.no_italic

Force no italic.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

colorschemes.catppuccin.settings.no_underline

Force no underline.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

colorschemes.catppuccin.settings.show_end_of_buffer

Show the ‘~’ characters after the end of buffers.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

colorschemes.catppuccin.settings.term_colors

Configure the colors used when opening a :terminal in Neovim.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

colorschemes.catppuccin.settings.transparent_background

Enable Transparent background.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by: