doomemacs/modules/ui/modeline/README.org

ui/modeline

• Description
  • Module Flags
  • Plugins
• Prerequisites
• Usage
  • Hiding the modeline
  • Switching the modeline and header line
• Configuration
  • Changing the default modeline
  • Activating a format
  • Defining a modeline format
  • Defining a modeline segment
  • Extracting Doom's modeline into your config
• Troubleshooting
  • Where are my minor modes?
  • Icons in my modeline look strange
• Appendix
  • Commands
  • Autodefs
  • Functions
  • Variables
  • Faces
  • Modeline segments

Description

This module provides an Atom-inspired, minimalistic modeline for Doom Emacs, as well as an API for building your own.

• A match count panel (for evil-search, iedit and evil-substitute)
• An indicator for recording a macro
• Local python/ruby version in the major-mode
• A customizable mode-line height (see +doom-modeline-height)
• An error/warning count segment for flycheck

Module Flags

This module provides no flags.

Plugins

• anzu
• evil-anzu
• shrink-path

Prerequisites

This module has no prerequisites.

Usage

TODO Hiding the modeline

TODO Switching the modeline and header line

Configuration

TODO Changing the default modeline

TODO Activating a format

TODO Defining a modeline format

TODO Defining a modeline segment

TODO Extracting Doom's modeline into your config

Troubleshooting

Where are my minor modes?

I rarely need to know what minor modes are active, so I removed them. M-x doom/what-minor-mode was written to substitute for it.

TODO Icons in my modeline look strange

Appendix

Commands

This module exposes no public commands.

Autodefs

• def-modeline-format! NAME LEFT &optional RIGHT
• def-modeline-segment! NAME &rest REST
• set-modeline! NAME &optional DEFAULT

Functions

• +modeline-file-path

Variables

• +modeline-width
• +modeline-height
• +modeline-buffer-path-function
• +modeline-format-left
• +modeline-format-rigth

Faces

• doom-modeline-buffer-path
• doom-modeline-buffer-file
• doom-modeline-buffer-modified
• doom-modeline-buffer-major-mode
• doom-modeline-highlight
• doom-modeline-panel
• doom-modeline-info
• doom-modeline-warning
• doom-modeline-urgent
• doom-modeline-bar

Modeline segments

• +modeline-buffer-state
• +modeline-buffer-id
• +modeline-buffer-directory
• +modeline-vcs
• +modeline-encoding
• +modeline-major-mode
• +modeline-matches
• +modeline-selection-info