README.md

circles.nvim

uniform icons for neovim.

Notices

• 2022-05-29: Due to nvim-tree major changes, circle.nvim is unable to override files & folder icons with vim.g.nvim_tree_show_icons. Please check the this for the workaround.

Features

• Uniform icon replacement for web-devicons
• Customize lsp diagnostic virtual-text icon

Requirements

• neovim>=0.8.0
• nvim-web-devicons
• Patched fonts (Nerd Fonts)

Installation

packer.nvim

use {
  "projekt0n/circles.nvim",
  requires = {"nvim-tree/nvim-web-devicons"}
}

vim-plug

Plug 'nvim-tree/nvim-web-devicons'
Plug 'projekt0n/circles.nvim'

Usage

require("circles").setup()

If using packer.nvim circles.nvim can be setup directly in the plugin spec:

use {
  "projekt0n/circles.nvim",
  requires = {"nvim-tree/nvim-web-devicons"},
  config = function()
    require("circles").setup()
  end
}

Configuration can be passed to the setup function. Here is an example with most of the default settings:

require("circles").setup({
  icons = { empty = "", filled = "", lsp_prefix = "" },
  -- override lsp_diagnostic virtual-text icon with `icons.lsp_prefix`
  lsp = true
})

Screenshots

• Terminal: Konsole
• Font: Fira Code
• Colorscheme: ful1e5/onedark.nvim and projekt0n/github-nvim-theme

Configure with nvim-tree

local circles = require('circles')

circles.setup({ icons = { empty = '', filled = '', lsp_prefix = '' } })

require('nvim-tree').setup({
  -- ...
  renderer = {
    -- ...
    icons = {
      glyphs = circles.get_nvimtree_glyphs(),
    },
  },
})

Neovim LSP diagnostic virtual-text icon

Custom Diagnostic Icon

require("circles").setup({
  icons = {
    -- ...
    lsp_prefix = ""
  },
  lsp = true
})

Disable Custom Diagnostic Icon

require("circles").setup({
  -- ...
  lsp = false
})