xiyaowong/nvim-transparent

github github
color
star 195
stars
alert-circle 0
open issues
users 3
subscribers
git-branch 9
forks
CREATED

2021-04-09

UPDATED

3 months ago


nvim-transparent

Remove all background colors to make nvim transparent.

screenshot


Usage

Example config

require("transparent").setup({
  enable = true, -- boolean: enable transparent
  extra_groups = { -- table/string: additional groups that should be cleared
    -- In particular, when you set it to 'all', that means all available groups

    -- example of akinsho/nvim-bufferline.lua
    "BufferLineTabClose",
    "BufferlineBufferSelected",
    "BufferLineFill",
    "BufferLineBackground",
    "BufferLineSeparator",
    "BufferLineIndicatorSelected",
  },
  exclude = {}, -- table: groups you don't want to clear
})

You can also set the groups option to override the default groups.

The default groups: Normal NormalNC Comment Constant Special Identifier Statement PreProc Type Underlined Todo String Function Conditional Repeat Operator Structure LineNr NonText SignColumn CursorLineNr.


The global variable g:transparent_enabled has greater priority to option enable. Some plugins or themes support setting transparency, and you can use this variable as a flag. eg: vim.g.tokyonight_transparent = vim.g.transparent_enabled

Disable by default

let g:transparent_enabled = v:false

Commands

:TransparentEnable
:TransparentDisable
:TransparentToggle

Aknowledgement

vim-transparent