Skip to content

corfu.el - COmpletion in Region FUnction

GNU Emacs GNU ELPA GNU-devel ELPA MELPA Releases MELPA Snapshots

Corfu enhances in-buffer completion with a small completion popup. The current candidates are shown in a popup below or above the point, and can be selected by moving up and down. Corfu is the minimalistic in-buffer completion counterpart of the Vertico minibuffer UI.

Corfu is a small package, which relies on the Emacs completion facilities and concentrates on providing a polished completion UI. In-buffer completion UIs in Emacs can hook into completion-in-region, which implements the interaction with the user. Completions at point are either provided by commands like dabbrev-completion or by pluggable backends (completion-at-point-functions, Capfs) and are then passed to completion-in-region. Many programming, text and shell major modes implement a Capf. Corfu does not include its own completion backends. The Emacs built-in Capfs and the Capfs provided by third-party programming language packages are often sufficient. Additional Capfs and completion utilities are provided by the separate Cape package.

NOTE: Corfu relies on child frames to show the popup. On Emacs 31 this works for terminal Emacs. Use the corfu-terminal package on older Emacs versions.

Table of Contents