[WIP] allow passing a custom function as a window picker

[davidsierradz]

Hi! According to [WIP] allow using the winbar instead of statusbar as a window picker by davidsierradz · Pull Request #1767 · nvim-tree/nvim-tree.lua, this replaces that PR.

With something like:

...
    open_file = {
      window_picker = {
        enable = true,
        custom_function = function()
          return require('window-picker').pick_window({
            selection_chars = '12345',
            use_winbar = 'always',
            filter_rules = {
              bo = {
                filetype = { 'notify', 'packer', 'qf', 'diff', 'fugitive', 'fugitiveblame' },
                buftype = { 'nofile', 'terminal', 'help' },
              },
            },
          })
        end,
      },
  },
...

Let me know what you think, thanks!

[alex-courtis]

Wow! That is clean!

Please add :help and update as per https://github.com/nvim-tree/nvim-tree.lua/blob/master/CONTRIBUTING.md I'm happy to assist with the :help

Please provide an example so that I may test this out and we can add to the :help

[davidsierradz]

Please add :help and update as per https://github.com/nvim-tree/nvim-tree.lua/blob/master/CONTRIBUTING.md I'm happy to assist with the :help

Please provide an example so that I may test this out and we can add to the :help

Thanks, will do!

[davidsierradz]

This function uses vim.ui.select to pick a window (not the best example, but works):

function()
  local window_id
  local window_list = {}
  for _, win in ipairs(vim.api.nvim_list_wins()) do
    if vim.api.nvim_win_get_config(win).relative == '' then
      table.insert(window_list, win)
    end
  end
  vim.ui.select(window_list, {
    prompt = 'Select window:',
  }, function(choice)
    window_id = choice
  end)
  return window_id
end

This one uses s1n7ax/nvim-window-picker:

require('window-picker').setup()

function()
  return require('window-picker').pick_window()
end

[alex-courtis]

This function uses vim.ui.select to pick a window (not the best example, but works):

Fantastic. I'm out of time and will review next weekend.

[alex-courtis]

This works beautifully, and allows full control for the user i.e. ability to pick the nvim-tree window itself.

Please:

• add to :help (I'll help out with this)
• use the s1n7ax/nvim-window-picker example in the help

[alex-courtis]

Many thanks for your contribution.

Your complete example #1782 (comment) would be a fantastic addition to the wiki Recipes