Setting custom_highlights

[timrosu]

Neovim version

NVIM v0.10.0
Build type: Release
LuaJIT 2.1.1716656478

Minimal configuration

{
"tiagovla/tokyodark.nvim",
lazy = false,
opts = {
transparent_background = true, -- set background to transparent
gamma = 0.9, -- adjust the brightness of the theme
custom_highlights = {} or function(highlights, palette) return { CursorLine = { bg = p.bg0 } } end, -- extend highlights
terminal_colors = true, -- enable terminal colors
},
config = function(_, opts)
require("tokyodark").setup(opts) -- calling setup is optional
vim.cmd.colorscheme "tokyodark"
end,
}

Description

I tried making CursorLine darker to make it more visible on transparent background, but it doesn't seem to work. Am I doing something wrong?

[timrosu]

I saw in one issue that I can set color manually:

custom_highlights = {
  CursorLine = { bg = "#212234" },
  Visual = { bg = "#212234", },
} or function(highlights, palette)

But I still don't understand what is purpose of function(highlights, palette).

[tiagovla]

Sorry, I was a bit busy these last few weeks.

You can either pass a table of highlights or a function that returns a table of highlights.

If you want to modify the highlight's table (highlights.lua) or use the palette definitions (palette.lua), you can use them inside the function. Few examples:

custom_highlights = {
    Normal = { link = "Blue" }, --will be merged
}

custom_highlights = function(hl, p)
    return {
        Normal = { bg = p.blue }, --will be merged
    }
end,

custom_highlights = function(hl, p)
    hl["Normal"] = { bg = p.blue }, --modify in place
    return {}
end,