Support show on winbar

[leaxoy]

neovim/neovim#17336 winbar ui has been merged into nightly, it's general to show the gps component, there is vscode example:

and neovim example:

[wookayin]

You can simply configure winbar to use nvim-gps. nvim-gps is a statusline component, so how to use it for winbar, statusline, tabline, etc., is up to users or other plugins.

For example:

_G.gps_location = function()
  local gps = require "nvim-gps"
  return gps.is_available() and gps.get_location() or ""
end
vim.opt.winbar = "%{%v:lua.gps_location()%}"

Or via your favorite statusline/tabline plugin.

[rockyzhang24]

@wookayin Thanks for the code. However, winbar won't be updated automatically like what statusline does when we move cursor, so it seems we need to use autocmd CursorMoved * to update it.

[wookayin]

However, winbar won't be updated automatically as statusline when we move cursor, so it seems we need to use autocmd CursorMoved * to update it.

@rockyzhang24 No, that's not correct and the above code works as you'd expect. Did you try them out?%{...%} expression means that the function will be called whenever needed (including after cursor update). Read the documentation::help statusline

[rockyzhang24]

@wookayin Yes, I know it works as expected and no bugs for statusline. I've been using this plugin for a long time.

Confirmed that this is a bug of the newly added winbar(see this neovim/neovim#17336 (comment)). I already opened an issue in the neovim repo (neovim/neovim#18645)

So far, until this winbar bug is fixed, we should use a piece of code like this:

_G.gps_location = function()
  local gps = require "nvim-gps"
  return gps.is_available() and gps.get_location() or ""
end

vim.opt.winbar = "%{%v:lua.gps_location()%}"

vim.api.nvim_create_autocmd ("CursorMoved", {
  pattern = '*',
  command = "set winbar=%{%v:lua.gps_location()%}",
})

[leaxoy]

Corner case, the winbar always shows even gps is not available.

Correct case

Wrong case

[rockyzhang24]

@leaxoy Use my code above and it works well currently. Because winbar won't be updated when you move your cursor (it's a bug and the PR solving it will be merged soon), thus you need the autocmd to refresh it. When that mentioned issue gets fixed, you can remove the autocmd part.

[emuel-vassallo]

@rockyzhang24 This causes Telescope to turn from looking like the first image to the second. Other than that, it works really great!

[rockyzhang24]

@emuel-vassallo Using the autocmd is just a temporary workaround to solve the winbar update issue I mentioned above and it causes this telescope side effect. Waiting for the fix (neovim/neovim#18646) to be merged, and then the autocmd will not be needed.

[rockyzhang24]

@emuel-vassallo Try to change the autocmd event to CursorHold to avoid it disrupting telescope windows.

[emuel-vassallo]

@emuel-vassallo Try to change the autocmd event to CursorHold to avoid it disrupting telescope windows.

@rockyzhang24 That works, thank you!

[SmiteshP]

Will add instructions in README on how to setup in winbar 👍🏽

[rockyzhang24]

@SmiteshP Great! You can wait until that PR fixing the update bug gets merged.

[max397574]

it's merged

[rockyzhang24]

Great. Then adding gps to winbar is the same with adding it to statusline. It's very handy. And this issue can be closed now.