eldoc-frame/README.org

58 lines
3.3 KiB
Org Mode
Raw Normal View History

2018-12-14 23:05:54 +00:00
#+TITLE: ElDoc box
2018-12-11 14:17:31 +00:00
This package displays ElDoc documentations in a childframe.
2018-12-17 03:40:26 +00:00
#+CAPTION: Using with eglot in python-mode
[[./screenshot.png]]
2018-12-11 01:30:33 +00:00
* Install
Get the file, add to load path, and
#+BEGIN_SRC emacs-lisp
2018-12-11 14:17:31 +00:00
(require 'eldoc-box)
2018-12-11 01:30:33 +00:00
#+END_SRC
* Usage
2018-12-11 16:17:17 +00:00
** Function
2018-12-26 21:42:42 +00:00
Enable either mode will make eldoc display documentation on a popup childframe. The difference is the position of the childframe — the first minor mode displays the childframe on the (left or right) upper corner, while the second displays the childframe right below point.
2018-12-26 21:38:01 +00:00
Note that =eldoc-box-hover-at-point-mode= enables =eldoc-box-hover-mode= — it just adds some more configuration on top of the latter, so you want to disable “at-point” mode before switching to =eldoc-box-hover-mode=.
2018-12-26 21:38:01 +00:00
- =eldoc-box-hover-mode= :: Display documentation of the symbol at point in a childframe on upper corner.
2018-12-26 21:42:42 +00:00
- =eldoc-box-hover-at-point-mode= :: Display documentation of the symbol at point in a childframe below point. (That's what the =at-point= part mean)
2018-12-11 16:17:17 +00:00
** Face
- =eldoc-box-border= :: Adjust =:background= of this face for border color.
- =eldoc-box-body= :: Adjust =:background= and =:font= of this face for background color and font of the childframe. I suggest to use a nice Sans Serif font, such as Source Sans Pro.
2018-12-11 16:17:17 +00:00
** Variable
- =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.
2018-12-21 03:19:58 +00:00
- =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). This doesn't apply to =eldoc-box-hover-at-point-mode=, in that mode the childframe is cleared as soon as point moves.
** Use with eglot
As of writing this README, eglot doesn't have a public mode hook, use this hook:
#+BEGIN_SRC emacs-lisp
(add-hook 'eglot--managed-mode-hook #'eldoc-box-hover-mode t)
#+END_SRC
2018-12-21 03:54:58 +00:00
** Help at point hack
2019-01-01 06:44:57 +00:00
If all you need is a "help at point" popup to be used with eglot, here is my hack. You don't need to enable any minor mode, just call this command on the symbol. (In fact, I dont even use =eldoc-box-hover-mode= anymore. I bind this hack to =C-h C-h= and lived happily ever after.)
2018-12-21 03:54:58 +00:00
#+BEGIN_SRC emacs-lisp
2019-01-01 06:44:57 +00:00
(defun eldoc-box-hack-cleanup ()
"Try to clean up the childframe made by eldoc-box hack."
(if (eq (point) eldoc-box-hack-last-point)
(run-with-timer 0.1 nil #'eldoc-box-hack-cleanup)
(eldoc-box-quit-frame)))
2018-12-21 03:54:58 +00:00
(defun moon-help-at-point ()
(interactive)
(when eglot--managed-mode
(require 'eldoc-box)
(let ((eldoc-box-position-function #'eldoc-box--default-at-point-position-function))
(eldoc-box--display
(eglot--dbind ((Hover) contents range)
(jsonrpc-request (eglot--current-server-or-lose) :textDocument/hover
(eglot--TextDocumentPositionParams))
(when (seq-empty-p contents) (eglot--error "No hover info here"))
(eglot--hover-info contents range))))
2019-01-01 06:44:57 +00:00
(setq eldoc-box-hack-last-point (point))
(run-with-timer 0.1 nil #'eldoc-box-hack-cleanup)))
2018-12-21 03:54:58 +00:00
#+END_SRC
2018-12-26 21:42:42 +00:00
2018-12-20 18:53:24 +00:00
* Contributors
- [[https://github.com/joaotavora][João Távora]]