{"id":13500923,"url":"https://github.com/DaikyXendo/nvim-material-icon","last_synced_at":"2025-03-29T07:32:07.443Z","repository":{"id":187369289,"uuid":"563874048","full_name":"DaikyXendo/nvim-material-icon","owner":"DaikyXendo","description":"Nvim material icon","archived":false,"fork":false,"pushed_at":"2025-03-27T09:45:12.000Z","size":206,"stargazers_count":118,"open_issues_count":4,"forks_count":10,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-27T10:35:33.435Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DaikyXendo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-09T14:17:58.000Z","updated_at":"2025-03-27T09:45:16.000Z","dependencies_parsed_at":"2024-06-04T03:01:21.267Z","dependency_job_id":"cb1aba8b-ee3a-4602-844d-e6014d410b2c","html_url":"https://github.com/DaikyXendo/nvim-material-icon","commit_stats":null,"previous_names":["daikyxendo/nvim-material-icon"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaikyXendo%2Fnvim-material-icon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaikyXendo%2Fnvim-material-icon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaikyXendo%2Fnvim-material-icon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaikyXendo%2Fnvim-material-icon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DaikyXendo","download_url":"https://codeload.github.com/DaikyXendo/nvim-material-icon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246155998,"owners_count":20732355,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T22:01:19.361Z","updated_at":"2025-03-29T07:32:07.435Z","avatar_url":"https://github.com/DaikyXendo.png","language":"Lua","readme":"# Nvim-material-icon\n\n## 1700+ file types supported (require Nerd Font \u003e= 3.2.0)\n\n## 🎉🎉 Big update! Now supports nvim-tree, bufferline, lualine...\n\nAn improved version of [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons)\n\n## Image\n\n\u003cimg src=\"https://github.com/DaikyXendo/nvim-material-icon/assets/46809008/2ed00644-a7b3-4c68-ac65-4490217ff7a3\" width=900 /\u003e\n\n## 🛑🛑 Warning 🛑🛑\n\n-   You must use the latest version of [Nerd Font (\u003e= v3.2.0)](https://www.nerdfonts.com/). This can break icons in your other plugins!!\n\n## Installation\n\nWith [packer.nvim](https://github.com/wbthomason/packer.nvim)\n\n```lua\nuse 'DaikyXendo/nvim-material-icon'\n```\n\nor with [lazy.nvim](https://github.com/folke/lazy.nvim)\n\n```lua\nrequire('lazy').setup({\n    'DaikyXendo/nvim-material-icon',\n})\n```\n\n## Usage\n\n### Setup\n\nThis adds all the highlight groups for the devicons\ni.e. it calls `vim.api.nvim_set_hl` for all icons\nthis might need to be re-called in a `Colorscheme` to re-apply cleared highlights\nif the color scheme changes\n\n```lua\nrequire'nvim-web-devicons'.setup {\n  -- your personnal icons can go here (to override)\n  -- you can specify color or cterm_color instead of specifying both of them\n  -- DevIcon will be appended to `name`\n  override = {\n    zsh = {\n      icon = \"\",\n      color = \"#428850\",\n      cterm_color = \"65\",\n      name = \"Zsh\"\n    }\n  };\n  -- globally enable different highlight colors per icon (default to true)\n  -- if set to false all icons will have the default icon's color\n  color_icons = true;\n  -- globally enable default icons (default to false)\n  -- will get overriden by `get_icons` option\n  default = true;\n}\n```\n\n### Get Icon\n\nGet the icon for a given file by passing in the `name`, the `extension` and an _optional_ options `table`.\nThe name is passed in to check for an exact match e.g. `.bashrc` if there is no exact name match the extension\nis used. Calls `.setup()` if it hasn't already ran.\n\n```lua\nrequire'nvim-web-devicons'.get_icon(filename, extension, options)\n```\n\nThe optional `options` argument can used to change how the plugin works the keys include\n`default = \u003cboolean\u003e`. If the default key is set to true this function will return a default\nif there is no matching icon\ne.g.\n\n```lua\nrequire'nvim-web-devicons'.get_icon(filename, extension, { default = true })\n```\n\nYou can check if the setup function was already called with:\n\n```lua\nrequire'nvim-web-devicons'.has_loaded()\n```\n\n### Get icon and color code\n\n`get_icon_color` differs from `get_icon` only in the second return value.\n`get_icon_cterm_color` returns cterm color instead of gui color\n`get_icon` returns icon and highlight name.\nIf you want to get color code, you can use this function.\n\n```lua\nlocal icon, color = require'nvim-web-devicons'.get_icon_color(\"init.lua\", \"lua\")\nassert(icon == \"\")\nassert(color == \"#51a0cf\")\n```\n\n### Get all icons\n\nIt is possible to get all of the registered icons with the `get_icons()` function:\n\n```lua\nrequire'nvim-web-devicons'.get_icons()\n```\n\nThis can be useful for debugging purposes or for creating custom highlights for each icon.\n\n### Set an icon\n\nYou can override individual icons with the `set_icon({...})` function:\n\n```lua\nrequire(\"nvim-web-devicons\").set_icon {\n  zsh = {\n    icon = \"\",\n    color = \"#428850\",\n    cterm_color = \"65\",\n    name = \"Zsh\"\n  }\n}\n```\n\nYou can override the default icon with the `set_default_icon(icon, color)` function:\n\n```lua\nrequire(\"nvim-web-devicons\").set_default_icon('', '#6d8086')\n```\n\n### Getting icons by filetype\n\nYou can get the icon and colors associated with a filetype using the `by_filetype` functions:\n\n```lua\nrequire(\"nvim-web-devicons\").get_icon_by_filetype(filetype, opts)\nrequire(\"nvim-web-devicons\").get_icon_colors_by_filetype(filetype, opts)\nrequire(\"nvim-web-devicons\").get_icon_color_by_filetype(filetype, opts)\nrequire(\"nvim-web-devicons\").get_icon_cterm_color_by_filetype(filetype, opts)\n```\n\nThese functions are the same as their counterparts without the `_by_filetype` suffix, but they take a filetype instead of a name/extension.\n\nYou can also use `get_icon_name_by_filetype(filetype)` to get the icon name associated with the filetype.\n","funding_links":[],"categories":["Lua"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDaikyXendo%2Fnvim-material-icon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDaikyXendo%2Fnvim-material-icon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDaikyXendo%2Fnvim-material-icon/lists"}