Function: consult-org-heading

consult-org-heading is an autoloaded, interactive and byte-compiled function defined in consult-org.el.

Signature

(consult-org-heading &optional MATCH SCOPE)

Documentation

Jump to an Org heading.

MATCH and SCOPE are as in org-map-entries and determine which entries are offered. By default, all entries of the current buffer are offered.

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/consult-20261004.957/consult-org.el
;;;###autoload
(defun consult-org-heading (&optional match scope)
  "Jump to an Org heading.

MATCH and SCOPE are as in `org-map-entries' and determine which
entries are offered.  By default, all entries of the current
buffer are offered."
  (interactive (unless (derived-mode-p #'org-mode)
                 (user-error "Must be called from an Org buffer")))
  (let ((prefix (not (memq scope '(nil tree region region-start-level file)))))
    (consult--read
     (consult--slow-operation "Collecting headings..."
       (or (consult-org--headings prefix match scope)
           (user-error "No headings")))
     :prompt "Go to heading: "
     :category 'org-heading
     :sort nil
     :require-match t
     :history '(:input consult-org--history)
     :narrow (consult-org--narrow)
     :state (consult--jump-state)
     :annotate #'consult-org--annotate
     :group (and prefix #'consult-org--group)
     :lookup (apply-partially #'consult--lookup-prop 'org-marker))))