Repository files navigation

Nerd fonts moved some symbols with version 3.0. Version 2.3 is meant for transition, supporting both version 2 and version 3 icons.

Nvim-web-devicons requires version 2.3 or above to work properly. If you are unable to update please use your plugin manager to pin version of nvim-web-dev icons tonerd-v2-compat tag.

Alua fork ofvim-devicons. This plugin provides the same iconsas well as colors for each icon.

Light and dark color variants are provided.

• neovim >=0.7.0
• A patched font

Plug'nvim-tree/nvim-web-devicons'

or withpacker.nvim

use 'nvim-tree/nvim-web-devicons'

Light or dark color variants of the icons depend on&background.

The variant is updated:

• onOptionSet event forbackground, or
• after explicitly callingrequire("nvim-web-devicons").refresh().

However, be advised that the plugin using nvim-web-devicons may have cached the icons.

This adds all the highlight groups for the deviconsi.e. it callsvim.api.nvim_set_hl for all iconsthis might need to be re-called in aColorscheme to re-apply cleared highlightsif the color scheme changes

require'nvim-web-devicons'.setup {-- your personnal icons can go here (to override)-- you can specify color or cterm_color instead of specifying both of them-- DevIcon will be appended to `name`override= {zsh= {icon="",color="#428850",cterm_color="65",name="Zsh"  } };-- globally enable different highlight colors per icon (default to true)-- if set to false all icons will have the default icon's colorcolor_icons=true;-- globally enable default icons (default to false)-- will get overriden by `get_icons` optiondefault=true;-- globally enable "strict" selection of icons - icon will be looked up in-- different tables, first by filename, and if not found by extension; this-- prevents cases when file doesn't have any extension but still gets some icon-- because its name happened to match some extension (default to false)strict=true;-- same as `override` but specifically for overrides by filename-- takes effect when `strict` is trueoverride_by_filename= {  [".gitignore"]= {icon="",color="#f1502f",name="Gitignore"  } };-- same as `override` but specifically for overrides by extension-- takes effect when `strict` is trueoverride_by_extension= {  ["log"]= {icon="",color="#81e043",name="Log"  } };}

Get the icon for a given file by passing in thename, theextension and anoptional optionstable.The name is passed in to check for an exact match e.g..bashrc if there is no exact name match the extensionis used. Calls.setup() if it hasn't already ran.

require'nvim-web-devicons'.get_icon(filename,extension,options)

The optionaloptions argument can used to change how the plugin works the keys includedefault = <boolean> andstrict = <boolean>. If the default key is set to true thisfunction will return a default if there is no matching icon. If the strict key is setto true this function will lookup icon specifically by filename, and if not found thenspecifically by extension, and fallback to default icon if default key is set to true.e.g.

require'nvim-web-devicons'.get_icon(filename,extension, {default=true })

You can check if the setup function was already called with:

require'nvim-web-devicons'.has_loaded()

get_icon_color differs fromget_icon only in the second return value.get_icon_cterm_color returns cterm color instead of gui colorget_icon returns icon and highlight name.If you want to get color code, you can use this function.

localicon,color=require'nvim-web-devicons'.get_icon_color("init.lua","lua")assert(icon=="")assert(color=="#51a0cf")

It is possible to get all of the registered icons with theget_icons() function:

require'nvim-web-devicons'.get_icons()

This can be useful for debugging purposes or for creating custom highlights for each icon.

You can override individual icons with theset_icon({...}) function:

require("nvim-web-devicons").set_icon {zsh= {icon="",color="#428850",cterm_color="65",name="Zsh"  }}

You can override the default icon with theset_default_icon(icon, color, cterm_color) function:

require("nvim-web-devicons").set_default_icon('','#6d8086',65)

You can get the icon and colors associated with a filetype using theby_filetype functions:

require("nvim-web-devicons").get_icon_by_filetype(filetype,opts)require("nvim-web-devicons").get_icon_colors_by_filetype(filetype,opts)require("nvim-web-devicons").get_icon_color_by_filetype(filetype,opts)require("nvim-web-devicons").get_icon_cterm_color_by_filetype(filetype,opts)

These functions are the same as their counterparts without the_by_filetype suffix, but they take a filetype instead of a name/extension.

You can also useget_icon_name_by_filetype(filetype) to get the icon name associated with the filetype.

PRs are always welcome! Please seeCONTRIBUTING