NonGNU ELPA - corfu-terminal

corfu-terminal

Description
Corfu popup on terminal
Latest
corfu-terminal-0.4.tar, 2022-May-31, 60.0 KiB
Maintainer
Akib Azmain Turja <akib@disroot.org>
Website
https://codeberg.org/akib/emacs-corfu-terminal
Browse ELPA's repository
CGit or Gitweb
Badge

To install this package, run in Emacs:

M-x package-install RET corfu-terminal RET

Full description

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)
demo-gui.png demo-colorterm.png 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.

1 Installation

1.1 Package

Install from NonGNU ELPA.

1.2 Quelpa

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

1.3 Straight.el

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

1.4 Manual

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

2 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))

3 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.

Old versions

corfu-terminal-0.3.tar.lz2022-May-2914.1 KiB
corfu-terminal-0.2.tar.lz2022-May-2514.2 KiB
corfu-terminal-0.1.tar.lz2022-May-233.07 KiB