File: corfu-popupinfo.el.html

Display an information popup for completion candidate when using Corfu. The popup displays either the candidate documentation or the candidate location. The corfu-popupinfo-mode(var)/corfu-popupinfo-mode(fun) must be enabled globally. Set corfu-popupinfo-delay to nil if the info popup should not update automatically. If the popup should not appear initially, but update automatically afterwards, use (setq corfu-popupinfo-delay
(cons nil 1.0)).

For manual toggling the commands corfu-popupinfo-toggle, corfu-popupinfo-location and corfu-popupinfo-documentation are bound in the corfu-popupinfo-map.

Defined variables (22)

corfu-popupinfo--bufferBuffer used by the popup.
corfu-popupinfo--buffer-parametersAdditional child frame buffer parameters.
corfu-popupinfo--candidateCompletion candidate for the info popup.
corfu-popupinfo--frameInfo popup child frame.
corfu-popupinfo--functionFunction called to obtain documentation string.
corfu-popupinfo--geometryGeometry of the candidate popup.
corfu-popupinfo--initial-stateInitial state of ‘corfu-popupinfo-mode’.
corfu-popupinfo--lock-dirLocked position direction of the info popup.
corfu-popupinfo--timerCorfu info popup auto display timer.
corfu-popupinfo--toggleToggle state.
corfu-popupinfo-delayAutomatically update info popup after that number of seconds.
corfu-popupinfo-directionPreferred directions for the popup in order.
corfu-popupinfo-hideHide the popup during the transition between candidates.
corfu-popupinfo-mapAdditional keymap activated by ‘corfu-popupinfo-mode’.
corfu-popupinfo-margin-widthMargin at the left and right side of the popup.
corfu-popupinfo-max-heightThe maximum height of the info popup in characters.
corfu-popupinfo-max-widthThe maximum width of the info popup in characters.
corfu-popupinfo-min-heightThe minimum height of the info popup in characters.
corfu-popupinfo-min-widthThe minimum width of the info popup in characters.
corfu-popupinfo-modeNon-nil if Corfu-Popupinfo mode is enabled.
corfu-popupinfo-mode-hookHook run after entering or leaving ‘corfu-popupinfo-mode’.
corfu-popupinfo-resizeResize the info popup automatically if non-nil.

Defined functions (4)

corfu-popupinfo--fits-p(SIZE AREA)
corfu-popupinfo--get-location(CANDIDATE)
corfu-popupinfo-beginning(&optional N)
corfu-popupinfo-mode(&optional ARG)

Defined faces (1)

corfu-popupinfoFace used for the info popup. In order to use a smaller face for the popupinfo, use for example: (set-face-attribute \='corfu-popupinfo nil :height 0.8)