Skip to content
Less annoying completion preview window based on neovim's floating window
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
autoload ncm2-plugin/float_preview.py only remove menu when docked=0 Mar 18, 2019
ncm2-plugin ncm2-plugin/float_preview.py only remove menu when docked=0 Mar 18, 2019
plugin
LICENSE
README.md

README.md

float-preview.nvim

With let g:float_preview#docked = 1:

asciicast

With let g:float_preview#docked = 0:

asciicast

Note that this is a general purpose plugin instead of ncm2 only, it applies to :help complete-items with info field available.

Why ?

Vim's builtin set completeopt+=preview is annoying. When the preview window is opened, it simply pumps text out of my eye spot. Which makes it very disturbing and actually unusable.

This plugin uses neovim's floating Window, it should never pumps text out of your eye spot.

Config && API

g:float_preview#docked

If set to 0, the preview window will be displayed beside the popup menu. Defaults to 1.

g:float_preview#winhl

Custom highlights for preview window. See :help 'winhl' for more information.

g:float_preview#max_height

Height of the preview window. Defaults to :help 'previewheight'.

g:float_preview#max_width

Only used when g:float_preview#docked == 0. Max width of the preview window. Defaults to 50.

g:float_preview#auto_close

Defaults to 1. Only used when g:float_preview#docked == 1.

If you don't want this plugin auto closing the preview window, use :let g:float_preview#auto_close = 0 and call float_preview#close() by yourself.

You can’t perform that action at this time.