cxwx / nvim-highlight-colors

Highlight colors for neovim

nvim-highlight-colors

Highlight colors within Neovim

Features

• Realtime color highlighting
• Supports hex, rgb, hsl, CSS variables, and Tailwind CSS
• LSP support! For any LSP that supports textDocument/documentColor like tailwindcss
• Multiple rendering modes: background, foreground, and virtual text

Usage

Install via your preferred package manager:

'brenoprata10/nvim-highlight-colors'

Initialize the plugin:

-- Ensure termguicolors is enabled if not already
vim.opt.termguicolors = true

require('nvim-highlight-colors').setup({})

Options

require("nvim-highlight-colors").setup {
	---Render style
	---@usage 'background'|'foreground'|'virtual'
	render = 'background',

	---Set virtual symbol (requires render to be set to 'virtual')
	virtual_symbol = '■',

	---Highlight named colors, e.g. 'green'
	enable_named_colors = true,

	---Highlight tailwind colors, e.g. 'bg-blue-500'
	enable_tailwind = false,

	---Set custom colors
	---Label must be properly escaped with '%' to adhere to `string.gmatch`
	--- :help string.gmatch
	custom_colors = {
		{ label = '%-%-theme%-primary%-color', color = '#0f1219' },
		{ label = '%-%-theme%-secondary%-color', color = '#5a5d64' },
	}
}

Render modes

Examples shown use enable_tailwind = true

Background

Foreground

Virtual text

Commands

Command	Description
:HighlightColors On	Turn highlights on
:HighlightColors Off	Turn highlights off
:HighlightColors Toggle	Toggle highlights

Commands are also available in lua:

require("nvim-highlight-colors").turnOn()
require("nvim-highlight-colors").turnOff()
require("nvim-highlight-colors").toggle()