Function: icomplete-vertical-mode

icomplete-vertical-mode is an autoloaded, interactive and byte-compiled function defined in icomplete.el.gz.

Signature

(icomplete-vertical-mode &optional ARG)

Documentation

Toggle vertical candidate display in icomplete-mode(var)/icomplete-mode(fun) or fido-mode(var)/fido-mode(fun).

If none of these modes are on, turn on icomplete-mode(var)/icomplete-mode(fun).

As many completion candidates as possible are displayed, depending on the value of max-mini-window-height, and the way the mini-window is resized depends on resize-mini-windows.

This is a global minor mode. If called interactively, toggle the Icomplete-Vertical mode mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

To check whether the minor mode is enabled in the current buffer, evaluate (default-value \=icomplete-vertical-mode)'.

The mode's hook is called both when the mode is enabled and when it is disabled.

View in manual

Probably introduced at or before Emacs version 28.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/icomplete.el.gz
;;;###autoload
(define-minor-mode icomplete-vertical-mode
  "Toggle vertical candidate display in `icomplete-mode' or `fido-mode'.

If none of these modes are on, turn on `icomplete-mode'.

As many completion candidates as possible are displayed, depending on
the value of `max-mini-window-height', and the way the mini-window is
resized depends on `resize-mini-windows'."
  :global t
  (remove-hook 'icomplete-minibuffer-setup-hook
               #'icomplete--vertical-minibuffer-setup)
  (when icomplete-vertical-mode
    (unless icomplete-mode
      (icomplete-mode 1))
    (add-hook 'icomplete-minibuffer-setup-hook
              #'icomplete--vertical-minibuffer-setup)))