Skip to content
Lazy Docs

Mini.icons

Mini.icons is a lightweight plugin that provides icon utilities for Neovim, making it easier to work with icons in your configuration and plugins.

What Problem Does It Solve?

Working with icons in Neovim can be:

  • Inconsistent across plugins
  • Hard to manage
  • Platform-dependent
  • Difficult to customize
  • Time-consuming to implement

How It Improves Productivity

  1. Unified Icon System:

    • Consistent icon usage
    • Easy icon management
    • Cross-platform support
    • Better integration

  2. Easy Integration:

    • Works with many plugins
    • Simple API
    • Flexible configuration
    • Extensible design

  3. Enhanced Features:

    • Icon customization
    • Fallback handling
    • Icon mapping
    • Better visibility

How to Use

Basic Usage

  • Use require('mini.icons').get_icon() to get icons
  • Use require('mini.icons').get_icons() to get multiple icons
  • Use require('mini.icons').setup() to configure
  • Use require('mini.icons').get_icon_map() to get icon map

Common Icons

  • File type icons
  • Directory icons
  • Language icons
  • Plugin icons
  • Status icons

Integration

  • Works with file explorers
  • Supports status lines
  • Compatible with LSP
  • Works with git plugins