https://github.com/tranzystorekk/cmp-minikind.nvim

Icons for your nvim-cmp completions
https://github.com/tranzystorekk/cmp-minikind.nvim

lua neovim-plugin nvim-cmp

Last synced: 21 days ago
JSON representation

Icons for your nvim-cmp completions

• Host: GitHub
• URL: https://github.com/tranzystorekk/cmp-minikind.nvim
• Owner: tranzystorekk
• License: mit
• Created: 2024-07-04T19:48:08.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-06T18:48:49.000Z (4 months ago)
• Last Synced: 2024-07-06T19:37:14.380Z (4 months ago)
• Topics: lua, neovim-plugin, nvim-cmp
• Language: Lua
• Homepage:
• Size: 213 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cmp-minikind

![Demo screenshot](./assets/demo.png)

## About

Add icons to your `nvim-cmp` LSP completions!

Inspiration taken from [lspkind.nvim](https://github.com/onsails/lspkind.nvim)

## Dependencies

Use `:checkhealth cmp-minikind` to verify these are satisfied:

- [mini.icons](https://github.com/echasnovski/mini.icons)

## Installation

Make sure `mini.icons` is enabled in your config.

### Using lazy.nvim

```lua

{

  "hrsh7th/nvim-cmp",

  dependencies = {

    "tranzystorekk/cmp-minikind.nvim",

  },

  config = function()

    require("cmp"). setup {

      formatting = {

        format = require("cmp-minikind").cmp_format(),

      }

    }

  end

}

```

## Default config

```lua

{

  -- Ordered components to be output as the displayed LSP kind:

  --

  -- "text": kind name, e.g. "Method"

  -- "symbol": kind icon supplied by mini.icons, e.g. ""

  components = { "symbol", "text" },

  -- String to separate the components with

  separator = " ",

}

```