Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/projekt0n/circles.nvim
uniform icons for neovim
https://github.com/projekt0n/circles.nvim
lua neovim-icons
Last synced: 3 days ago
JSON representation
uniform icons for neovim
- Host: GitHub
- URL: https://github.com/projekt0n/circles.nvim
- Owner: projekt0n
- License: mit
- Created: 2021-08-18T09:38:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-08T13:02:24.000Z (over 1 year ago)
- Last Synced: 2024-08-02T13:34:13.444Z (3 months ago)
- Topics: lua, neovim-icons
- Language: Lua
- Homepage:
- Size: 33.2 KB
- Stars: 118
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# circles.nvim
uniform icons for neovim.
[](https://github.com/projekt0n/circles.nvim/actions/workflows/ci.yml)
## Notices
- **2022-05-29**: Due to [nvim-tree major changes](http://bit.ly/3vIpEOJ), circle.nvim is **unable to override**
files & folder icons with `vim.g.nvim_tree_show_icons`. Please check the [this](#configure-with-nvim-tree) for the workaround.
## Features
- Uniform icon replacement for [web-devicons](https://github.com/nvim-tree/nvim-web-devicons)
- Customize lsp diagnostic virtual-text icon
## Requirements
- neovim>=0.8.0
- [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons)
- Patched fonts ([Nerd Fonts](https://github.com/ryanoasis/nerd-fonts))
## Installation
### [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
"projekt0n/circles.nvim",
requires = {"nvim-tree/nvim-web-devicons"}
}
```
### [vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'nvim-tree/nvim-web-devicons'
Plug 'projekt0n/circles.nvim'
```
## Usage
```lua
require("circles").setup()
```
If using [packer.nvim](https://github.com/wbthomason/packer.nvim) circles.nvim can be setup directly in the plugin spec:
```lua
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:
```lua
require("circles").setup({
icons = { empty = "", filled = "", lsp_prefix = "" },
-- override lsp_diagnostic virtual-text icon with `icons.lsp_prefix`
lsp = true
})
```
## Screenshots
- Terminal: [Konsole](https://konsole.kde.org/)
- Font: [Fira Code](https://github.com/tonsky/FiraCode)
- Colorscheme: [ful1e5/onedark.nvim](https://github.com/ful1e5/onedark.nvim) and [projekt0n/github-nvim-theme](https://github.com/projekt0n/github-nvim-theme)
### Configure with nvim-tree
```lua
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
```lua
require("circles").setup({
icons = {
-- ...
lsp_prefix = ""
},
lsp = true
})
```
#### Disable Custom Diagnostic Icon
```lua
require("circles").setup({
-- ...
lsp = false
})
```
