Simple ElDoc frontend that displays documentation in a floating child frame

Go to file

Yuan Fu 112afa1137 Abstract timer interval as a variable 1 second is a bit too long, but old machines might want a longer interval, I set it to 0.2 on my machine and CPU looks ok.		2018-12-18 12:34:48 -05:00
eldoc-box.el	Abstract timer interval as a variable	2018-12-18 12:34:48 -05:00
README.org	Abstract timer interval as a variable	2018-12-18 12:34:48 -05:00
screenshot.png	Add screenshot for melpa	2018-12-16 22:40:26 -05:00

ElDoc box

This package displays ElDoc documentations in a childframe.

Install

Get the file, add to load path, and

(require 'eldoc-box)

eldoc-box-hover-mode: Show documentation upon hover. Note that you need to enable ElDoc mode for this to work.

eldoc-box-border: Adjust :background of this face for border color.
eldoc-box-body: Adjust :background of this face for background color of childframe.

eldoc-box-max-pixel-width & eldoc-box-max-pixel-height: Set them according to the screen resolution of your machine.
eldoc-box-only-multi-line: Set this to non-nil and eldoc-box only display multi-line message in childframe. One line messages are left in minibuffer.
eldoc-box-cleanup-interval: After this amount of seconds will eldoc-box attempt to cleanup the childframe. E.g. if it is set to 1, the childframe is cleared 1 second after you moved the point to somewhere else (that doesn't have a doc to show).

As of writing this README, eglot doesn't have a public mode hook, use this hook:

(add-hook 'eglot--managed-mode-hook #'eldoc-box-hover-mode t)