https://github.com/seagle0128/all-the-icons-ivy-rich
Better experience with icons for ivy
https://github.com/seagle0128/all-the-icons-ivy-rich
all-the-icons elisp emacs emacs-lisp ivy
Last synced: 28 days ago
JSON representation
Better experience with icons for ivy
- Host: GitHub
- URL: https://github.com/seagle0128/all-the-icons-ivy-rich
- Owner: seagle0128
- License: gpl-3.0
- Created: 2020-02-01T15:20:12.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-07T09:53:52.000Z (about 2 months ago)
- Last Synced: 2025-03-29T12:09:00.156Z (about 1 month ago)
- Topics: all-the-icons, elisp, emacs, emacs-lisp, ivy
- Language: Emacs Lisp
- Size: 198 KB
- Stars: 141
- Watchers: 5
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# all-the-icons-ivy-rich
[](https://github.com/seagle0128/all-the-icons-ivy-rich/actions)
[](https://github.com/seagle0128/all-the-icons-ivy-rich/releases)
[](License)
[](https://melpa.org/#/all-the-icons-ivy-rich)
[](https://stable.melpa.org/#/all-the-icons-ivy-rich)
## Table of Contents
- [Install](#install)
- [Manual](#manual)
- [Use-package](#use-package)
- [Customize](#customize)
- [Screenshots](#screenshots)
- [Donate](#donate)
Display icons for all buffers in [ivy](https://github.com/abo-abo/swiper).
This package is extracted from [Centaur
Emacs](https://github.com/seagle0128/.emacs.d) and leverages
[ivy-rich](https://github.com/Yevgnen/ivy-rich) and
[all-the-icons](https://github.com/domtronn/all-the-icons.el).
## Install
### Manual
From melpa, `M-x package-install RET all-the-icons-ivy-rich RET`.
```emacs-lisp
(all-the-icons-ivy-rich-mode 1)
(ivy-rich-mode 1)
```
### Use-package
```emacs-lisp
(use-package all-the-icons-ivy-rich
:ensure t
:init (all-the-icons-ivy-rich-mode 1))
(use-package ivy-rich
:ensure t
:init (ivy-rich-mode 1))
```
_NOTE_:
1. `all-the-icons-ivy-rich-mode` depends on
[ivy-rich](https://github.com/Yevgnen/ivy-rich) and respects `ivy-rich-mode`.
1. To display icons correctly, you should run `M-x all-the-icons-install-fonts`
to install the necessary fonts.
1. For better performance, enable `all-the-icons-ivy-rich-mode` before `ivy-rich-mode` .
1. Enable other packages like `counsel-projectile` before enabling `all-the-icons-ivy-rich-mode`.
Enjoy! :smile:
## Customize
```emacs-lisp
;; Whether display the icons
(setq all-the-icons-ivy-rich-icon t)
;; Whether display the colorful icons.
;; It respects `all-the-icons-color-icons'.
(setq all-the-icons-ivy-rich-color-icon t)
;; The icon size
(setq all-the-icons-ivy-rich-icon-size 1.0)
;; Whether support project root
(setq all-the-icons-ivy-rich-project t)
;; Maximum truncation width of annotation fields.
;; This value is adjusted depending on the `window-width'.
(setq all-the-icons-ivy-rich-field-width 80)
;; Definitions for ivy-rich transformers.
;; See `ivy-rich-display-transformers-list' for details."
all-the-icons-ivy-rich-display-transformers-list
;; Slow Rendering
;; If you experience a slow down in performance when rendering multiple icons simultaneously,
;; you can try setting the following variable
(setq inhibit-compacting-font-caches t)
```
In `counsel-describe-function`, `counsel-describe-variable`and `counsel-describe-symbol`, the symbol
classes will be displayed. The details are below.
| Function | Variable | Other |
| -------------------------- | ---------------------------------------------- | --------- |
| f function | u custom (U modified compared to global value) | a face |
| c cooamd | v variable | t cl-type |
| C interactive-only command | l local (L modified compared to default value) | |
| m macto | - obsolete | |
| M special form | | |
| g cl-generic | | |
| p pure | | |
| s side-effect-free | | |
| @ autoloaded | | |
| ! advised | | |
## Screenshots
And more...
## Donate
If you think the it's helpful for you, please consider paying a cup of coffee
for me. Thank you! :smile:
