https://github.com/countvajhula/lithium

Lightweight persistent modal interfaces for Emacs
https://github.com/countvajhula/lithium

Last synced: 22 days ago
JSON representation

Lightweight persistent modal interfaces for Emacs

• Host: GitHub
• URL: https://github.com/countvajhula/lithium
• Owner: countvajhula
• License: other
• Created: 2024-07-26T00:40:02.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-09-19T18:23:34.000Z (about 2 months ago)
• Last Synced: 2024-10-15T03:02:56.410Z (22 days ago)
• Language: Emacs Lisp
• Homepage:
• Size: 63.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: COPYING

Awesome Lists containing this project

README

        
.. image:: https://github.com/countvajhula/lithium/actions/workflows/melpazoid.yml/badge.svg

    :target: https://github.com/countvajhula/lithium/actions

lithium

=======

Lightweight modal [1]_ interfaces.

Lithium allows you to define Vim-like modes using Emacs's minor mode infrastructure. Modes may either be local to a buffer or global across all of Emacs. In either case, keybindings defined by the mode take precedence over other keybindings while the mode is enabled. Modes may remain enabled while working in the Minibuffer, so that it's possible to perform standard Emacs operations such as executing an ``M-x`` command, saving the buffer, viewing completion menus -- without affecting or being affected by the active mode.

Modes also define comprehensive lifecycle hooks so that custom behavior may be attached to mode pre-entry, post-entry, pre-exit, and post-exit.

Lithium resembles existing tools such as Hydra, Transient, and Evil. It differs from Hydra and Transient in being designed to be *persistent*, like Evil, and differs from Evil in being narrowly focused on modal behavior and thus minimal in comparison (Evil includes much more than just the modal interface), and also in supporting global (rather than buffer-local) modes. Lithium would be a good choice if what you're trying to do is fundamentally modal in nature (in the Vim sense), and if you would like to have clean and well-modeled transitions between modes. It's a good fit if your desired modal UI is *persistent* rather than "transient."

.. [1] Lithium is the lightest "metal." 🐶

Installation

============

Lithium isn't on `MELPA `_ yet, but you can install a pre-release version using `Straight.el `_ (or Elpaca) by putting this somewhere in your :code:`.emacs.d`:

.. code-block:: elisp

  (use-package lithium

    :straight

    (lithium

      :type git

      :host github

      :repo "countvajhula/lithium"))

Non-Ownership

=============

This work is not owned by anyone. Please see the `Declaration of Non-Ownership `_.