GNU ELPA - vertico

vertico

Description
VERTical Interactive COmpletion
Latest
vertico-0.27.tar, 2022-Sep-10, 250 KiB
Maintainer
Daniel Mendler <mail@daniel-mendler.de>
Website
https://github.com/minad/vertico
Browse ELPA's repository
CGit or Gitweb
Badge
Manual
vertico

To install this package, run in Emacs:

M-x package-install RET vertico RET

Full description

GNU Emacs GNU ELPA GNU-devel ELPA

Vertico provides a performant and minimalistic vertical completion UI based on the default completion system. The main focus of Vertico is to provide a UI which behaves correctly under all circumstances. By reusing the built-in facilities system, Vertico achieves full compatibility with built-in Emacs completion commands and completion tables. Vertico only provides the completion UI but aims to be highly flexible, extensible and modular. Additional enhancements are available as extensions or complementary packages. The code base is small and maintainable. The main vertico.el package is only about 600 lines of code without white space and comments.

1 Features

  • Vertical display with arrow key navigation. See the extensions for additional display modes.
  • Prompt shows the current candidate index and the total number of candidates.
  • The current candidate is inserted with TAB and selected with RET.
  • Non-existing candidates can be submitted with M-RET or by moving the point to the prompt.
  • Configurable sorting by history position, length and alphabetically.
  • Long candidates with newlines are formatted to take up less space.
  • Deferred completion style highlighting for performance.
  • Annotations are displayed next to the candidates (annotation- and affixation-function).
  • Support for candidate grouping and group cycling commands (group-function).

https://github.com/minad/vertico/blob/screenshots/vertico-mx.png?raw=true

2 Key bindings

Vertico defines its own local keymap in the minibuffer which is derived from minibuffer-local-map. The keymap keeps most of the fundamental-mode keybindings intact and remaps and binds only a handful of commands. Note in particular the binding of TAB to vertico-insert and the bindings of vertico-exit/exit-input.

  • beginning-of-buffer, minibuffer-beginning-of-buffer -> vertico-first
  • end-of-buffer -> vertico-last
  • scroll-down-command -> vertico-scroll-down
  • scroll-up-command -> vertico-scroll-up
  • next-line, next-line-or-history-element -> vertico-next
  • previous-line, previous-line-or-history-element -> vertico-previous
  • forward-paragraph -> vertico-next-group
  • backward-paragraph -> vertico-previous-group
  • exit-minibuffer -> vertico-exit
  • kill-ring-save -> vertico-save
  • M-RET -> vertico-exit-input
  • TAB -> vertico-insert

3 Configuration

Vertico is available from GNU ELPA. You can install it directly via package-install. After installation, you can activate the global minor mode with M-x vertico-mode. In order to configure Vertico and other packages in your init.el, you may want to take advantage of use-package. Here is an example configuration:

;; Enable vertico
(use-package vertico
  :init
  (vertico-mode)

  ;; Different scroll margin
  ;; (setq vertico-scroll-margin 0)

  ;; Show more candidates
  ;; (setq vertico-count 20)

  ;; Grow and shrink the Vertico minibuffer
  ;; (setq vertico-resize t)

  ;; Optionally enable cycling for `vertico-next' and `vertico-previous'.
  ;; (setq vertico-cycle t)
  )

;; Persist history over Emacs restarts. Vertico sorts by history position.
(use-package savehist
  :init
  (savehist-mode))

;; A few more useful configurations...
(use-package emacs
  :init
  ;; Add prompt indicator to `completing-read-multiple'.
  ;; We display [CRM<separator>], e.g., [CRM,] if the separator is a comma.
  (defun crm-indicator (args)
    (cons (format "[CRM%s] %s"
		  (replace-regexp-in-string
		   "\\`\\[.*?]\\*\\|\\[.*?]\\*\\'" ""
		   crm-separator)
		  (car args))
	  (cdr args)))
  (advice-add #'completing-read-multiple :filter-args #'crm-indicator)

  ;; Do not allow the cursor in the minibuffer prompt
  (setq minibuffer-prompt-properties
	'(read-only t cursor-intangible t face minibuffer-prompt))
  (add-hook 'minibuffer-setup-hook #'cursor-intangible-mode)

  ;; Emacs 28: Hide commands in M-x which do not work in the current mode.
  ;; Vertico commands are hidden in normal buffers.
  ;; (setq read-extended-command-predicate
  ;;       #'command-completion-default-include-p)

  ;; Enable recursive minibuffers
  (setq enable-recursive-minibuffers t))

I recommend to give Orderless completion a try, which is different from the prefix TAB completion used by the basic default completion system or in shells.

;; Optionally use the `orderless' completion style.
(use-package orderless
  :init
  ;; Configure a custom style dispatcher (see the Consult wiki)
  ;; (setq orderless-style-dispatchers '(+orderless-dispatch)
  ;;       orderless-component-separator #'orderless-escapable-split-on-space)
  (setq completion-styles '(orderless basic)
	completion-category-defaults nil
	completion-category-overrides '((file (styles partial-completion)))))

The basic completion style is specified as fallback in addition to orderless in order to ensure that completion commands which rely on dynamic completion tables, e.g., completion-table-dynamic or completion-table-in-turn, work correctly. See +orderless-dispatch in the Consult wiki for an advanced Orderless style dispatcher. Additionally enable partial-completion for file path expansion. partial-completion is important for file wildcard support. Multiple files can be opened at once with find-file if you enter a wildcard. You may also give the initials completion style a try.

See also the Vertico Wiki for additional configuration tips. For more general documentation read the chapter about completion in the Emacs manual. If you want to create your own completion commands, you can find documentation about completion in the Elisp manual.

3.1 Completion styles and TAB completion

The bindings of the minibuffer-local-completion-map are not available in Vertico by default. This means that TAB works differently from what you may expect from the default Emacs completion system.

If you prefer to have the default completion commands a key press away you can add new bindings or even replace the Vertico bindings. Then the default completion commands behave as usual. For example you can use M-TAB to cycle between candidates if you have set completion-cycle-threshold.

(define-key vertico-map "?" #'minibuffer-completion-help)
(define-key vertico-map (kbd "M-RET") #'minibuffer-force-complete-and-exit)
(define-key vertico-map (kbd "M-TAB") #'minibuffer-complete)

The orderless completion style does not support completion of a common prefix substring, as you may be familiar with from shells or the basic default completion system. The reason is that the Orderless input string is usually not a prefix. In order to support completing prefixes you may want to combine orderless with substring in your completion-styles configuration.

(setq completion-styles '(substring orderless basic))

Alternatively you can experiment with the built-in completion-styles, e.g., adding partial-completion or flex. The partial-completion style is important to add if you want to open multiple files at once with find-file using wildcards. In order to open multiple files at once, you have to move to the prompt and then press RET.

(setq completion-styles '(basic substring partial-completion flex))

Because Vertico is fully compatible with Emacs default completion system, further customization of completion behavior can be achieved by setting the designated Emacs variables. For example, one may wish to disable case-sensitivity for file and buffer matching when built-in completion styles are used instead of orderless:

(setq read-file-name-completion-ignore-case t
      read-buffer-completion-ignore-case t
      completion-ignore-case t)

3.2 Completion-at-point and completion-in-region

The completion-at-point command is usually bound to M-TAB or TAB. In case you want to use Vertico for completion-at-point/completion-in-region, you can use the function consult-completion-in-region provided by the Consult package.

;; Use `consult-completion-in-region' if Vertico is enabled.
;; Otherwise use the default `completion--in-region' function.
(setq completion-in-region-function
      (lambda (&rest args)
	(apply (if vertico-mode
		   #'consult-completion-in-region
		 #'completion--in-region)
	       args)))

The completion-in-region-function setting also affects TAB completion in the minibuffer when M-: (eval-expression) is used.

You may also want to look into my Corfu package, which provides a minimal completion system for completion-in-region in a child frame popup. Corfu is also a narrowly focused package and developed in the same spirit as Vertico.

4 Extensions

We maintain small extension packages to Vertico in this repository in the subdirectory extensions/. The extensions are installed together with Vertico if you pull the package from ELPA. The extensions are inactive by default and can be enabled manually if desired. Furthermore it is possible to install all of the files separately, both vertico.el and the vertico-*.el extensions. Currently the following extensions come with the Vertico ELPA package:

  • vertico-buffer: vertico-buffer-mode to display Vertico in a separate buffer.
  • vertico-directory: Commands for Ido-like directory navigation.
  • vertico-flat: vertico-flat-mode to enable a flat, horizontal display.
  • vertico-grid: vertico-grid-mode to enable a grid display.
  • vertico-indexed: vertico-indexed-mode to select indexed candidates with prefix arguments.
  • vertico-mouse: vertico-mouse-mode to support for scrolling and candidate selection.
  • vertico-multiform: Configure Vertico modes per command or completion category.
  • vertico-quick: Commands to select using Avy-style quick keys.
  • vertico-repeat: The command vertico-repeat repeats the last completion session.
  • vertico-reverse: vertico-reverse-mode to reverse the display.
  • vertico-unobtrusive: vertico-unobtrusive-mode displays only the topmost candidate.

See the Commentary of those files for configuration details. With these extensions it is possible to adapt Vertico such that it matches your preference or behaves similar to other familiar UIs. For example, the combination vertico-flat plus vertico-directory resembles Ido in look and feel. For an interface similar to Helm, the extension vertico-buffer allows you to configure freely where the completion buffer opens, instead of growing the minibuffer. Furthermore vertico-buffer will adjust the number of displayed candidates according to the buffer height.

Configuration example for vertico-directory:

;; Configure directory extension.
(use-package vertico-directory
  :after vertico
  :ensure nil
  ;; More convenient directory navigation commands
  :bind (:map vertico-map
	      ("RET" . vertico-directory-enter)
	      ("DEL" . vertico-directory-delete-char)
	      ("M-DEL" . vertico-directory-delete-word))
  ;; Tidy shadowed file names
  :hook (rfn-eshadow-update-overlay . vertico-directory-tidy))

4.1 Configure Vertico per command or completion category

https://github.com/minad/vertico/blob/screenshots/vertico-ripgrep.png?raw=true

Vertico offers the vertico-multiform-mode which allows you to configure Vertico per command or per completion category. The vertico-buffer-mode enables a Helm-like buffer display, which takes more space but also displays more candidates. This verbose display mode is useful for commands like consult-imenu or consult-outline since the buffer display allows you to get a better overview over the entire current buffer. But for other commands you want to keep using the default Vertico display. vertico-multiform-mode solves this configuration problem!

;; Enable vertico-multiform
(vertico-multiform-mode)

;; Configure the display per command.
;; Use a buffer with indices for imenu
;; and a flat (Ido-like) menu for M-x.
(setq vertico-multiform-commands
      '((consult-imenu buffer indexed)
	(execute-extended-command unobtrusive)))

;; Configure the display per completion category.
;; Use the grid display for files and a buffer
;; for the consult-grep commands.
(setq vertico-multiform-categories
      '((file grid)
	(consult-grep buffer)))

Temporary toggling between the different display modes is possible. Bind the following commands:

(define-key vertico-map "\M-V" #'vertico-multiform-vertical)
(define-key vertico-map "\M-G" #'vertico-multiform-grid)
(define-key vertico-map "\M-F" #'vertico-multiform-flat)
(define-key vertico-map "\M-R" #'vertico-multiform-reverse)
(define-key vertico-map "\M-U" #'vertico-multiform-unobtrusive)

You can use your own functions or even lambdas to configure the completion behavior per command or per completion category. The function must have the calling convention of a mode, i.e., it takes a single argument, which is either 1 to turn on the mode and -1 to turn off the mode.

;; Configure `consult-outline' as a scaled down TOC in a separate buffer
(setq vertico-multiform-commands
      `((consult-outline buffer ,(lambda (_) (text-scale-set -1)))))

Furthermore you can tune buffer-local settings per command or category.

;; Change the default sorting function.
;; See `vertico-sort-function' and `vertico-sort-override-function'.
(setq vertico-multiform-commands
      '((describe-symbol (vertico-sort-function . vertico-sort-alpha))))

(setq vertico-multiform-categories
      '((symbol (vertico-sort-function . vertico-sort-alpha))
	(file (vertico-sort-function . sort-directories-first))))

;; Sort directories before files
(defun sort-directories-first (files)
  (setq files (vertico-sort-history-length-alpha files))
  (nconc (seq-filter (lambda (x) (string-suffix-p "/" x)) files)
	 (seq-remove (lambda (x) (string-suffix-p "/" x)) files)))

Combining these features allows us to fine-tune the completion display even more by adjusting the vertico-buffer-display-action. We can for example reuse the current window for commands of the consult-grep category (consult-grep, consult-git-grep and consult-ripgrep). Note that this configuration is incompatible with Consult preview, since the previewed buffer is usually shown in exactly this window. Nevertheless this snippet demonstrates the flexibility of the configuration system.

;; Configure the buffer display and the buffer display action
(setq vertico-multiform-categories
      '((consult-grep
	 buffer
	 (vertico-buffer-display-action . (display-buffer-same-window)))))

;; Disable preview for consult-grep commands
(consult-customize consult-ripgrep consult-git-grep consult-grep :preview-key nil)

As another example, the following code uses vertico-flat and vertico-cycle to emulate (ido-mode 'buffer), i.e., Ido when it is enabled only for completion of buffer names. vertico-cycle set to t is necessary here to prevent completion candidates from disappearing when they scroll off-screen to the left.

(setq vertico-multiform-categories
      '((buffer flat (vertico-cycle . t))))

5 Complementary packages

Vertico integrates well with complementary packages, which enrich the completion UI. These packages are fully supported:

  • Marginalia: Rich annotations in the minibuffer
  • Consult: Useful search and navigation commands
  • Embark: Minibuffer actions and context menu
  • Orderless: Advanced completion style

In order to get accustomed with the package ecosystem, I recommend the following quick start approach:

  1. Start with plain Emacs (emacs -Q).
  2. Install and enable Vertico to get incremental minibuffer completion.
  3. Install Orderless and/or configure the built-in completion styles for more flexible minibuffer filtering.
  4. Install Marginalia if you like rich minibuffer annotations.
  5. Install Embark and add two keybindings for embark-dwim and embark-act. I am using the mnemonic keybindings M-. and C-. since these commands allow you to act on the object at point or in the minibuffer.
  6. Install Consult if you want additional featureful completion commands, e.g., the buffer switcher consult-buffer with preview or the line-based search consult-line.
  7. Install Embark-Consult and Wgrep for export from consult-line to occur-mode buffers and from consult-grep to editable grep-mode buffers.
  8. Fine tune Vertico with extensions.

The ecosystem is modular. You don't have to use all of these components. Use only the ones you like and the ones which fit well into your setup. The steps 1. to 4. introduce no new commands over plain Emacs. Step 5. introduces the new commands embark-act and embark-dwim. In step 6. you get the Consult commands, some offer new functionality not present in Emacs already (e.g., consult-line) and some are substitutes (e.g., consult-buffer for switch-to-buffer).

6 Child frames and Popups

An often requested feature is the ability to display the completions in a child frame popup. Personally I am critical of using child frames for minibuffer completion. From my experience it introduces more problems than it solves. Most importantly child frames hide the content of the underlying buffer. Furthermore child frames do not play well together with changing windows and entering recursive minibuffer sessions. On top, child frames can feel slow and sometimes flicker. A better alternative is the vertico-buffer display which can even be configured individually per command using vertico-multiform. On the plus side of child frames, the completion display appears at the center of the screen, where your eyes are focused. Please give the following packages a try and judge for yourself.

  • mini-frame: Display the entire minibuffer in a child frame.
  • mini-popup: Slightly simpler alternative to mini-frame.
  • vertico-posframe: Display only the Vertico minibuffer in a child frame using the posframe library.

7 Alternatives

There are many alternative completion UIs, each UI with its own advantages and disadvantages.

Vertico aims to be 100% compliant with all Emacs commands and achieves that with a minimal code base, relying purely on completing-read while avoiding to invent its own APIs. Inventing a custom API as Helm or Ivy is explicitly avoided in order to increase flexibility and package reuse. Due to its small code base and reuse of the Emacs built-in facilities, bugs and compatibility issues are less likely to occur in comparison to completion UIs or monolithic completion systems.

Since Vertico only provides the UI, you may want to combine it with some of the complementary packages, to give a full-featured completion experience similar to Helm or Ivy. The idea is to have smaller independent components, which one can add and understand step by step. Each component focuses on its niche and tries to be as non-intrusive as possible. Vertico targets users interested in crafting their Emacs precisely to their liking - completion plays an integral part in how the users interacts with Emacs.

There are other interactive completion UIs, which follow a similar philosophy:

  • Mct: Minibuffer and Completions in Tandem. Mct reuses the default *Completions* buffer and enhances it with automatic updates and additional keybindings, to select a candidate and move between minibuffer and completions buffer. Since Mct uses a fully functional buffer you can use familiar buffer commands inside the completions buffer. The main distinction to Vertico's approach is that *Completions* buffer displays all matching candidates. This has the advantage that you can interact freely with the candidates and jump around with Isearch or Avy. On the other hand it necessarily causes a slowdown. Mct supports completion in region via its mct-region-mode. Note that Mct development is currently discontinued due to recent changes of the default completion UI on the Emacs master branch.
  • Selectrum: Selectrum is the predecessor of Vertico, since it directly inspired Vertico. Vertico offers more flexibility thanks to its extensions. Selectrum is not fully compatible with every Emacs completion command and dynamic completion tables (selectrum#481), since it uses its own filtering infrastructure, which deviates from the standard Emacs completion facilities. Therefore Selectrum is likely getting deprecated in favor of Vertico (vertico#237, selectrum#598).
  • Icomplete: Emacs 28 comes with a builtin icomplete-vertical-mode, which is a more bare-bone than Vertico. Vertico offers more flexibility thanks to its extensions.

8 Resources

If you want to learn more about Vertico and minibuffer completion, check out the following resources:

9 Contributions

Since this package is part of GNU ELPA contributions require a copyright assignment to the FSF.

10 Problematic completion commands

Vertico is robust in most scenarios. However some completion commands make certain assumptions about the completion styles and the completion UI. Some of these assumptions may not hold in Vertico or other UIs and require minor workarounds.

10.1 org-refile

org-refile uses org-olpath-completing-read to complete the outline path in steps, when org-refile-use-outline-path is non-nil.

Unfortunately the implementation of this Org completion table assumes that the basic completion style is used. The table is incompatible with completion styles like substring, flex or orderless. In order to fix the issue at the root, the completion table should make use of completion boundaries similar to the built-in file completion table. In your user configuration you can prioritize basic before orderless.

;; Alternative 1: Use the basic completion style
(setq org-refile-use-outline-path 'file
      org-outline-path-complete-in-steps t)
(advice-add #'org-olpath-completing-read :around
	    (lambda (&rest args)
	      (minibuffer-with-setup-hook
		  (lambda () (setq-local completion-styles '(basic)))
		(apply args))))

Alternatively you may want to disable the outline path completion in steps. The completion on the full path can be quicker since the input string matches directly against substrings of the full path, which is useful with Orderless. However the list of possible completions becomes much more cluttered.

;; Alternative 2: Complete full paths
(setq org-refile-use-outline-path 'file
      org-outline-path-complete-in-steps nil)

10.2 org-agenda-filter

Similar to org-refile, the org-agenda-filter completion function (org-agenda-filter-completion-function) does not make use of completion boundaries. Unfortunately TAB completion (minibuffer-complete) does not work for this reason. This affects Vertico and also the Emacs default completion system. For example if you enter +tag<0 TAB the input is replaced with 0:10 which is not correct. With preserved completion boundaries, the expected result would be +tag<0:10.

10.3 tmm-menubar

The text menu bar works well with Vertico but always shows a *Completions* buffer, which is unwanted if you use the Vertico UI. This completion buffer can be disabled with an advice. If you disabled the standard GUI menu bar and prefer the Vertico interface you may also overwrite the default F10 keybinding.

(global-set-key [f10] #'tmm-menubar)
(advice-add #'tmm-add-prompt :after #'minibuffer-hide-completions)

10.4 ffap-menu

The command ffap-menu shows the *Completions* buffer by default like tmm-menubar, which is unnecessary with Vertico. This completion buffer can be disabled as follows.

(advice-add #'ffap-menu-ask :around (lambda (&rest args)
				 (cl-letf (((symbol-function #'minibuffer-completion-help)
					    #'ignore))
				   (apply args))))

10.5 completion-table-dynamic

Dynamic completion tables (completion-table-dynamic, completion-table-in-turn, etc.) should work well with Vertico. However the requirement is that the basic completion style is enabled. The basic style performs prefix filtering by passing the input to the completion table (or the dynamic completion table function). The basic completion style must not necessarily be configured with highest priority, it can also come after other completion styles like orderless, substring or flex.

(setq completion-styles '(basic))
;; (setq completion-styles '(orderless basic))
(completing-read "Dynamic: "
		 (completion-table-dynamic
		  (lambda (str)
		    (list (concat str "1")
			  (concat str "2")
			  (concat str "3")))))

10.6 Submitting the empty string

The commands multi-occur, auto-insert, bbdb-create read multiple arguments from the minibuffer with completing-read, one at a time, until you submit an empty string. You should type M-RET (vertico-exit-input) to finish the loop. Directly pressing RET (vertico-exit) does not work since the first candidate is preselected.

The underlying issue is that completing-read always allows you to exit with the empty string, which is called the null completion, even if the REQUIRE-MATCH argument is non-nil. Try the following two calls to completing-read with C-x C-e:

(completing-read "Select: " '("first" "second" "third") nil 'require-match)
(completing-read "Select: " '("first" "second" "third") nil 'require-match nil nil "")

In both cases the empty string can be submitted. In the first case no explicit default value is specified and Vertico preselects the first candidate. In order to exit with the empty string, press M-RET. In the second case the explicit default value "" is specified and Vertico preselects the prompt, such that exiting with the empty string is possible by pressing RET only.

10.7 Tramp hostname completion

In combination with Orderless, hostnames are not made available for completion after entering /ssh:. In order to avoid this problem, the basic completion style should be specified for the file completion category, such that basic is tried before orderless.

(setq completion-styles '(orderless basic)
      completion-category-overrides '((file (styles basic partial-completion))))

For users who are familiar with the completion-style machinery: You may also define a custom completion style which sets in only for remote files!

(defun basic-remote-try-completion (string table pred point)
  (and (vertico--remote-p string)
       (completion-basic-try-completion string table pred point)))
(defun basic-remote-all-completions (string table pred point)
  (and (vertico--remote-p string)
       (completion-basic-all-completions string table pred point)))
(add-to-list
 'completion-styles-alist
 '(basic-remote basic-remote-try-completion basic-remote-all-completions nil))
(setq completion-styles '(orderless basic)
      completion-category-overrides '((file (styles basic-remote partial-completion))))

Old versions

vertico-0.26.tar.lz2022-Aug-2945.5 KiB
vertico-0.25.tar.lz2022-Jun-2741.3 KiB
vertico-0.24.tar.lz2022-May-2641.3 KiB
vertico-0.23.tar.lz2022-Apr-2241.2 KiB
vertico-0.22.tar.lz2022-Apr-0941.1 KiB
vertico-0.21.tar.lz2022-Mar-0839.8 KiB
vertico-0.20.tar.lz2022-Jan-3139.2 KiB
vertico-0.19.tar.lz2022-Jan-0738.5 KiB
vertico-0.18.tar.lz2021-Dec-3137.1 KiB
vertico-0.17.tar.lz2021-Dec-0134.2 KiB
vertico-0.16.tar.lz2021-Nov-1628.5 KiB
vertico-0.15.tar.lz2021-Nov-0828.1 KiB
vertico-0.10.tar.lz2021-May-1841.6 KiB
vertico-0.9.tar.lz2021-May-1341.7 KiB
vertico-0.8.tar.lz2021-May-0441.4 KiB
vertico-0.6.tar.lz2021-Apr-2641.0 KiB
vertico-0.5.tar.lz2021-Apr-1740.9 KiB
vertico-0.4.tar.lz2021-Apr-1239.2 KiB
vertico-0.3.tar.lz2021-Apr-1038.4 KiB
vertico-0.2.tar.lz2021-Apr-0837.1 KiB