Add dynamic sizing padding options #1941

HendrikPetertje · 2023-01-24T09:15:52Z

with neovim/neovim#20621 merged in it is now possible to fully customize the status-column in nvim (the column on the left containing line-numbers, fold info, signs and borders).

A fair few cool implementations have popped up like:

https://github.com/CKolkey/config/blob/master/nvim/after/plugin/statuscolumn.lua
https://github.com/luukvbaal/statuscol.nvim
and my own personal one (based on CKolkey's fantastic work) https://git.hendrikpeter.net/hendrikpeter/pico-vim/-/blob/main/lua/peva/status_column.lua

The problem with nvim-tree however is that dynamic sizing doesn't take the custom size of a status column into account and the end of file names get clipped off. This little patch should fix that (and give some examples to help other status_column modders get started).

Thanks for looking at this and thanks for making this amazing plugin, I've been using it for a while and I really like it!

Some screenshots:

Before:

After:

with neovim/neovim#20621 merged in it is now possible to fully customize the status-column in nvim (the column on the left containing line-numbers, fold info, signs and borders). A fair few cool implementations have popped up like: - https://github.com/CKolkey/config/blob/master/nvim/after/plugin/statuscolumn.lua - https://github.com/luukvbaal/statuscol.nvim - and my own personal one (based on CKolkey's fantastic work) https://git.hendrikpeter.net/hendrikpeter/pico-vim/-/blob/main/lua/peva/status_column.lua The problem with nvim-tree however is that dynamic sizing doesn't take the custom size of a status column into account and the end of file names get clipped off. This little patch should fix that (and give some examples to help other status_column modders get started). Thanks for looking at this and thanks for making this amazing plugin, I've been using it for a while and I really like it!

HendrikPetertje

Notes from self

HendrikPetertje · 2023-01-24T09:17:10Z

README.md

@@ -74,7 +74,14 @@ require("nvim-tree").setup()
 require("nvim-tree").setup({
  sort_by = "case_sensitive",
  view = {
-    adaptive_size = true,


I noticed that this is now deprecated, so I updated the example code in the README with the new way of working with dynamic sizes and then tacked my padding options on

Thank you. It seems I forgot to update the README... please update to match help

nvim-tree.lua/doc/nvim-tree-lua.txt

Line 82 in 9e87ee2

sort_by = "case_sensitive",

it's only there to provide an example of a simple option to pass to setup.

HendrikPetertje · 2023-01-24T09:17:51Z

doc/nvim-tree-lua.txt

+        *nvim-tree.view.width.padding*
+          dynamic padding when resizing. Useful for custom status-column
+          styles.
+            Type: `number`, Default: `3`


should be the right docs, padding only really supports a number

It can be a function, even if just for the sake of consistency.

You might wish to increase padding as you increase max, to "balance things out".

HendrikPetertje · 2023-01-24T09:18:07Z

lua/nvim-tree/view.lua

@@ -250,7 +251,7 @@ local function grow()
  local starts_at = M.is_root_folder_visible(require("nvim-tree.core").get_cwd()) and 1 or 0
  local lines = vim.api.nvim_buf_get_lines(M.get_bufnr(), starts_at, -1, false)
  -- 1 column of right-padding to indicate end of path
-  local padding = 3
+  local padding = M.View.padding


The big change happens here.

HendrikPetertje · 2023-01-24T09:22:53Z

#1930 might be better than my change here, I'll leave the decision to you. (having both the ability to do a bit of padding and read it dynamically could also be an option, i personally like 2 or 3 columns of space to the right)

alex-courtis · 2023-01-26T00:38:18Z

#1930 might be better than my change here, I'll leave the decision to you. (having both the ability to do a bit of padding and read it dynamically could also be an option, i personally like 2 or 3 columns of space to the right)

We can do both. Padding at the end is quite nice and there's no reason not to make it customisable.

I'd be most grateful if you merged the above branch and we release them as one.

alex-courtis

Please:

allow a padding function
update readme
merge fix-variable-width-sign-number-columns

alex-courtis · 2023-01-26T00:40:15Z

doc/nvim-tree-lua.txt

+        *nvim-tree.view.width.padding*
+          dynamic padding when resizing. Useful for custom status-column
+          styles.
+            Type: `number`, Default: `3`


It can be a function, even if just for the sake of consistency.

You might wish to increase padding as you increase max, to "balance things out".

alex-courtis · 2023-01-26T00:42:55Z

README.md

@@ -74,7 +74,14 @@ require("nvim-tree").setup()
 require("nvim-tree").setup({
  sort_by = "case_sensitive",
  view = {
-    adaptive_size = true,


Thank you. It seems I forgot to update the README... please update to match help

nvim-tree.lua/doc/nvim-tree-lua.txt

Line 82 in 9e87ee2

sort_by = "case_sensitive",

it's only there to provide an example of a simple option to pass to setup.

HendrikPetertje · 2023-01-26T12:48:10Z

Thanks, I'll give this a look and make the corrections after my workday is done!

…-padding-to-dynamic-size # Conflicts: # lua/nvim-tree/view.lua

HendrikPetertje · 2023-01-27T10:55:24Z

That should be it @alex-courtis & @ramezgerges

I think i went through all the todo-items and cleaned things up a bit. I tested the code myself just now and did some experiments with functions and the likes. you can see the first changes here:
5fa504a

and then in the merge commit after that I get rid of the little print() that i had inserted earlier.

alex-courtis

Tested OK

width:
20
min/max 20/25
min/max 20/20

sign:
"no"
"yes:4"

number:
true
false

padding:
0
1
2
function

doc/nvim-tree-lua.txt

alex-courtis · 2023-01-28T03:07:30Z

Many thanks @HendrikPetertje

zhourrr · 2023-01-28T04:26:04Z

Hi all, I want to thank you for this great plugin and merged feature. I notice that when I toggle the file tree, it prints padding as well. Possibly related to this piece of code

It's kind of interrupting the workflow.

dasupradyumna · 2023-01-30T14:16:55Z

lua/nvim-tree/view.lua

+  if type(wininfo) == "table" and type(wininfo[1]) == "table" then
+    padding = padding + wininfo[1].textoff
+  end
+  print(padding)


Please remove this stray debug print statement.
This gives me an extra "Press ENTER or type command to continue" prompt with the padding printed, whenever I toggle Nvim tree window.

Yeah sorry that was my mistake, the problem was fixed a few days ago in master ^_^

gegoune · 2023-01-30T14:21:26Z

That has been fixed on master. Please update.

alex-courtis and others added 2 commits January 21, 2023 16:30

fix: variable width accounts for sign/number columns

a4525d9

HendrikPetertje commented Jan 24, 2023

View reviewed changes

HendrikPetertje mentioned this pull request Jan 24, 2023

fix: variable width accounts for sign/number columns #1930

Closed

alex-courtis requested changes Jan 26, 2023

View reviewed changes

allow padding function, update docs, rollback readme

5fa504a

HendrikPetertje force-pushed the add-custom-padding-to-dynamic-size branch from c04db63 to 5fa504a Compare January 27, 2023 10:37

Merge branch 'fix-variable-width-sign-number-columns' into add-custom…

3f6b10c

…-padding-to-dynamic-size # Conflicts: # lua/nvim-tree/view.lua

HendrikPetertje requested a review from alex-courtis January 27, 2023 11:57

alex-courtis approved these changes Jan 28, 2023

View reviewed changes

doc/nvim-tree-lua.txt Outdated Show resolved Hide resolved

alex-courtis added 2 commits January 28, 2023 14:03

typo in example setup

98becde

help formatting

66ab249

alex-courtis merged commit e05ed6a into nvim-tree:master Jan 28, 2023

dasupradyumna reviewed Jan 30, 2023

View reviewed changes

Uh oh!

Add dynamic sizing padding options #1941

Add dynamic sizing padding options #1941

Uh oh!

Conversation

HendrikPetertje commented Jan 24, 2023

Some screenshots:

Uh oh!

HendrikPetertje left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HendrikPetertje commented Jan 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alex-courtis commented Jan 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HendrikPetertje commented Jan 26, 2023

Uh oh!

HendrikPetertje commented Jan 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alex-courtis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alex-courtis commented Jan 28, 2023

Uh oh!

zhourrr commented Jan 28, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gegoune commented Jan 30, 2023

Uh oh!

Uh oh!

HendrikPetertje commented Jan 24, 2023 •

edited

Loading

alex-courtis commented Jan 26, 2023 •

edited

Loading

alex-courtis left a comment •

edited

Loading

HendrikPetertje commented Jan 27, 2023 •

edited

Loading