akib/emacs-corfu-terminal
1
26
Fork 6
Code Issues 7 Pull requests 1 Projects Releases Wiki Activity
Corfu popup on terminal
48 commits 1 branch 6 tags 189 KiB
Emacs Lisp 100%
Find a file
Akib Azmain Turja 501548c3d5
Bump version to 0.7
2023-08-10 08:06:36 06:00
.dir-locals.el Add .dir-locals.el 2022-11-26 21:46:20 06:00
.elpaignore Don't ship images in packages 2022-05-21 13:31:01 06:00
COPYING Add COPYING 2022-04-15 12:49:42 06:00
corfu-terminal.el Bump version to 0.7 2023-08-10 08:06:36 06:00
demo-colorterm.png Update terminal screenshots 2022-05-14 17:56:19 06:00
demo-gui.png Add some screenshots 2022-05-07 18:42:33 06:00
demo-tty.png Update terminal screenshots 2022-05-14 17:56:19 06:00
README.org Make lines no longer than 75 characters 2022-10-25 13:15:31 06:00

README.org

corfu-terminal - Corfu popup on terminal

Corfu uses child frames to display candidates. This makes Corfu unusable on terminal. This package replaces that with popup/popon, which works everywhere.

GUI Terminal (Colorterm) TTY (with face customizations)
/akib/emacs-corfu-terminal/media/branch/master/demo-gui.png /akib/emacs-corfu-terminal/media/branch/master/demo-colorterm.png /akib/emacs-corfu-terminal/media/branch/master/demo-tty.png

Note: The above screenshots were taken with kind-icon enabled. And the TTY screenshot isn't a screenshot of a real TTY, it was emulated on a terminal emulator with TERM=linux and COLORTERM=, and the Corfu faces were modified to make the popup/popon visible on TTY.

Installation

Package

Install from NonGNU ELPA.

Quelpa 

(quelpa '(corfu-terminal
          :fetcher git
          :url "https://codeberg.org/akib/emacs-corfu-terminal.git"))

Straight.el 

(straight-use-package
 '(corfu-terminal
   :type git
   :repo "https://codeberg.org/akib/emacs-corfu-terminal.git"))

Manual

Download the corfu-terminal.el file and put it in your load-path.

Usage

Enable the global minor mode M-x corfu-terminal-mode to enable it. You'll probably want to enable it only on terminal. In that case, put the following in your init file:

(unless (display-graphic-p)
  (corfu-terminal-mode  1))

Complementary Packages

  • kind-icon: kind-icon adds an icon in front of each candidate describing the kind of the candidate.
  • corfu-doc and corfu-doc-terminal: corfu-doc show a documentation popup for the current candidate. corfu-doc-terminal provides a Popon (overlay) based display, so that you can use it on terminal.