feat(view): Floating nvim tree window #1377 by kciesla93 · Pull Request #1462 · nvim-tree/nvim-tree.lua

kciesla93 · 2022-07-25T13:08:01Z

This PR adds option to display nvim-tree window as float. Requires setting nvim-tree.actions.open_file.quit_on_open to true to work properly.

References #1377

kyazdani42 · 2022-07-25T13:24:44Z

+        float = {
+          enable = false,
+          -- options passed to nvim_open_win()
+          relative = "editor",
+          row = 1,
+          col = 1,
+          border = "rounded",


should be documented. specially because:

Requires setting nvim-tree.actions.open_file.quit_on_open to true to work properly.

If we require this, quit_on_open should be overridden and set when float.enable is set.

quit_on_open is now enforced if float.enable is set.

kyazdani42 · 2022-07-25T13:26:31Z

thanks for the PR :) i think this was asked a lot by people, we could ask them to try it out.
#135

alex-courtis · 2022-07-25T23:19:08Z

Switching away from the nvim-tree window is problematic as the cursor shows in the nvim-tree window. This is a confusing user experience.

Minimal config with quit_on_open and float.enable set

<C-W>w was used to switch windows.

Practical Proposal
quit_on_open is insufficient as it only covers one specific case.
Close the nvim-tree window when focus is lost.

gitsigns.nvim behaviour

alex-courtis

Very promising, needs UX improvements: #1462 (comment)

I'm tempted to release this early and resolve bugs / improve UX after users raise issues; I expect there will be a lot. Thoughts @kyazdani42 ?

@khrees can you commit to ongoing support / fixes / changes for this feature?

alex-courtis · 2022-07-25T23:26:27Z

+        float = {
+          enable = false,
+          -- options passed to nvim_open_win()
+          relative = "editor",
+          row = 1,
+          col = 1,
+          border = "rounded",


If we require this, quit_on_open should be overridden and set when float.enable is set.

kyazdani42 · 2022-07-26T08:29:32Z

I agree we could merge a first version and improve on that. I'm not sure all the UX impacts that will raise.
Closing the window when leaving it would also be a good addition i think

kciesla93 · 2022-07-26T09:02:31Z

@khrees can you commit to ongoing support / fixes / changes for this feature?

Yes, but it will be somewhat limited.

…e-window-nvim-tree#1377

kyazdani42

LGTM, lets wait for alex's review

alex-courtis

nvim-tree float is still not closing on window exit

minimal config

open up nvim_open_win config

After playing with this for a while, it became clear that the user needs to be able to set all of the config passed to nvim_open_win, rather than the limited config we allow.

Solution is to allow the user to pass all config, rather than just what we specify in the defaults. The user may pass an invalid config to nvim_open_win however they will get a useful error message.

Added float.open_win_config which is no longer validated, however it is merged. Simplified help to match.

Tidied view.lua: just pass the options to open_win.

0001-add-view.float.open_win_config-skipping-validation.patch.txt

kciesla93 · 2022-08-02T07:29:37Z

@alex-courtis I have applied your patch and made nvim-tree window close on focus lost.

alex-courtis · 2022-08-02T22:41:09Z

@alex-courtis I have applied your patch and made nvim-tree window close on focus lost.

Thank you. I can't test / approve until the weekend.

alex-courtis · 2022-08-06T05:39:25Z

Works beautifully with a variety of options.

Let's see how users like it...

davidsierradz · 2022-08-10T13:58:25Z

Hi! Testing and it works super well. Could we allow width, height, col and row to be functions that return numbers? So we can calculate on demand this values. My use-case would be to open the float window in the center, with something like:

local screen_w = vim.opt.columns:get()
local screen_h = vim.opt.lines:get() - vim.opt.cmdheight:get()
local _width = screen_w
local _height = screen_h
local width = math.floor(_width)
local height = math.floor(_height)
local center_y = (vim.opt.lines:get() - _height) / 2
local center_x = (screen_w - _width) / 2

Thanks!

alex-courtis · 2022-08-14T02:38:38Z

Hi! Testing and it works super well. Could we allow width, height, col and row to be functions that return numbers? So we can calculate on demand this values. My use-case would be to open the float window in the center, with something like:
local screen_w = vim.opt.columns:get()
local screen_h = vim.opt.lines:get() - vim.opt.cmdheight:get()
local _width = screen_w
local _height = screen_h
local width = math.floor(_width)
local height = math.floor(_height)
local center_y = (vim.opt.lines:get() - _height) / 2
local center_x = (screen_w - _width) / 2
Thanks!

Very interesting. Rather than individual functions, we could instead have view.float.open_win_config be a function that returns a complete able of options. Please raise a feature request.

avalonv · 2022-08-21T21:12:07Z

Is there a summary for how to enable and test this for someone who just installed the extension?

alex-courtis · 2022-08-22T02:08:22Z

Is there a summary for how to enable and test this for someone who just installed the extension?

:help nvim-tree.view.float

* Simple mock-up of floating nvim-tree window * Passing whole table to nvim_open_win() * Run update-help.sh * Use vim.api alias * Add comment to float options * Added `anchor` to float options * Enabling float window enforces `actions.open_file.quit_on_open` * Added documentation * add view.float.open_win_config, skipping validation * Made nvim-tree window closes when float is enabled * Close nvim-tree window when out of focus * Update help Co-authored-by: Krzysztof Cieśla <krzysztof.marcin.ciesla@cern.ch> Co-authored-by: Alexander Courtis <alex@courtis.org>

kciesla93 added 5 commits July 25, 2022 13:59

Simple mock-up of floating nvim-tree window

41c7b4c

Passing whole table to nvim_open_win()

85f7b8e

Run update-help.sh

4e4b626

Use vim.api alias

2f532bc

Add comment to float options

16d4573

kyazdani42 requested changes Jul 25, 2022

View reviewed changes

alex-courtis requested changes Jul 25, 2022

View reviewed changes

kciesla93 added 3 commits July 26, 2022 11:22

Added anchor to float options

adb6324

Enabling float window enforces actions.open_file.quit_on_open

64d5149

Merge remote-tracking branch 'upstream/master' into floating-nvim-tre…

8a4f149

…e-window-nvim-tree#1377

kyazdani42 requested changes Jul 26, 2022

View reviewed changes

Comment thread doc/nvim-tree-lua.txt

Added documentation

75a2e00

kyazdani42 approved these changes Jul 26, 2022

View reviewed changes

kyazdani42 requested a review from alex-courtis July 30, 2022 08:36

alex-courtis requested changes Jul 31, 2022

View reviewed changes

alex-courtis and others added 4 commits August 2, 2022 08:50

add view.float.open_win_config, skipping validation

8f8153d

Made nvim-tree window closes when float is enabled

921f1f2

Close nvim-tree window when out of focus

478a4c6

Update help

35854c2

kyazdani42 requested a review from alex-courtis August 2, 2022 12:00

alex-courtis mentioned this pull request Aug 6, 2022

when using ctrlp.vim quit_on_open doesn't quit on open #1488

Closed

alex-courtis approved these changes Aug 6, 2022

View reviewed changes

alex-courtis merged commit 7323c81 into nvim-tree:master Aug 6, 2022

davidsierradz mentioned this pull request Aug 18, 2022

[Feature request] Allow floating window dimensions be customizable on demand #1512

Closed

kciesla93 deleted the floating-nvim-tree-window-#1377 branch August 30, 2022 13:00

alex-courtis mentioned this pull request Oct 4, 2022

feat: add float autoclose option #1621

Merged

Uh oh!

Conversation

kciesla93 commented Jul 25, 2022

Uh oh!

kyazdani42 Jul 25, 2022

Choose a reason for hiding this comment

Uh oh!

alex-courtis Jul 25, 2022

Choose a reason for hiding this comment

Uh oh!

kciesla93 Jul 26, 2022

Choose a reason for hiding this comment

Uh oh!

kyazdani42 commented Jul 25, 2022

Uh oh!

alex-courtis commented Jul 25, 2022

Uh oh!

alex-courtis left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alex-courtis Jul 25, 2022

Choose a reason for hiding this comment

Uh oh!

kyazdani42 commented Jul 26, 2022

Uh oh!

kciesla93 commented Jul 26, 2022

Uh oh!

Uh oh!

kyazdani42 left a comment

Choose a reason for hiding this comment

Uh oh!

alex-courtis left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kciesla93 commented Aug 2, 2022

Uh oh!

alex-courtis commented Aug 2, 2022

Uh oh!

alex-courtis commented Aug 6, 2022

Uh oh!

davidsierradz commented Aug 10, 2022

Uh oh!

alex-courtis commented Aug 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

avalonv commented Aug 21, 2022

Uh oh!

alex-courtis commented Aug 22, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

alex-courtis left a comment •

edited

Loading

alex-courtis left a comment •

edited

Loading

alex-courtis commented Aug 14, 2022 •

edited

Loading