Giter Club home page Giter Club logo

doom-modeline's Introduction

doom-modeline

Build Status Release Tag License MELPA MELPA Stable

Table of Contents

A fancy and fast mode-line inspired by minimalism design.

It's integrated into Centaur Emacs, Doom Emacs and Spacemacs.

Feature

The doom-modeline was designed for minimalism, and offers:

  • A match count panel (for anzu, iedit, multiple-cursors, symbol-overlay, and evil-search, etc.)
  • An indicator for recording a macro
  • Current environment version (e.g. python, ruby, go, etc.) in the major-mode
  • A customizable mode-line height (see doom-modeline-height)
  • A minor modes segment which is compatible with minions
  • An error/warning count segment for flymake/flycheck
  • A workspace number/name segment for eyebrowse or tab-bar-mode
  • A perspective name segment for persp-mode
  • A window number segment for ace-window, winum and window-numbering
  • An indicator for modal editing state, including evil, overwrite, god, ryo and xah-fly-keys, etc.
  • An indicator for battery status
  • An indicator for current input method
  • An indicator for debug state
  • An indicator for remote host
  • An indicator for LSP state with lsp-mode or eglot
  • An indicator for GitHub notifications
  • An indicator for unread emails with mu4e-alert and gnus
  • An indicator for IRC notifications with circe, rcirc or erc
  • An indicator for buffer position which is compatible with nyan-mode or poke-line
  • An indicator for party parrot
  • An indicator for PDF page number with pdf-tools
  • An indicator for markdown/org preview with grip
  • Truncated file name, file icon, buffer state and project name in buffer information segment, which is compatible with project, projectile and find-file-in-project.
  • New mode-line for Info-mode buffers
  • New package mode-line for paradox
  • New mode-line for helm buffers
  • New mode-line for git-timemachine buffers

Screenshots

modeline

search_replace

evil_search

macro

no_icons

color_icon_cpp

color_icon_java

color_icon_elisp

evil_normal_state_icon

evil_insert_state_icon

evil_normal_state

evil_insert_state

lsp_version

perspective

notifications

minions

debug

nyan_parrot

irc

battery

package

info

helm

Install

Manual

From melpa, M-x package-install RET doom-modeline RET.

In init.el,

(require 'doom-modeline)
(doom-modeline-mode 1)

or

(add-hook 'after-init-hook #'doom-modeline-mode)

Use-package

(use-package doom-modeline
  :ensure t
  :init (doom-modeline-mode 1))

or

(use-package doom-modeline
  :ensure t
  :hook (after-init . doom-modeline-mode))

This package is able to display icons if all-the-icons package and required fonts are installed. Run M-x all-the-icons-install-fonts to install the necessary fonts. Please refer to the installation guide.

Add this to init.el if you want to use icons,

;; Install via `M-x package-install RET all-the-icons RET`
(require 'all-the-icons)

or

(use-package all-the-icons
  :ensure t)

Strongly recommend to use doom-themes at the same time.

Customize

Run M-x customize-group RET doom-modeline RET or set the variables.

;; If non-nil, cause imenu to see `doom-modeline' declarations.
;; This is done by adjusting `lisp-imenu-generic-expression' to
;; include support for finding `doom-modeline-def-*' forms.
;; Must be set before loading doom-modeline.
(setq doom-modeline-support-imenu t)

;; How tall the mode-line should be. It's only respected in GUI.
;; If the actual char height is larger, it respects the actual height.
(setq doom-modeline-height 25)

;; How wide the mode-line bar should be. It's only respected in GUI.
(setq doom-modeline-bar-width 4)

;; Whether to use hud instead of default bar. It's only respected in GUI.
(setq doom-modeline-hud nil)

;; The limit of the window width.
;; If `window-width' is smaller than the limit, some information won't be
;; displayed. It can be an integer or a float number. `nil' means no limit."
(setq doom-modeline-window-width-limit 0.25)

;; How to detect the project root.
;; nil means to use `default-directory'.
;; The project management packages have some issues on detecting project root.
;; e.g. `projectile' doesn't handle symlink folders well, while `project' is unable
;; to hanle sub-projects.
;; You can specify one if you encounter the issue.
(setq doom-modeline-project-detection 'auto)

;; Determines the style used by `doom-modeline-buffer-file-name'.
;;
;; Given ~/Projects/FOSS/emacs/lisp/comint.el
;;   auto => emacs/lisp/comint.el (in a project) or comint.el
;;   truncate-upto-project => ~/P/F/emacs/lisp/comint.el
;;   truncate-from-project => ~/Projects/FOSS/emacs/l/comint.el
;;   truncate-with-project => emacs/l/comint.el
;;   truncate-except-project => ~/P/F/emacs/l/comint.el
;;   truncate-upto-root => ~/P/F/e/lisp/comint.el
;;   truncate-all => ~/P/F/e/l/comint.el
;;   truncate-nil => ~/Projects/FOSS/emacs/lisp/comint.el
;;   relative-from-project => emacs/lisp/comint.el
;;   relative-to-project => lisp/comint.el
;;   file-name => comint.el
;;   buffer-name => comint.el<2> (uniquify buffer name)
;;
;; If you are experiencing the laggy issue, especially while editing remote files
;; with tramp, please try `file-name' style.
;; Please refer to https://github.com/bbatsov/projectile/issues/657.
(setq doom-modeline-buffer-file-name-style 'auto)

;; Whether display icons in the mode-line.
;; While using the server mode in GUI, should set the value explicitly.
(setq doom-modeline-icon t)

;; Whether display the icon for `major-mode'. It respects `doom-modeline-icon'.
(setq doom-modeline-major-mode-icon t)

;; Whether display the colorful icon for `major-mode'.
;; It respects `all-the-icons-color-icons'.
(setq doom-modeline-major-mode-color-icon t)

;; Whether display the icon for the buffer state. It respects `doom-modeline-icon'.
(setq doom-modeline-buffer-state-icon t)

;; Whether display the modification icon for the buffer.
;; It respects `doom-modeline-icon' and `doom-modeline-buffer-state-icon'.
(setq doom-modeline-buffer-modification-icon t)

;; Whether to use unicode as a fallback (instead of ASCII) when not using icons.
(setq doom-modeline-unicode-fallback nil)

;; Whether display the buffer name.
(setq doom-modeline-buffer-name t)

;; Whether display the minor modes in the mode-line.
(setq doom-modeline-minor-modes nil)

;; If non-nil, a word count will be added to the selection-info modeline segment.
(setq doom-modeline-enable-word-count nil)

;; Major modes in which to display word count continuously.
;; Also applies to any derived modes. Respects `doom-modeline-enable-word-count'.
;; If it brings the sluggish issue, disable `doom-modeline-enable-word-count' or
;; remove the modes from `doom-modeline-continuous-word-count-modes'.
(setq doom-modeline-continuous-word-count-modes '(markdown-mode gfm-mode org-mode))

;; Whether display the buffer encoding.
(setq doom-modeline-buffer-encoding t)

;; Whether display the indentation information.
(setq doom-modeline-indent-info nil)

;; If non-nil, only display one number for checker information if applicable.
(setq doom-modeline-checker-simple-format t)

;; The maximum number displayed for notifications.
(setq doom-modeline-number-limit 99)

;; The maximum displayed length of the branch name of version control.
(setq doom-modeline-vcs-max-length 12)

;; Whether display the workspace name. Non-nil to display in the mode-line.
(setq doom-modeline-workspace-name t)

;; Whether display the perspective name. Non-nil to display in the mode-line.
(setq doom-modeline-persp-name t)

;; If non nil the default perspective name is displayed in the mode-line.
(setq doom-modeline-display-default-persp-name nil)

;; If non nil the perspective name is displayed alongside a folder icon.
(setq doom-modeline-persp-icon t)

;; Whether display the `lsp' state. Non-nil to display in the mode-line.
(setq doom-modeline-lsp t)

;; Whether display the GitHub notifications. It requires `ghub' package.
(setq doom-modeline-github nil)

;; The interval of checking GitHub.
(setq doom-modeline-github-interval (* 30 60))

;; Whether display the modal state icon.
;; Including `evil', `overwrite', `god', `ryo' and `xah-fly-keys', etc.
(setq doom-modeline-modal-icon t)

;; Whether display the mu4e notifications. It requires `mu4e-alert' package.
(setq doom-modeline-mu4e nil)
;; also enable the start of mu4e-alert
(mu4e-alert-enable-mode-line-display)

;; Whether display the gnus notifications.
(setq doom-modeline-gnus t)

;; Whether gnus should automatically be updated and how often (set to 0 or smaller than 0 to disable)
(setq doom-modeline-gnus-timer 2)

;; Wheter groups should be excludede when gnus automatically being updated.
(setq doom-modeline-gnus-excluded-groups '("dummy.group"))

;; Whether display the IRC notifications. It requires `circe' or `erc' package.
(setq doom-modeline-irc t)

;; Function to stylize the irc buffer names.
(setq doom-modeline-irc-stylize 'identity)

;; Whether display the environment version.
(setq doom-modeline-env-version t)
;; Or for individual languages
(setq doom-modeline-env-enable-python t)
(setq doom-modeline-env-enable-ruby t)
(setq doom-modeline-env-enable-perl t)
(setq doom-modeline-env-enable-go t)
(setq doom-modeline-env-enable-elixir t)
(setq doom-modeline-env-enable-rust t)

;; Change the executables to use for the language version string
(setq doom-modeline-env-python-executable "python") ; or `python-shell-interpreter'
(setq doom-modeline-env-ruby-executable "ruby")
(setq doom-modeline-env-perl-executable "perl")
(setq doom-modeline-env-go-executable "go")
(setq doom-modeline-env-elixir-executable "iex")
(setq doom-modeline-env-rust-executable "rustc")

;; What to display as the version while a new one is being loaded
(setq doom-modeline-env-load-string "...")

;; Hooks that run before/after the modeline version string is updated
(setq doom-modeline-before-update-env-hook nil)
(setq doom-modeline-after-update-env-hook nil)

FAQ

  1. How to display icons correctly?

    all-the-icons are necessary. Then run M-x all-the-icons-install-fonts to install the resource fonts. On Windows, the fonts should be installed manually. all-the-icons only support GUI. If you don't like color icons, (setq all-the-icons-color-icons nil) to disable it. Please refer to all-the-icons.el for details.

    If the icons are not displayed correctly although all-the-icons fonts are installed correctly, please install the non-free font Symbola. This issue usually occurs on Windows.

    If you are using cnfonts, it will conflict with all-the-icons. The workaround is here.

  2. I am experiencing the laggy issue, how to resolve it?

    Add this configuration into your init file:

    ;; Don’t compact font caches during GC.
(setq inhibit-compacting-font-caches t)

  3. A ridiculous path is displayed on the mode-line while visiting a symbolink.

    It's the default behaviors of Vanilla Emacs. If you want to display the real names, please put this into your init file.

    (setq find-file-visit-truename t)

    If the file is controlled by vc, refer to the documentation of vc-follow-symlinks.

  4. Why doesn't change of branch reflect in modeline?

    Actually it's related to magit and vc-mode.

  5. Can I add my mode-line segments myself? How to do that? How can I define my own mode-line?

    There are two methods.

    • If the information is simple, just add to mode-line-misc-info or global-mode-string.

    • Use doom-modeline-def-modeline to define your own mode-line and set it as default.

      For example:

      ;; Define your custom doom-modeline
(doom-modeline-def-modeline 'my-simple-line
  '(bar matches buffer-info remote-host buffer-position parrot selection-info)
  '(misc-info minor-modes input-method buffer-encoding major-mode process vcs checker))

;; Add to `doom-modeline-mode-hook` or other hooks
(defun setup-custom-doom-modeline ()
   (doom-modeline-set-modeline 'my-simple-line 'default))
(add-hook 'doom-modeline-mode-hook 'setup-custom-doom-modeline)

  6. How to specify font family in modeline?

    For example:

    (setq doom-modeline-height 1)
(set-face-attribute 'doom-modeline nil :family "Noto Sans" :height 100)
(set-face-attribute 'doom-modeline-inactive nil :family "Noto Sans" :height 100)

    or

    (custom-set-faces
  '(doom-modeline ((t (:family "Noto Sans" :height 0.9))))
  '(doom-modeline-inactive ((t (:family "Noto Sans" :height 0.9)))))

    Please refer to #189 and #301.

  7. How to disable symbolic links expanding in mode-line?

    If you encounter the issue like this

    Screenshot

    please try this setting

    ;; built-in `project' on 26+
(setq doom-modeline-project-detection 'project)
;; or `find-in-project' if it's installed
(setq doom-modeline-project-detection 'ffip)

    For more details, refer to #209 and #224.

  8. Can doom-modeline show match count while search with evil-search?

    Yes. For better experience, should enable anzu-mode and load evil-anzu.

  9. How to show that the R is running in inferior ess R mode?

    The ess R mode modifies mode-line-buffer-identification directly to display the status. To display the status in doom-modeline, you can add the status to mode-line-process or global-mode-string as below.

    (add-hook 'inferior-ess-mode-hook
      (lambda ()
        (add-to-list 'mode-line-process '(:eval (nth ess--busy-count ess-busy-strings)))))

Donate

If you think it's helpful for you, please consider paying a cup of coffee for me. Thank you! 😄

Alipay      Wechat Pay

PayPal      Buy Me A Coffee

doom-modeline's People

Contributors

7696122 avatar akash-akya avatar cireu avatar codesuki avatar edkolev avatar ericdallo avatar flatwhatson avatar hlissner avatar kaiwk avatar kanggnak1 avatar leungbk avatar lexuge avatar marienz avatar meqif avatar nbarrientos avatar netromdk avatar nofmysfk avatar prashantvithani avatar progfolio avatar seagle0128 avatar seanfarley avatar skangas avatar stebalien avatar tarjeiba avatar telotortium avatar vale981 avatar vjoki avatar vonfry avatar whame avatar yqrashawn avatar

Watchers

avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.