https://github.com/wyuenho/emacs-corfu-terminal

https://github.com/wyuenho/emacs-corfu-terminal

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/wyuenho/emacs-corfu-terminal
• Owner: wyuenho
• License: gpl-3.0
• Created: 2024-10-18T04:26:23.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-10-20T01:22:13.000Z (3 months ago)
• Last Synced: 2024-11-30T13:57:50.627Z (about 2 months ago)
• Language: Emacs Lisp
• Size: 122 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: COPYING

Awesome Lists containing this project

README

        
#+title: ~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) |

|----------------+----------------------+--------------------------------|

| [[./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./

* Installation

** Package

Install from NonGNU ELPA.

** Quelpa

#+begin_src emacs-lisp

(quelpa '(corfu-terminal

          :fetcher git

          :url "https://codeberg.org/akib/emacs-corfu-terminal.git"))

#+end_src

** Straight.el

#+begin_src emacs-lisp

(straight-use-package

 '(corfu-terminal

   :type git

   :repo "https://codeberg.org/akib/emacs-corfu-terminal.git"))

#+end_src

** 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:

#+begin_src emacs-lisp

(unless (display-graphic-p)

  (corfu-terminal-mode +1))

#+end_src

* Complementary Packages

- [[https://github.com/jdtsmith/kind-icon][~kind-icon~]]: ~kind-icon~ adds an icon in front of each candidate

  describing the kind of the candidate.

- [[https://github.com/galeo/corfu-doc][~corfu-doc~]] and [[https://codeberg.org/akib/emacs-corfu-doc-terminal][~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.