File: vertico.el.html

Vertico provides a performant and minimalistic vertical completion UI based on the default completion system. By reusing the built-in facilities, Vertico achieves full compatibility with built-in Emacs completion commands and completion tables.

Defined variables (28)

vertico--allow-promptPrompt selection is allowed.
vertico--baseBase string, which is concatenated with the candidate.
vertico--candidatesList of candidates.
vertico--candidates-ovOverlay showing the candidates.
vertico--count-ovOverlay showing the number of candidates.
vertico--groupsList of current group titles.
vertico--hilitLazy candidate highlighting function.
vertico--indexIndex of current candidate or negative for prompt selection.
vertico--inputCons of last minibuffer contents and point or t.
vertico--localsVertico minibuffer local variables.
vertico--lock-candidateLock-in current candidate.
vertico--lock-groupsLock-in current group order.
vertico--metadataCompletion metadata.
vertico--scrollScroll position.
vertico--totalLength of the candidate list ‘vertico--candidates’.
vertico-countMaximal number of candidates to show.
vertico-count-formatFormat string used for the candidate count.
vertico-cycleEnable cycling for ‘vertico-next’ and ‘vertico-previous’.
vertico-group-formatFormat string used for the group title.
vertico-mapVertico minibuffer keymap derived from ‘minibuffer-local-map’.
vertico-modeNon-nil if Vertico mode is enabled.
vertico-mode-hookHook run after entering or leaving ‘vertico-mode’.
vertico-multilineReplacements for multiline strings.
vertico-preselectConfigure if the prompt or first candidate is preselected.
vertico-resizeHow to resize the Vertico minibuffer window, see ‘resize-mini-windows’.
vertico-scroll-marginNumber of lines at the top and bottom when scrolling.
vertico-sort-functionDefault sorting function, used if no ‘display-sort-function’ is specified.
vertico-sort-override-functionOverride sort function which overrides the ‘display-sort-function’.

Defined functions (46)

vertico--advice(&rest APP)
vertico--affixate(CANDS)
vertico--arrange-candidates()
vertico--candidate(&optional HL)
vertico--command-p(SYM BUFFER)
vertico--compute(INPUT)
vertico--compute-scroll()
vertico--cycle(LIST N)
vertico--debug(&rest _)
vertico--display-candidates(LINES)
vertico--display-count()
vertico--display-string(STR)
vertico--exhibit()
vertico--filter-completions(&rest ARGS)
vertico--format-candidate(CAND PREFIX SUFFIX INDEX START)
vertico--format-count()
vertico--format-group-title(TITLE CAND)
vertico--goto(INDEX)
vertico--group-by(FUN ELEMS)
vertico--hilit(CAND)
vertico--metadata-get(PROP)
vertico--move-to-front(ELEM LIST)
vertico--prepare()
vertico--prompt-selection()
vertico--protect(FUN)
vertico--remote-p(PATH)
vertico--remove-face(BEG END FACE &optional OBJ)
vertico--resize-window(HEIGHT)
vertico--setup()
vertico--sort-function()
vertico--truncate-multiline(STR MAX)
vertico--update(&optional INTERRUPTIBLE)
vertico--window-width()
vertico-exit(&optional ARG)
vertico-exit-input()
vertico-first()
vertico-insert()
vertico-last()
vertico-mode(&optional ARG)
vertico-next(&optional N)
vertico-next-group(&optional N)
vertico-previous(&optional N)
vertico-previous-group(&optional N)
vertico-save()
vertico-scroll-down(&optional N)
vertico-scroll-up(&optional N)

Defined faces (4)

vertico-currentFace used to highlight the currently selected candidate.
vertico-group-separatorFace used for the separator lines of the candidate groups.
vertico-group-titleFace used for the title text of the candidate group headlines.
vertico-multilineFace used to highlight multiline replacement characters.