Function: consult--prompt

consult--prompt is a byte-compiled function defined in consult.el.

Signature

(consult--prompt &rest OPTIONS &key PROMPT HISTORY ADD-HISTORY INITIAL DEFAULT KEYMAP STATE PREVIEW-KEY TRANSFORM INHERIT-INPUT-METHOD COMMAND)

Documentation

Read from minibuffer.

Keyword OPTIONS:

PROMPT is the string to prompt with. TRANSFORM is a function which is applied to the current input string. HISTORY is the symbol of the history variable. INITIAL is initial input. DEFAULT is the default selected value. ADD-HISTORY is a list of items to add to the history. STATE is the state function, see consult--with-preview. PREVIEW-KEY are the preview keys (nil, any, a single key or a list of keys). KEYMAP is a command-specific keymap. COMMAND is used for customization, defaulting to this-command.

Source Code

;; Defined in ~/.emacs.d/elpa/consult-20260805.1130/consult.el
(cl-defun consult--prompt ( &rest options &key prompt history add-history initial default
                            keymap state preview-key transform inherit-input-method command)
  "Read from minibuffer.

Keyword OPTIONS:

PROMPT is the string to prompt with.
TRANSFORM is a function which is applied to the current input string.
HISTORY is the symbol of the history variable.
INITIAL is initial input.
DEFAULT is the default selected value.
ADD-HISTORY is a list of items to add to the history.
STATE is the state function, see `consult--with-preview'.
PREVIEW-KEY are the preview keys (nil, `any', a single key or a list of keys).
KEYMAP is a command-specific keymap.
COMMAND is used for customization, defaulting to `this-command.'"
  (ignore prompt history add-history initial default command
          keymap state preview-key transform inherit-input-method)
  (apply #'consult--prompt-1
         (consult--customize-args
          options
          :prompt "Input: "
          :preview-key consult-preview-key
          :transform #'identity)))