README.org (1955B)
1 #+title: ~corfu-terminal~ - Corfu popup on terminal 2 3 Corfu uses child frames to display candidates. This makes Corfu 4 unusable on terminal. This package replaces that with popup/popon, 5 which works everywhere. 6 7 | GUI | Terminal (Colorterm) | TTY (with face customizations) | 8 |----------------+----------------------+--------------------------------| 9 | [[./demo-gui.png]] | [[./demo-colorterm.png]] | [[./demo-tty.png]] | 10 11 /Note: The above screenshots were taken with ~kind-icon~ enabled./ 12 /And the TTY screenshot isn't a screenshot of a real TTY, it was/ 13 /emulated on a terminal emulator with ~TERM=linux~ and ~COLORTERM=~,/ 14 /and the Corfu faces were modified to make the popup/popon visible on/ 15 /TTY./ 16 17 * Installation 18 19 ** Package 20 21 Install from NonGNU ELPA. 22 23 ** Quelpa 24 25 #+begin_src emacs-lisp 26 (quelpa '(corfu-terminal 27 :fetcher git 28 :url "https://codeberg.org/akib/emacs-corfu-terminal.git")) 29 #+end_src 30 31 ** Straight.el 32 33 #+begin_src emacs-lisp 34 (straight-use-package 35 '(corfu-terminal 36 :type git 37 :repo "https://codeberg.org/akib/emacs-corfu-terminal.git")) 38 #+end_src 39 40 ** Manual 41 42 Download the ~corfu-terminal.el~ file and put it in your ~load-path~. 43 44 * Usage 45 46 Enable the global minor mode =M-x corfu-terminal-mode= to enable 47 it. You'll probably want to enable it only on terminal. In that case, 48 put the following in your init file: 49 50 #+begin_src emacs-lisp 51 (unless (display-graphic-p) 52 (corfu-terminal-mode +1)) 53 #+end_src 54 55 * Complementary Packages 56 57 - [[https://github.com/jdtsmith/kind-icon][~kind-icon~]]: ~kind-icon~ adds an icon in front of each candidate 58 describing the kind of the candidate. 59 - [[https://github.com/galeo/corfu-doc][~corfu-doc~]] and [[https://codeberg.org/akib/emacs-corfu-doc-terminal][~corfu-doc-terminal~]]: ~corfu-doc~ show a 60 documentation popup for the current candidate. ~corfu-doc-terminal~ 61 provides a Popon (overlay) based display, so that you can use it on 62 terminal.