#1970 Explain how to configure mouse hovering better
This commit is contained in:
parent
b7ec11c93d
commit
d999eb1f35
2 changed files with 17 additions and 3 deletions
|
@ -310,8 +310,9 @@ ALE supports "hover" information for printing brief information about symbols at
|
|||
the cursor taken from Language Server Protocol linters and `tsserver` with the
|
||||
`ALEHover` command.
|
||||
|
||||
On vim/gvim with `balloon` support you can see the information in a tooltip
|
||||
that appears under the mouse when you mouseover a symbol.
|
||||
The information can be displayed in a `balloon` tooltip in Vim or GVim by
|
||||
hovering your mouse over symbols. Mouse hovering is enabled by default in GVim,
|
||||
and needs to be configured for Vim 8.1+ in terminals.
|
||||
|
||||
See `:help ale-hover` for more information.
|
||||
|
||||
|
|
15
doc/ale.txt
15
doc/ale.txt
|
@ -759,12 +759,25 @@ at the cursor taken from LSP linters. The following commands are supported:
|
|||
|
||||
|ALEHover| - Print information about the symbol at the cursor.
|
||||
|
||||
If |b:ale_set_balloons| is set to `1` and your version of Vim supports the
|
||||
If |g:ale_set_balloons| is set to `1` and your version of Vim supports the
|
||||
|balloon_show()| function, then "hover" information also show up when you move
|
||||
the mouse over a symbol in a buffer. Diagnostic information will take priority
|
||||
over hover information for balloons. If a line contains a problem, that
|
||||
problem will be displayed in a balloon instead of hover information.
|
||||
|
||||
For Vim 8.1+ terminals, mouse hovering is disabled by default. Enabling
|
||||
|balloonexpr| commands in terminals can cause scrolling issues in terminals,
|
||||
so ALE will not attempt to show balloons unless |g:ale_set_balloons| is set to
|
||||
`1` before ALE is loaded.
|
||||
|
||||
For enabling mouse support in terminals, you may have to change your mouse
|
||||
settings. For example: >
|
||||
|
||||
" Example mouse settings.
|
||||
" You will need to try different settings, depending on your terminal.
|
||||
set mouse=a
|
||||
set ttymouse=xterm
|
||||
<
|
||||
|
||||
===============================================================================
|
||||
6. Global Options *ale-options*
|
||||
|
|
Reference in a new issue