Skip to content
master
Go to file
Code

README.md

img

Installation | Usage | Fonts | Wiki

Installation

You should be able to install this package in the standard way, add it to the load path and then calling

(require 'all-the-icons)
;; or
(use-package all-the-icons)

Installing Fonts

In order for the icons to work it is very important that you install the Resource Fonts included in this package, they are available in the fonts directory. You can also install the latest fonts for this package in the (guessed?) based on the OS by calling the following function;

M-x all-the-icons-install-fonts

Bear in mind, this will also run fc-cache -f -v on MacOS and Linux which can take some time to complete. For Windows, this function will prompt for a download directory for you to install them manually.

Usage

The simplest usage for this package is to use the following functions;

  • all-the-icons-icon-for-buffer
  • all-the-icons-icon-for-dir
  • all-the-icons-icon-for-file
  • all-the-icons-icon-for-mode
  • all-the-icons-icon-for-url

Which can be used to get a formatted icon which you can insert into buffers, e.g.

(insert (all-the-icons-icon-for-file "foo.js"))
    ;; Inserts a javascript icon
    ;; #("js-icon" 0 1 (display (raise -0.24) face (:family "alltheicon" :height 1.08 :foreground "#FFD446")))

Inserting Icons Directly

The above is fine if you want this package to automatically decide on the icon you want for files and things, however, to insert the icons directly you will want to use these icons functions;

  • all-the-icons-alltheicon
  • all-the-icons-faicon
  • all-the-icons-fileicon
  • all-the-icons-oction
  • all-the-icons-wicon

You can then call these functions with the icon you want to insert, e.g.

(all-the-icons-octicon "file-binary")  ;; GitHub Octicon for Binary File
(all-the-icons-faicon  "cogs")         ;; FontAwesome icon for cogs
(all-the-icons-wicon   "tornado")      ;; Weather Icon for tornado

A list of all the icon names for a font family can be found in the data directory, or by inspecting the alist variables.

The alist variables are all prefixed with

  • all-the-icons-data/

For example C-h v all-the-icons-data/ <TAB> will give a list of all the data alist you can describe (and the icon fonts they're associated with)

Inserting icons with properties

Each of the above icon functions can also be given different properties to slightly adjust the way they're formatted, these are

  • :height - The height of the icon
  • :v-adjust - Vertical adjust (positive is up, negative is down)
  • :face - The face to apply to the icon, defaults to \'default

So you would call, for example

(all-the-icons-wicon "tornado" :face 'all-the-icons-blue)

These properties can also be used on the all-the-icons-icon-for-file and all-the-icons-icon-for-mode functions as well, i.e.

(insert (all-the-icons-icon-for-file "foo.js" :height 2 :face 'all-the-icons-lred))
    ;; Inserts a RED Javascript icon with height 2
    ;; #("js-icon" 0 1 (display (raise -0.24) face (:family "alltheicon" :height 2.0 :foreground "red")))

Propertizing icons yourself

However, sometimes when propertizing these icons (for example if you were customising your mode line) you may sometimes have to know the font family to add in to override the current font family being used, e.g.

(propertize (all-the-icons-octicon "package")
            'face `(:family ,(all-the-icons-octicon-family) :height 1.2)
            'display '(raise -0.1))

Troubleshooting

If you see placeholders (AKA tofus) being rendered, or the wrong icons being displayed, the underlying cause generally falls into one of three categories:

  1. Font installation failed due to networking issues. Check your OS' and Emacs' networking (M-x customize-group RET gnutls/nsm/url/network RET) and security settings (i.e. proxy, firewall, antivirus software...)
  2. On *nix systems, make sure the font cache has been updated. all-the-icons-install-fonts should do this for you automatically, but sometimes it may fail due to misconfiguration.
  3. You've misconfigured your font settings in Emacs.

To check if you've misconfigured your Emacs font settings, you can try the following steps:

  1. Print out all of the icons in an icon set and their corresponding id/name.
;; Valid font families are 'material 'wicon 'octicon 'faicon 'fileicon and 'alltheicon

(all-the-icons-insert-icons-for 'alltheicon)   ;; Prints all the icons for `alltheicon' font set

(all-the-icons-insert-icons-for 'octicon 10)   ;; Prints all the icons for the `octicon' family
                                               ;; and makes the icons height 10

(all-the-icons-insert-icons-for 'faicon 1 0.5) ;; Prints all the icons for the `faicon' family
                                               ;; and also waits 0.5s between printing each one
  1. Now that you are certain which icon set is not displaying properly, check the fontset currently in effect.
  • Look up the hex code of the icon from the data/data-[font-family].el file. Write it down.
  • M-x describe-fontset RET RET
  • Now you are looking at the fontset for the current frame, search for the hex range for that icon. Usually it's #xE000, or #xF0 #xF2, but there are a few outside of these offsets.
  • If you don't see the font family in question in the list of fontspecs (i.e. [-*-file-icons-...]) below the range, or some other fontspecs in front of the one in question, you will have to add the families back to the fontset (scroll to the top to see which one is in effect), or arrange the fontspec order. For example:
;; Use 'prepend for the NS and Mac ports or Emacs will crash.
(set-fontset-font t 'unicode (font-spec :family "all-the-icons") nil 'append)
(set-fontset-font t 'unicode (font-spec :family "file-icons") nil 'append)
(set-fontset-font t 'unicode (font-spec :family "Material Icons") nil 'append)
(set-fontset-font t 'unicode (font-spec :family "github-octicons") nil 'append)
(set-fontset-font t 'unicode (font-spec :family "FontAwesome") nil 'append)
(set-fontset-font t 'unicode (font-spec :family "Weather Icons") nil 'append)

Resource Fonts

All of the fonts provided in this packages as resources come with either the SIL Open Font License (OFL) or an MIT License, below I will link to each of the fonts Sources and their Licenses.

Font Name Font License
file-icons.ttf Atom File Icons Plugin MIT LICENSE
fontawesome.ttf FontAwesome Icons SIL OFL LICENSE
ocitcons.ttf GitHub OctIcons SIL OFL LICENSE
weathericons.ttf Weather Icons SIL OFL LICENSE
material-design-icons.ttf Material Icons APACHE LICENSE v2.0
all-the-icons.ttf Custom Made Font MIT LICENSE

The fonts provided with this packages are locked down to a version for unicode character mapping values. In the future, these may be automatically generated.

I would like to thank all the authors for the creation and use of these fantastic fonts.

Wiki

Lastly, there is a Wiki Page which should give you some ideas of ways to use this library to spruce up other Emacs packages.

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)

Some people have found that this fixes the problem

▲ back to top

You can’t perform that action at this time.