File: corfu.el.html

Corfu enhances in-buffer completion with a small completion popup.

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

Defined variables (45)

corfu--baseBase string, which is concatenated with the candidate.
corfu--buffer-parametersDefault child frame buffer parameters.
corfu--candidatesList of candidates.
corfu--change-groupUndo change group.
corfu--framePopup frame.
corfu--frame-parametersDefault child frame parameters.
corfu--hilitLazy candidate highlighting function.
corfu--indexIndex of current candidate or negative for prompt selection.
corfu--initial-stateInitial Corfu state.
corfu--inputCons of last prompt contents and point.
corfu--metadataCompletion metadata.
corfu--mouse-ignore-mapIgnore all mouse clicks.
corfu--preselectIndex of preselected candidate, negative for prompt selection.
corfu--preview-ovCurrent candidate overlay.
corfu--scrollScroll position.
corfu--totalLength of the candidate list ‘corfu--candidates’.
corfu--widthPopup width of current completion to reduce width fluctuations.
corfu-autoEnable auto completion.
corfu-bar-widthWidth of the bar in units of the character width.
corfu-border-widthWidth of the border in pixels, only applies to GUI Emacs.
corfu-continue-commandsContinue Corfu completion after executing these commands.
corfu-countMaximal number of candidates to show.
corfu-cycleEnable cycling for ‘corfu-next’ and ‘corfu-previous’.
corfu-left-margin-widthWidth of the left margin in units of the character width.
corfu-mapKeymap used when popup is shown.
corfu-margin-formattersRegistry for margin formatter functions.
corfu-max-widthPopup maximum width in characters.
corfu-min-widthPopup minimum width in characters.
corfu-modeNon-nil if Corfu mode is enabled.
corfu-mode-hookHook run after entering or leaving ‘corfu-mode’.
corfu-mode-mapKeymap used when ‘corfu-mode’ is active.
corfu-on-exact-matchConfigure how a single exact match should be handled.
corfu-preselectConfigure if the prompt or first candidate is preselected.
corfu-preview-currentPreview currently selected candidate.
corfu-quit-at-boundaryAutomatically quit at completion boundary.
corfu-quit-no-matchAutomatically quit if no matching candidate is found.
corfu-right-margin-widthWidth of the right margin in units of the character width.
corfu-scroll-marginNumber of lines at the top and bottom when scrolling.
corfu-separatorComponent separator character.
corfu-sort-functionDefault sorting function.
corfu-sort-override-functionOverride sort function which overrides the ‘display-sort-function’.
global-corfu-minibufferCorfu should be enabled in the minibuffer by ‘global-corfu-mode’.
global-corfu-modeNon-nil if Global Corfu mode is enabled.
global-corfu-mode-hookHook run after entering or leaving ‘global-corfu-mode’.
global-corfu-modesWhich major modes ‘corfu-mode’ is switched on in.

Defined functions (56)

corfu--affixate(CANDS)
corfu--candidates-popup(POS)
corfu--capf-wrapper(FUN &optional PREFIX)
corfu--capf-wrapper-advice(ORIG FUN WHICH)
corfu--compute(INPUT TABLE PRED)
corfu--compute-scroll()
corfu--cycle-candidates(TOTAL CANDS BEG END)
corfu--done(STR STATUS CANDS)
corfu--eldoc-advice()
corfu--exit-function(STR STATUS CANDS)
corfu--filter-completions(&rest ARGS)
corfu--format-candidates(CANDS)
corfu--goto(INDEX)
corfu--hide-frame(FRAME)
corfu--hide-frame-deferred(FRAME)
corfu--in-region(&rest ARGS)
corfu--in-region-1(BEG END TABLE PRED)
corfu--insert(STATUS)
corfu--length-string<(X Y)
corfu--make-frame(FRAME X Y WIDTH HEIGHT)
corfu--match-symbol-p(PATTERN SYM)
corfu--message(&rest MSG)
corfu--metadata-get(PROP)
corfu--move-prefix-candidates-to-front(FIELD CANDS)
corfu--move-to-front(ELEM LIST)
corfu--partition!(LIST FORM)
corfu--popup-hide()
corfu--popup-show(POS OFF WIDTH LINES &optional CURR LO BAR)
corfu--prepare()
corfu--preview-current(BEG END)
corfu--preview-current-p()
corfu--preview-delete()
corfu--protect(FUN)
corfu--range-valid-p()
corfu--setup(BEG END TABLE PRED)
corfu--sort-function()
corfu--teardown(BUFFER)
corfu--try-completion(STR TABLE PRED PT &optional MD)
corfu--update(&optional INTERRUPTIBLE)
corfu--window-change(_)
corfu-complete()
corfu-expand()
corfu-first()
corfu-insert()
corfu-insert-separator()
corfu-last()
corfu-mode(&optional ARG)
corfu-next(&optional N)
corfu-previous(&optional N)
corfu-quit()
corfu-reset()
corfu-scroll-down(&optional N)
corfu-scroll-up(&optional N)
corfu-send()
corfu-sort-length-alpha(LIST)
global-corfu-mode(&optional ARG)

Defined faces (6)

corfu-annotationsFace used for annotations.
corfu-barThe background color is used for the scrollbar indicator.
corfu-borderThe background color used for the thin border.
corfu-currentFace used to highlight the currently selected candidate.
corfu-defaultDefault face, foreground and background colors used for the popup.
corfu-deprecatedFace used for deprecated candidates.