FloatingWindow feature requests

[prabirshrestha]

Looking into adding floating window support in vim-lsp. prabirshrestha/vim-lsp#1033

And seems like few features are missing.

1. support for z-index
2. events for on_create, on_close. this allows to easily add custom events or autocmd for us
3. borders support
4. Scroll Vim8 popup scroll prabirshrestha/vim-lsp#1025

[hrsh7th]

I'm now thinking of FloatingWindow...

1. The VS.Vim.Window.FloatingWindow as more primitive

• Don't create any buffer but receive it from the user.
• Don't provide maxheight/maxwidth

2. We should introduce VS.Vim.Window.Widget.* (the first candidate is `tooltip? hover? info? hint?)

• It supports borders and scroll target.

The on_create/on_close is reasonable. I will add it.

[prabirshrestha]

I would also vote for making floating window more primitive as possible. I have shared some of my thoughts here. vim-jp/vital.vim#747 and vim-jp/vital.vim#748.

The way I think of if the primitive popup is only to normalize the apis between vim and neovim.

I would then want a PopupManager which is completely different from the primitive popup and is primarily responsible for setting the right height and position.

Similar to how callbag is solving async and callbacks issues, I was separately working on the popup to support it.

I'm ok not removing max/min width because sometimes that can be used to easily create a popups though vim-lsp might not use it as the PopupManager would be in control of the position as well as width/height.

[hrsh7th]

1. support for z-index

2. events for on_create, on_close. this allows to easily add custom events or autocmd for us

   • Implemented in VS.Vim.Window.FloatingWindow: Support on_opened/on_closed as call… #3

3. borders support

4. Scroll Vim8 popup scroll prabirshrestha/vim-lsp#1025

   • Implemented in VS.Vim.Window.FloatingWindow: Support on_opened/on_closed as call… #3

[hrsh7th]

The scroll methods can be used without VS.Vim.Window.FloatingWindow.
It was designed as can be used with a Normal window.

[prabirshrestha]

Seems like pos is not configurable.

I did implement this in my version of popup.vim.
https://github.com/vim-jp/vital.vim/pull/748/files#diff-38ecd4c22c7dc649baefaf3fc2ae524fb39d44a061defae3db905457d5890507R176-R194

[hrsh7th]

It's reasonable. I will add it.

I'm dogfooding with FloatingWindow now.

[hrsh7th]

Seems like pos is not configurable.

I've implemented as origin option that accepts as same as you implemented one.

[prabirshrestha]

Thanks for the impl. Would also need zindex support to help with this issue. prabirshrestha/vim-lsp#1049 I'm hoping to have something like let g:lsp_documentation_popup_zindex = 100

[hrsh7th]

But neovim's floating window has no zIndex option...

IMO, we shouldn't show floating-window as overlapping the completion-menu.

[prabirshrestha]

that makes sense. i would prefer not to support z-index for now.

[hrsh7th]

I'm considering border & padding.

[hrsh7th]

@prabirshrestha I've implemented simple border supports.

We can pass 'border': v:true to s:win.open().