Nvim-material-icon

291 file types supported

🎉🎉 Big update! Fix icon, color and add more file types supported

An improved version of nvim-web-devicons

Image

Warning ⚠️⚠️

You need DaikyXendo/nvim-tree.lua instead of nvim-tree/nvim-tree.lua

Override to match with other plugins (thanks dailoi282702)

Some plugins are associated with nvim-web-devicons such as bufferline.nvim. You can use below way to override nvim-material-icon over nim-web-devicons

local web_devicons_ok, web_devicons = pcall(require, "nvim-web-devicons")
if not web_devicons_ok then
	return
end

local material_icon_ok, material_icon = pcall(require, "nvim-material-icon")
if not material_icon_ok then
	return
end

web_devicons.setup({
	override = material_icon.get_icons(),
})

Requirements

Nerd fonts

Installation

Plug 'DaikyXendo/nvim-material-icon'

or with packer.nvim

use 'DaikyXendo/nvim-material-icon'

Usage

Setup

This adds all the highlight groups for the devicons i.e. it calls vim.api.nvim_set_hl for all icons this might need to be re-called in a Colorscheme to re-apply cleared highlights if the color scheme changes

require'nvim-material-icon'.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 color
  color_icons = true;
  -- globally enable default icons (default to false)
  -- will get overriden by `get_icons` option
  default = true;
}

Get Icon

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

require'nvim-material-icon'.get_icon(filename, extension, options)

The optional options argument can used to change how the plugin works the keys include default = <boolean>. If the default key is set to true this function will return a default if there is no matching icon e.g.

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

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

require'nvim-material-icon'.has_loaded()

Get icon and color code

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

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

Get all icons

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

require'nvim-material-icon'.get_icons()

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

Set an icon

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

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

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

require("nvim-material-icon").set_default_icon('', '#6d8086')

Getting icons by filetype

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

require("nvim-material-icon").get_icon_by_filetype(filetype, opts)
require("nvim-material-icon").get_icon_colors_by_filetype(filetype, opts)
require("nvim-material-icon").get_icon_color_by_filetype(filetype, opts)
require("nvim-material-icon").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 use get_icon_name_by_filetype(filetype) to get the icon name associated with the filetype.

DaikyXendo / nvim-material-icon