[{"result":{"data":[{"id":"3284a6f1-12db-412f-b3e5-d4bc4731cea0","title":"feat!: add builtin source for terminal buffers (#78)","text":"feat!: add builtin source for terminal buffers (#78)\n\nallows using the dropdown menu to quickly switch between terminal buffers","type":"breaking-change","createdAt":"2023-09-04T02:13:15.767Z","breakingChange":{"id":41,"postId":"3284a6f1-12db-412f-b3e5-d4bc4731cea0","pluginId":56632,"externalUrl":"https://github.com/Bekaboo/dropbar.nvim/commit/6b88dab5d24b9750f50984e731de9b8bd1fef044","sha":"6b88dab5d24b9750f50984e731de9b8bd1fef044","plugin":{"id":56632,"owner":"Bekaboo","name":"dropbar.nvim","type":"github","source":"awesome-neovim","category":"bars-and-lines","link":"https://github.com/Bekaboo/dropbar.nvim","shortDescription":"IDE-like breadcrumbs, out of the box","createdAt":"2023-06-04T17:40:51.244Z","readme":"

\n dropbar.nvim\n

\n\n

\n IDE-like breadcrumbs, out of the box\n

\n\n

\n \n

\n\n

\n A polished, IDE-like, highly-customizable winbar for Neovim
\n with drop-down menu support and multiple backends\n

\n\n\n- [Features and TODOs](#features-and-todos)\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Configuration](#configuration)\n - [Options](#options)\n - [General](#general)\n - [Icons](#icons)\n - [Symbol](#symbol)\n - [Bar](#bar)\n - [Menu](#menu)\n - [Fzf](#fzf)\n - [Sources](#sources)\n - [Path](#path)\n - [Treesitter](#treesitter)\n - [LSP](#lsp)\n - [Markdown](#markdown)\n - [Terminal](#terminal)\n - [API](#api)\n - [Utility Functions](#utility-functions)\n - [Bar Utility Functions](#bar-utility-functions)\n - [Menu Utility Functions](#menu-utility-functions)\n - [Highlighting](#highlighting)\n- [Developers](#developers)\n - [Architecture](#architecture)\n - [Classes](#classes)\n - [`dropbar_t`](#dropbar_t)\n - [`dropbar_symbol_t`](#dropbar_symbol_t)\n - [`dropbar_menu_t`](#dropbar_menu_t)\n - [`dropbar_menu_entry_t`](#dropbar_menu_entry_t)\n - [`dropbar_menu_hl_info_t`](#dropbar_menu_hl_info_t)\n - [`dropbar_source_t`](#dropbar_source_t)\n - [Making a New Source](#making-a-new-source)\n - [Making a Source With Drop-Down Menus](#making-a-source-with-drop-down-menus)\n - [Default `on_click()` Callback](#default-on_click-callback)\n - [Lazy-Loading Expensive Fields](#lazy-loading-expensive-fields)\n- [Similar Projects](#similar-projects)\n\n\n## Features and TODOs\n\nhttps://github.com/Bekaboo/dropbar.nvim/assets/76579810/e8c1ac26-0321-4762-9975-b20fc3098c5a\n\n- [x] Opening drop-down menus or go to definition with a single mouse click\n\n ![mouse-click](https://github.com/Bekaboo/dropbar.nvim/assets/76579810/25282bf2-c90d-496b-9c37-0cbb6938ff5f)\n\n- [x] Pick mode for quickly selecting a component in the winbar with shortcuts\n\n ![pick-mode](https://github.com/Bekaboo/dropbar.nvim/assets/76579810/6126ceb1-0ad9-468b-89b9-457ce4110999)\n\n- [x] Automatically truncating long components\n\n ![auto-truncate](https://github.com/Bekaboo/dropbar.nvim/assets/76579810/c3b03e7f-d6f7-4c60-9c0d-da038529e1c7)\n\n - [ ] Better truncation when winbar is still too long after shortening\n all components\n\n- [x] Multiple backends that support fall-backs\n\n `dropbar.nvim` comes with five builtin sources:\n\n - [x] [lsp](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/sources/lsp.lua): gets symbols from language servers using nvim's builtin LSP framework\n\n - [x] [markdown](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/sources/markdown.lua): a custom incremental parser that gets symbol information about markdown headings\n\n - [x] [path](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/sources/path.lua): gets current file path\n\n - [x] [treesitter](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/sources/treesitter.lua): gets symbols from treesitter parsers using nvim's builtin treesitter integration\n\n - [x] [terminal](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/sources/terminal.lua): easily switch terminal buffers using the dropdown menu\n\n To make a new source yourself, see [making a new source](#making-a-new-source).\n\n For source fall-backs support, see [bar options](#bar).\n\n- [x] Zero config & Zero dependency\n\n `dropbar.nvim` does not require [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig), [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)\n or any third-party UI libraries to work.\n As long as the language server or the treesitter parser is installed,\n it should work just fine.\n\n Optionally, you can install [telescope-fzf-native](https://github.com/nvim-telescope/telescope-fzf-native.nvim)\n to add fuzzy search support to dropbar menus.\n\n- [x] Drop-down menu components and winbar symbols that response to\n mouse/cursor hovering:\n\n ![hover](https://github.com/Bekaboo/dropbar.nvim/assets/76579810/c944d61c-d39b-42e9-8b24-e3e33672b0d2)\n\n - This features requires `:h mousemoveevent` to be enabled.\n\n- [x] Preview symbols in their source windows when hovering over them in the\n drop-down menu\n\n ![preview](https://github.com/Bekaboo/dropbar.nvim/assets/76579810/93f33b90-4f42-459c-861a-1e70114ba6f2)\n\n- [x] Reorient the source window on previewing or after jumping to a symbol\n\n- [x] Add scrollbar to the menu when the symbol list is too long\n\n ![scrollbar](https://github.com/Bekaboo/dropbar.nvim/assets/76579810/ace94d9a-e850-4a6b-9ab3-51a290e5af32)\n\n- [x] Background color support* thanks [@theofabilous](https://github.com/theofabilous)\n\n ![background-color](https://github.com/Bekaboo/dropbar.nvim/assets/76579810/d7794098-9dcf-459e-9763-8b7d9414e035)\n\n - This is currently an experimental feature that is only available in branch\n [`feat-winbar-background-highlight`](https://github.com/Bekaboo/dropbar.nvim/tree/feat-winbar-background-highlight).\n - To achieve the same effect in branch [`master`](https://github.com/Bekaboo/dropbar.nvim/tree/master), see discussions in [#2](https://github.com/Bekaboo/dropbar.nvim/issues/2)\n\n- [ ] Add preview for symbols shown in the winbar\n\n- [ ] Preview symbols (files) from `path` source\n\n- [ ] Support visual mode selection to select/delete multiple symbols\n\n- [ ] Ability to hide/show the winbar on each window separately\n\n- [ ] Add more tests for the sources `path`, `lsp`, and `treesitter`\n\n- [ ] Configurable scrollbar appearance\n\n- [ ] Update winbar sources dynamically\n\n- [ ] More responsive mouse clicking & hovering in insert (fzf) mode, like\n in normal mode\n\n## Requirements\n\n- Neovim **Nightly** (>= 0.10.0-dev)\n- Optional\n - [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons), if you want to see icons for different filetypes\n - [telescope-fzf-native](https://github.com/nvim-telescope/telescope-fzf-native.nvim), if you want fuzzy search support\n - Working language server installation for the lsp source to work\n - Working treesitter parser installation for the treesitter source to work\n\n## Installation\n\n- Using [lazy.nvim](https://github.com/folke/lazy.nvim)\n\n ```lua\n require('lazy').setup({\n {\n 'Bekaboo/dropbar.nvim',\n -- optional, but required for fuzzy finder support\n dependencies = {\n 'nvim-telescope/telescope-fzf-native.nvim'\n }\n }\n })\n ```\n\n- Using [packer.nvim](https://github.com/wbthomason/packer.nvim)\n\n ```lua\n require('packer').startup(function(use)\n use({\n 'Bekaboo/dropbar.nvim',\n requires = {\n 'nvim-telescope/telescope-fzf-native.nvim'\n }\n })\n end)\n ```\n\n- Using native package manager\n\n ```sh\n mkdir -p ~/.local/share/nvim/site/pack/packages/\n git clone https://github.com/Bekaboo/dropbar.nvim ~/.local/share/nvim/site/pack/packages/start/dropbar.nvim\n ```\n\n Lazy-loading is unneeded as it is already done in [plugin/dropbar.lua](https://github.com/Bekaboo/dropbar.nvim/blob/master/plugin/dropbar.lua).\n\n## Usage\n\n- Basics\n - Moves the cursor around and see the winbar reflects your current context\n- Mouse support\n - Click on a component in the winbar to open a drop-down menu of its\n siblings\n - Click on an entry in the drop-down menu to go to its location\n - Click on the indicator in the drop-down menu to open a sub-menu of its\n children\n- Pick mode\n - Use `require('dropbar.api').pick()` to enter interactive pick mode or\n `require('dropbar.api').pick()` to directly select a component at\n `idx`.\n - Inside interactive pick mode, press the corresponding pivot shown before\n each component to select it\n- Fuzzy finder\n - Use `dropbar_menu_t:fuzzy_find_open()` to interactively\n filter, select and preview entries using fzf\n - ``: exit fzf mode\n - `/`: move the cursor in fzf mode\n - ``: call the on_click callback of the symbol under the cursor\n- Default keymaps in drop-down menu\n - ``: call the `on_click` callback of the symbol at the mouse\n click\n - ``: find the first clickable symbol in the current drop-down menu\n entry and call its `on_click` callback\n - `i`: enter fzf mode from the menu\n - `q`: close current menu\n - To disable, remap or add new keymaps in the drop-down menu, see\n [menu options](#menu)\n\n## Configuration\n\n### Options\n\n

\n A full list of all available options and their default values:\n

\n\n ```lua\n ---@class dropbar_configs_t\n M.opts = {\n general = {\n ---@type boolean|fun(buf: integer, win: integer, info: table?): boolean\n enable = function(buf, win, _)\n return not vim.api.nvim_win_get_config(win).zindex\n and (vim.bo[buf].buftype == '' or vim.bo[buf].buftype == 'terminal')\n and vim.api.nvim_buf_get_name(buf) ~= ''\n and not vim.wo[win].diff\n end,\n attach_events = {\n 'OptionSet',\n 'BufWinEnter',\n 'BufWritePost',\n },\n -- Wait for a short time before updating the winbar, if another update\n -- request is received within this time, the previous request will be\n -- cancelled, this improves the performance when the user is holding\n -- down a key (e.g. 'j') to scroll the window, default to 0 ms\n -- If you encounter performance issues when scrolling the window, try\n -- setting this option to a number slightly larger than\n -- 1000 / key_repeat_rate\n update_interval = 0,\n update_events = {\n win = {\n 'CursorMoved',\n 'CursorMovedI',\n 'WinEnter',\n 'WinResized',\n },\n buf = {\n 'BufModifiedSet',\n 'FileChangedShellPost',\n 'TextChanged',\n 'TextChangedI',\n },\n global = {\n 'DirChanged',\n 'VimResized',\n },\n },\n },\n icons = {\n enable = true,\n kinds = {\n use_devicons = true,\n symbols = {\n Array = '󰅪 ',\n Boolean = ' ',\n BreakStatement = '󰙧 ',\n Call = '󰃷 ',\n CaseStatement = '󱃙 ',\n Class = ' ',\n Color = '󰏘 ',\n Constant = '󰏿 ',\n Constructor = ' ',\n ContinueStatement = '→ ',\n Copilot = ' ',\n Declaration = '󰙠 ',\n Delete = '󰩺 ',\n DoStatement = '󰑖 ',\n Enum = ' ',\n EnumMember = ' ',\n Event = ' ',\n Field = ' ',\n File = '󰈔 ',\n Folder = '󰉋 ',\n ForStatement = '󰑖 ',\n Function = '󰊕 ',\n H1Marker = '󰉫 ', -- Used by markdown treesitter parser\n H2Marker = '󰉬 ',\n H3Marker = '󰉭 ',\n H4Marker = '󰉮 ',\n H5Marker = '󰉯 ',\n H6Marker = '󰉰 ',\n Identifier = '󰀫 ',\n IfStatement = '󰇉 ',\n Interface = ' ',\n Keyword = '󰌋 ',\n List = '󰅪 ',\n Log = '󰦪 ',\n Lsp = ' ',\n Macro = '󰁌 ',\n MarkdownH1 = '󰉫 ', -- Used by builtin markdown source\n MarkdownH2 = '󰉬 ',\n MarkdownH3 = '󰉭 ',\n MarkdownH4 = '󰉮 ',\n MarkdownH5 = '󰉯 ',\n MarkdownH6 = '󰉰 ',\n Method = '󰆧 ',\n Module = '󰏗 ',\n Namespace = '󰅩 ',\n Null = '󰢤 ',\n Number = '󰎠 ',\n Object = '󰅩 ',\n Operator = '󰆕 ',\n Package = '󰆦 ',\n Pair = '󰅪 ',\n Property = ' ',\n Reference = '󰦾 ',\n Regex = ' ',\n Repeat = '󰑖 ',\n Scope = '󰅩 ',\n Snippet = '󰩫 ',\n Specifier = '󰦪 ',\n Statement = '󰅩 ',\n String = '󰉾 ',\n Struct = ' ',\n SwitchStatement = '󰺟 ',\n Terminal = ' ',\n Text = ' ',\n Type = ' ',\n TypeParameter = '󰆩 ',\n Unit = ' ',\n Value = '󰎠 ',\n Variable = '󰀫 ',\n WhileStatement = '󰑖 ',\n },\n },\n ui = {\n bar = {\n separator = ' ',\n extends = '…',\n },\n menu = {\n separator = ' ',\n indicator = ' ',\n },\n },\n },\n symbol = {\n preview = {\n ---Reorient the preview window on previewing a new symbol\n ---@param _ integer source window id, ignored\n ---@param range {start: {line: integer}, end: {line: integer}} 0-indexed\n reorient = function(_, range)\n local invisible = range['end'].line - vim.fn.line('w$') + 1\n if invisible > 0 then\n local view = vim.fn.winsaveview() --[[@as vim.fn.winrestview.dict]]\n view.topline = math.min(\n view.topline + invisible,\n math.max(1, range.start.line - vim.wo.scrolloff + 1)\n )\n vim.fn.winrestview(view)\n end\n end,\n },\n jump = {\n ---@param win integer source window id\n ---@param range {start: {line: integer}, end: {line: integer}} 0-indexed\n reorient = function(win, range)\n local view = vim.fn.winsaveview()\n local win_height = vim.api.nvim_win_get_height(win)\n local topline = range.start.line - math.floor(win_height / 4)\n if\n topline > view.topline\n and topline + win_height < vim.fn.line('$')\n then\n view.topline = topline\n vim.fn.winrestview(view)\n end\n end,\n },\n },\n bar = {\n hover = true,\n ---@type dropbar_source_t[]|fun(buf: integer, win: integer): dropbar_source_t[]\n sources = function(buf, _)\n local sources = require('dropbar.sources')\n if vim.bo[buf].ft == 'markdown' then\n return {\n sources.path,\n sources.markdown,\n }\n end\n if vim.bo[buf].buftype == 'terminal' then\n return {\n sources.terminal,\n }\n end\n return {\n sources.path,\n utils.source.fallback({\n sources.lsp,\n sources.treesitter,\n }),\n }\n end,\n padding = {\n left = 1,\n right = 1,\n },\n pick = {\n pivots = 'abcdefghijklmnopqrstuvwxyz',\n },\n truncate = true,\n },\n menu = {\n -- When on, preview the symbol under the cursor on CursorMoved\n preview = true,\n -- When on, automatically set the cursor to the closest previous/next\n -- clickable component in the direction of cursor movement on CursorMoved\n quick_navigation = true,\n entry = {\n padding = {\n left = 1,\n right = 1,\n },\n },\n ---@type table>\n keymaps = {\n [''] = function()\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n local mouse = vim.fn.getmousepos()\n local clicked_menu = utils.menu.get({ win = mouse.winid })\n -- If clicked on a menu, invoke the corresponding click action,\n -- else close all menus and set the cursor to the clicked window\n if clicked_menu then\n clicked_menu:click_at({ mouse.line, mouse.column - 1 }, nil, 1, 'l')\n return\n end\n utils.menu.exec('close')\n utils.bar.exec('update_current_context_hl')\n if vim.api.nvim_win_is_valid(mouse.winid) then\n vim.api.nvim_set_current_win(mouse.winid)\n end\n end,\n [''] = function()\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n local cursor = vim.api.nvim_win_get_cursor(menu.win)\n local component = menu.entries[cursor[1]]:first_clickable(cursor[2])\n if component then\n menu:click_on(component, nil, 1, 'l')\n end\n end,\n [''] = function()\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n local mouse = vim.fn.getmousepos()\n utils.menu.update_hover_hl(mouse)\n if M.opts.menu.preview then\n utils.menu.update_preview(mouse)\n end\n end,\n ['i'] = function()\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n menu:fuzzy_find_open()\n end,\n ['q'] = function()\n local menu = utils.menu.get_current()\n if menu then\n menu:close()\n end\n end\n },\n ---@alias dropbar_menu_win_config_opts_t any|fun(menu: dropbar_menu_t):any\n ---@type table\n ---@see vim.api.nvim_open_win\n win_configs = {\n border = 'none',\n style = 'minimal',\n row = function(menu)\n return menu.prev_menu\n and menu.prev_menu.clicked_at\n and menu.prev_menu.clicked_at[1] - vim.fn.line('w0')\n or 0\n end,\n ---@param menu dropbar_menu_t\n col = function(menu)\n if menu.prev_menu then\n return menu.prev_menu._win_configs.width\n + (menu.prev_menu.scrollbar and 1 or 0)\n end\n local mouse = vim.fn.getmousepos()\n local bar = utils.bar.get({ win = menu.prev_win })\n if not bar then\n return mouse.wincol\n end\n local _, range = bar:get_component_at(math.max(0, mouse.wincol - 1))\n return range and range.start or mouse.wincol\n end,\n relative = 'win',\n win = function(menu)\n return menu.prev_menu and menu.prev_menu.win\n or vim.fn.getmousepos().winid\n end,\n height = function(menu)\n return math.max(\n 1,\n math.min(\n #menu.entries,\n vim.go.pumheight ~= 0 and vim.go.pumheight\n or math.ceil(vim.go.lines / 4)\n )\n )\n end,\n width = function(menu)\n local min_width = vim.go.pumwidth ~= 0 and vim.go.pumwidth or 8\n if vim.tbl_isempty(menu.entries) then\n return min_width\n end\n return math.max(\n min_width,\n math.max(unpack(vim.tbl_map(function(entry)\n return entry:displaywidth()\n end, menu.entries)))\n )\n end,\n },\n },\n fzf = {\n ---@type table\n keymaps = {\n [''] = function()\n ---@type dropbar_menu_t\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n local mouse = vim.fn.getmousepos()\n if not mouse then\n return\n end\n if mouse.winid ~= menu.win then\n local default_func = M.opts.menu.keymaps['']\n if type(default_func) == 'function' then\n default_func()\n end\n menu:fuzzy_find_close()\n return\n elseif mouse.winrow > vim.api.nvim_buf_line_count(menu.buf) then\n return\n end\n vim.api.nvim_win_set_cursor(menu.win, { mouse.line, mouse.column - 1 })\n menu:fuzzy_find_click_on_entry(function(entry)\n return entry:get_component_at(mouse.column - 1, true)\n end)\n end,\n [''] = function()\n ---@type dropbar_menu_t\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n local mouse = vim.fn.getmousepos()\n if not mouse then\n return\n end\n -- If mouse is not in the menu window or on the border, end preview\n -- and clear hover highlights\n if\n mouse.winid ~= menu.win\n or mouse.line <= 0\n or mouse.column <= 0\n or mouse.winrow > (#menu.entries + 1)\n then\n -- Find the root menu\n while menu and menu.prev_menu do\n menu = menu.prev_menu\n end\n if menu then\n menu:finish_preview(true)\n menu:update_hover_hl()\n end\n return\n end\n if M.opts.menu.preview then\n menu:preview_symbol_at({ mouse.line, mouse.column - 1 }, true)\n end\n menu:update_hover_hl({ mouse.line, mouse.column - 1 })\n end,\n [''] = function()\n api.fuzzy_find_toggle()\n end,\n [''] = function()\n api.fuzzy_find_click()\n end,\n [''] = function()\n api.fuzzy_find_click(-1)\n end,\n [''] = function()\n api.fuzzy_find_navigate('up')\n end,\n [''] = function()\n api.fuzzy_find_navigate('down')\n end,\n [''] = function()\n api.fuzzy_find_navigate('up')\n end,\n [''] = function()\n api.fuzzy_find_navigate('down')\n end,\n },\n win_configs = {},\n prompt = '%#htmlTag# ',\n char_pattern = '[%w%p]',\n retain_inner_spaces = true,\n fuzzy_find_on_click = true,\n },\n sources = {\n path = {\n ---@type string|fun(buf: integer, win: integer): string\n relative_to = function(_, win)\n -- Workaround for Vim:E5002: Cannot find window number\n local ok, cwd = pcall(vim.fn.getcwd, win)\n return ok and cwd or vim.fn.getcwd()\n end,\n ---Can be used to filter out files or directories\n ---based on their name\n ---@type fun(name: string): boolean\n filter = function(_)\n return true\n end,\n ---Last symbol from path source when current buf is modified\n ---@param sym dropbar_symbol_t\n ---@return dropbar_symbol_t\n modified = function(sym)\n return sym\n end,\n },\n treesitter = {\n -- Lua pattern used to extract a short name from the node text\n name_pattern = '[#~%*%w%._%->!@:]+%s*'\n .. string.rep('[#~%*%w%._%->!@:]*', 3, '%s*'),\n -- The order matters! The first match is used as the type\n -- of the treesitter symbol and used to show the icon\n -- Types listed below must have corresponding icons\n -- in the `icons.kinds.symbols` table for the icon to be shown\n valid_types = {\n 'array',\n 'boolean',\n 'break_statement',\n 'call',\n 'case_statement',\n 'class',\n 'constant',\n 'constructor',\n 'continue_statement',\n 'delete',\n 'do_statement',\n 'enum',\n 'enum_member',\n 'event',\n 'for_statement',\n 'function',\n 'h1_marker',\n 'h2_marker',\n 'h3_marker',\n 'h4_marker',\n 'h5_marker',\n 'h6_marker',\n 'if_statement',\n 'interface',\n 'keyword',\n 'list',\n 'macro',\n 'method',\n 'module',\n 'namespace',\n 'null',\n 'number',\n 'operator',\n 'package',\n 'pair',\n 'property',\n 'reference',\n 'repeat',\n 'scope',\n 'specifier',\n 'string',\n 'struct',\n 'switch_statement',\n 'type',\n 'type_parameter',\n 'unit',\n 'value',\n 'variable',\n 'while_statement',\n 'declaration',\n 'field',\n 'identifier',\n 'object',\n 'statement',\n 'text',\n },\n },\n lsp = {\n request = {\n -- Times to retry a request before giving up\n ttl_init = 60,\n interval = 1000, -- in ms\n },\n },\n markdown = {\n parse = {\n -- Number of lines to update when cursor moves out of the parsed range\n look_ahead = 200,\n },\n },\n terminal = {\n ---@type string|fun(buf: integer): string\n icon = function(buf)\n local icon = M.opts.icons.kinds.symbols.Terminal\n if M.opts.icons.kinds.use_devicons then\n icon = require('nvim-web-devicons').get_icon_by_filetype(\n vim.bo[buf].filetype\n ) or icon\n end\n return icon\n end,\n ---@type string|fun(buf: integer): string\n name = vim.api.nvim_buf_get_name,\n ---@type boolean\n ---Show the current terminal buffer in the menu\n show_current = true,\n },\n },\n }\n ```\n\n

\n\n#### General\n\nThese options live under `opts.general` and are used to configure the\ngeneral behavior of the plugin:\n\n- `opts.general.enable`: `boolean|fun(buf: integer, win: integer): boolean`\n - Controls whether to enable the plugin for the current buffer and window\n - If a function is provided, it will be called with the current bufnr and\n winid and should return a boolean\n - Default:\n ```lua\n function(buf, win)\n return not vim.api.nvim_win_get_config(win).zindex\n and vim.bo[buf].buftype == ''\n and vim.api.nvim_buf_get_name(buf) ~= ''\n and not vim.wo[win].diff\n end\n ```\n- `opts.general.attach_events`: `string[]`\n - Controls when to evaluate the `enable()` function and attach the plugin\n to corresponding buffer or window\n - Default:\n ```lua\n {\n 'OptionSet',\n 'BufWinEnter',\n 'BufWritePost',\n }\n ```\n- `opts.general.update_interval`: `number`\n - Wait for a short time before updating the winbar, if another update\n request is received within this time, the previous request will be\n cancelled, this improves the performance when the user is holding\n down a key (e.g. `'j'`) to scroll the window\n - If you encounter performance issues when scrolling the window, try\n setting this option to a number slightly larger than\n `1000 / key_repeat_rate`\n - Default: `0`\n- `opts.general.update_events.win`: `string[]`\n - List of events that should trigger an update on the dropbar attached to\n a single window\n - Default:\n ```lua\n {\n 'CursorMoved',\n 'CursorMovedI',\n 'WinEnter',\n 'WinResized',\n }\n ```\n- `opts.general.update_events.buf`: `string[]`\n - List of events that should trigger an update on all dropbars attached to a\n buffer\n - Default:\n ```lua\n {\n 'BufModifiedSet',\n 'FileChangedShellPost',\n 'TextChanged',\n 'TextChangedI',\n }\n ```\n- `opts.general.update_events.global`: `string[]`\n - List of events that should trigger an update of all dropbars in current\n nvim session\n - Default:\n ```lua\n {\n 'DirChanged',\n 'VimResized',\n }\n ```\n\n#### Icons\n\nThese options live under `opts.icons` and are used to configure the icons\nused by the plugin:\n\n- `opts.icons.enable`: `boolean`\n - Whether to enable icons\n - Default: `true`\n- `opts.icons.kinds.use_devicons`: `boolean`\n - Whether to use [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) to show icons for different filetypes\n - Default: `true`\n- `opts.icons.kinds.symbols`: `table`\n - Table mapping the different kinds of symbols to their corresponding icons\n - Default:\n ```lua\n {\n Array = '󰅪 ',\n Boolean = ' ',\n BreakStatement = '󰙧 ',\n Call = '󰃷 ',\n CaseStatement = '󱃙 ',\n Class = ' ',\n Color = '󰏘 ',\n Constant = '󰏿 ',\n Constructor = ' ',\n ContinueStatement = '→ ',\n Copilot = ' ',\n Declaration = '󰙠 ',\n Delete = '󰩺 ',\n DoStatement = '󰑖 ',\n Enum = ' ',\n EnumMember = ' ',\n Event = ' ',\n Field = ' ',\n File = '󰈔 ',\n Folder = '󰉋 ',\n ForStatement = '󰑖 ',\n Function = '󰊕 ',\n H1Marker = '󰉫 ', -- Used by markdown treesitter parser\n H2Marker = '󰉬 ',\n H3Marker = '󰉭 ',\n H4Marker = '󰉮 ',\n H5Marker = '󰉯 ',\n H6Marker = '󰉰 ',\n Identifier = '󰀫 ',\n IfStatement = '󰇉 ',\n Interface = ' ',\n Keyword = '󰌋 ',\n List = '󰅪 ',\n Log = '󰦪 ',\n Lsp = ' ',\n Macro = '󰁌 ',\n MarkdownH1 = '󰉫 ', -- Used by builtin markdown source\n MarkdownH2 = '󰉬 ',\n MarkdownH3 = '󰉭 ',\n MarkdownH4 = '󰉮 ',\n MarkdownH5 = '󰉯 ',\n MarkdownH6 = '󰉰 ',\n Method = '󰆧 ',\n Module = '󰏗 ',\n Namespace = '󰅩 ',\n Null = '󰢤 ',\n Number = '󰎠 ',\n Object = '󰅩 ',\n Operator = '󰆕 ',\n Package = '󰆦 ',\n Pair = '󰅪 ',\n Property = ' ',\n Reference = '󰦾 ',\n Regex = ' ',\n Repeat = '󰑖 ',\n Scope = '󰅩 ',\n Snippet = '󰩫 ',\n Specifier = '󰦪 ',\n Statement = '󰅩 ',\n String = '󰉾 ',\n Struct = ' ',\n SwitchStatement = '󰺟 ',\n Terminal = ' ',\n Text = ' ',\n Type = ' ',\n TypeParameter = '󰆩 ',\n Unit = ' ',\n Value = '󰎠 ',\n Variable = '󰀫 ',\n WhileStatement = '󰑖 ',\n }\n ```\n- `opts.icons.ui.bar`: `table`\n - Controls the icons used in the winbar UI\n - Default:\n ```lua\n {\n separator = ' ',\n extends = '…',\n }\n ```\n- `opts.icons.ui.menu`: `table`\n - Controls the icons used in the menu UI\n - Default:\n ```lua\n {\n separator = ' ',\n indicator = ' ',\n }\n ```\n#### Symbol\n\nThese options live under `opts.symbol` and are used to control the behavior of\nthe symbols:\n\n- `opts.symbol.preview.reorient`: `fun(win: integer, range: {start: {line: integer, character: integer}, end: {line: integer, character: integer}})`\n - Function to reorient the source window when previewing symbol given\n the source window `win` and the range of the symbol `range`\n - Default:\n ```lua\n function(_, range)\n local invisible = range['end'].line - vim.fn.line('w$') + 1\n if invisible > 0 then\n local view = vim.fn.winsaveview() --[[@as vim.fn.winrestview.dict]]\n view.topline = math.min(\n view.topline + invisible,\n math.max(1, range.start.line - vim.wo.scrolloff + 1)\n )\n vim.fn.winrestview(view)\n end\n end\n ```\n- `opts.symbol.jump.reorient`: `fun(win: integer, range: {start: {line: integer, character: integer}, end: {line: integer, character: integer}})`\n- Function to reorient the source window after jumping to symbol given\n the source window `win` and the range of the symbol `range`\n- Default:\n ```lua\n function(win, range)\n local view = vim.fn.winsaveview()\n local win_height = vim.api.nvim_win_get_height(win)\n local topline = range.start.line - math.floor(win_height / 4)\n if\n topline > view.topline\n and topline + win_height < vim.fn.line('$')\n then\n view.topline = topline\n vim.fn.winrestview(view)\n end\n end\n ```\n\n#### Bar\n\nThese options live under `opts.bar` and are used to control the behavior of the\nwinbar:\n\n- `opts.bar.hover`: `boolean`\n - Whether to highlight the symbol under the cursor\n - This feature requires `'mousemoveevent'` to be enabled\n - Default: `true`\n- `opts.bar.sources`: `dropbar_source_t[]|fun(buf: integer, win: integer): dropbar_source_t[]`\n - List of sources to show in the winbar\n - If a function is provided, it will be called with the current bufnr and\n winid and should return a list of sources\n - Default:\n ```lua\n function(buf, _)\n local sources = require('dropbar.sources')\n local utils = require('dropbar.utils')\n if vim.bo[buf].ft == 'markdown' then\n return {\n sources.path,\n sources.markdown,\n }\n end\n if vim.bo[buf].buftype == 'terminal' then\n return {\n sources.terminal,\n }\n end\n return {\n sources.path,\n utils.source.fallback({\n sources.lsp,\n sources.treesitter,\n }),\n }\n end\n ```\n - For more information about sources, see [`dropbar_source_t`](#dropbar_source_t).\n- `opts.bar.padding`: `{ left: number, right: number }`\n - Padding to use between the winbar and the window border\n - Default: `{ left = 1, right = 1 }`\n- `opts.bar.pick.pivots`: `string`\n - Pivots to use in pick mode\n - Default: `'abcdefghijklmnopqrstuvwxyz'`\n- `opts.bar.truncate`: `boolean`\n - Whether to truncate the winbar if it doesn't fit in the window\n - Default: `true`\n\n#### Menu\n\nThese options live under `opts.menu` and are used to control the behavior of the\nmenu:\n\n- `opts.menu.quick_navigation`: `boolean`\n - When on, automatically set the cursor to the closest previous/next\n clickable component in the direction of cursor movement on `CursorMoved`\n - Default: `true`\n- `opts.menu.entry.padding`: `{ left: number, right: number }`\n - Padding to use between the menu entry and the menu border\n - Default: `{ left = 1, right = 1 }`\n- `opts.menu.preview`: `boolean`\n - Whether to enable previewing for menu entries\n - Default: `true`\n- `opts.menu.keymaps`: `table|table>`\n - Buffer-local keymaps in the menu\n - Use ` = ` to map a key in normal mode and visual mode\n in the menu buffer, or use ` = table` to map\n a key in specific modes.\n - Default:\n ```lua\n {\n [''] = function()\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n local mouse = vim.fn.getmousepos()\n local clicked_menu = utils.menu.get({ win = mouse.winid })\n -- If clicked on a menu, invoke the corresponding click action,\n -- else close all menus and set the cursor to the clicked window\n if clicked_menu then\n clicked_menu:click_at({ mouse.line, mouse.column - 1 }, nil, 1, 'l')\n return\n end\n utils.menu.exec('close')\n utils.bar.exec('update_current_context_hl')\n if vim.api.nvim_win_is_valid(mouse.winid) then\n vim.api.nvim_set_current_win(mouse.winid)\n end\n end,\n [''] = function()\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n local cursor = vim.api.nvim_win_get_cursor(menu.win)\n local component = menu.entries[cursor[1]]:first_clickable(cursor[2])\n if component then\n menu:click_on(component, nil, 1, 'l')\n end\n end,\n [''] = function()\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n local mouse = vim.fn.getmousepos()\n utils.menu.update_hover_hl(mouse)\n if M.opts.menu.preview then\n utils.menu.update_preview(mouse)\n end\n end,\n ['i'] = function()\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n menu:fuzzy_find_open()\n end,\n ['q'] = function()\n local menu = utils.menu.get_current()\n if menu then\n menu:close()\n end\n end\n },\n ```\n- `opts.menu.win_configs`: `table`\n - Window configurations for the menu, see `:h nvim_open_win()`\n - Each config key in `opts.menu.win_configs` accepts either a plain value\n which will be passes directly to `nvim_open_win()`, or a function that\n takes the current menu (see [`dropbar_menu_t`](#dropbar_menu_t)) as an\n argument and returns a value to be passed to `nvim_open_win()`.\n - Default:\n ```lua\n {\n border = 'none',\n style = 'minimal',\n row = function(menu)\n return menu.prev_menu\n and menu.prev_menu.clicked_at\n and menu.prev_menu.clicked_at[1] - vim.fn.line('w0')\n or 0\n end,\n ---@param menu dropbar_menu_t\n col = function(menu)\n if menu.prev_menu then\n return menu.prev_menu._win_configs.width\n + (menu.prev_menu.scrollbar and 1 or 0)\n end\n local mouse = vim.fn.getmousepos()\n local bar = require('dropbar.api').get_dropbar(\n vim.api.nvim_win_get_buf(menu.prev_win),\n menu.prev_win\n )\n if not bar then\n return mouse.wincol\n end\n local _, range = bar:get_component_at(math.max(0, mouse.wincol - 1))\n return range and range.start or mouse.wincol\n end,\n relative = 'win',\n win = function(menu)\n return menu.prev_menu and menu.prev_menu.win\n or vim.fn.getmousepos().winid\n end,\n height = function(menu)\n return math.max(\n 1,\n math.min(\n #menu.entries,\n vim.go.pumheight ~= 0 and vim.go.pumheight\n or math.ceil(vim.go.lines / 4)\n )\n )\n end,\n width = function(menu)\n local min_width = vim.go.pumwidth ~= 0 and vim.go.pumwidth or 8\n if vim.tbl_isempty(menu.entries) then\n return min_width\n end\n return math.max(\n min_width,\n math.max(unpack(vim.tbl_map(function(entry)\n return entry:displaywidth()\n end, menu.entries)))\n )\n end,\n }\n ```\n\n#### Fzf\n\nThese options live under `opts.fzf` and are used to control the behavior and\nappearance of the fuzzy finder interface.\n\n- `opts.fzf.keymaps`\n - The keymaps that will apply in insert mode, in the fzf prompt buffer\n - Same config as opts.menu.keymaps\n - Default:\n ```lua\n keymaps = {\n [''] = function()\n ---@type dropbar_menu_t\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n local mouse = vim.fn.getmousepos()\n if not mouse then\n return\n end\n if mouse.winid ~= menu.win then\n local default_func = M.opts.menu.keymaps['']\n if type(default_func) == 'function' then\n default_func()\n end\n menu:fuzzy_find_close(false)\n return\n elseif mouse.winrow > vim.api.nvim_buf_line_count(menu.buf) then\n return\n end\n vim.api.nvim_win_set_cursor(menu.win, { mouse.line, mouse.column - 1 })\n menu:fuzzy_find_click_on_entry(function(entry)\n return entry:get_component_at(mouse.column - 1, true)\n end)\n end,\n [''] = function()\n ---@type dropbar_menu_t\n local menu = utils.menu.get_current()\n if not menu then\n return\n end\n local mouse = vim.fn.getmousepos()\n if not mouse then\n return\n end\n -- If mouse is not in the menu window or on the border, end preview\n -- and clear hover highlights\n if\n mouse.winid ~= menu.win\n or mouse.line <= 0\n or mouse.column <= 0\n or mouse.winrow > #menu.entries\n then\n -- Find the root menu\n while menu and menu.prev_menu do\n menu = menu.prev_menu\n end\n if menu then\n menu:finish_preview(true)\n menu:update_hover_hl()\n end\n return\n end\n if M.opts.menu.preview then\n menu:preview_symbol_at({ mouse.line, mouse.column - 1 }, true)\n end\n menu:update_hover_hl({ mouse.line, mouse.column - 1 })\n end,\n [''] = function()\n require('dropbar.api').fuzzy_find_toggle()\n end,\n [''] = function()\n require('dropbar.api').fuzzy_find_click()\n end,\n [''] = function()\n require('dropbar.api').fuzzy_find_click(-1)\n end,\n [''] = function()\n require('dropbar.api').fuzzy_find_navigate('up')\n end,\n [''] = function()\n require('dropbar.api').fuzzy_find_navigate('down')\n end,\n [''] = function()\n require('dropbar.api').fuzzy_find_navigate('up')\n end,\n [''] = function()\n require('dropbar.api').fuzzy_find_navigate('down')\n end,\n }\n ```\n\n- `opts.fzf.win_configs`\n - Options passed to `:h nvim_open_win`. The fuzzy finder will use its\n parent window's config by default, but options set here will override those.\n - Same config as opts.menu.win_configs\n - Default:\n ```lua\n win_configs = {}\n ```\n\n- `opts.fzf.prompt`\n - Prompt string that will be displayed in the statuscolumn of the fzf input window.\n - Can include highlight groups\n - Default:\n ```lua\n prompt = '%#htmlTag# '\n ```\n\n- `opts.fzf.char_pattern`\n - Default:\n ```lua\n char_pattern = '[%w%p]'\n ```\n\n- `opts.fzf.retain_inner_spaces`\n - Default:\n ```lua\n retain_inner_spaces = true\n ```\n\n- `opts.fzf.fuzzy_find_on_click`\n - When opening an entry with a submenu via the fuzzy finder,\n open the submenu in fuzzy finder mode.\n - Default:\n ```lua\n fuzzy_find_on_click = true\n ```\n\n#### Sources\n\nThese options live under `opts.sources` and are used to control the behavior of\neach sources.\n\n##### Path\n\n- `opts.sources.path.relative_to`: `string|fun(buf: integer, win: integer): string`\n - The path to use as the root of the relative path\n - If a function is provided, it will be called with the current buffer number\n and window id as arguments and should return a string to be used as the\n root of the relative path\n - Notice: currently does not support `..` relative paths\n - Default:\n ```lua\n function(_, win)\n -- Workaround for Vim:E5002: Cannot find window number\n local ok, cwd = pcall(vim.fn.getcwd, win)\n return ok and cwd or vim.fn.getcwd()\n end\n ```\n- `opts.sources.path.filter`: `function(name: string): boolean`\n - A function that takes a file name and returns whether to include it in the\n results shown in the drop-down menu\n - Default:\n ```lua\n function(_)\n return true\n end\n ```\n- `opts.sources.path.modified`: `function(sym: dropbar_symbol_t): dropbar_symbol_t`\n - A function that takes the last\n symbol_{[`dropbar_symbol_t`](#dropbar_symbol_t)} in the result got\n from the path source and returns an alternative\n symbol_{[`dropbar_symbol_t`](#dropbar_symbol_t)} to show if the\n current buffer is modified\n - Default:\n ```lua\n function(sym)\n return sym\n end\n ```\n - To set a different icon, name, or highlights when the buffer is modified,\n you can change the corresponding fields in the returned\n symbol_{[`dropbar_symbol_t`](#dropbar_symbol_t)}\n ```lua\n function(sym)\n return sym:merge({\n name = sym.name .. '[+]',\n icon = ' ',\n name_hl = 'DiffAdded',\n icon_hl = 'DiffAdded',\n -- ...\n })\n end\n ```\n\n##### Treesitter\n\n- `opts.sources.treesitter.name_pattern`: `string`\n - Lua pattern used to extract a short name from the node text\n - Default: `'[#~%*%w%._%->!@:]+%s*' .. string.rep('[#~%*%w%._%->!@:]*', 3, '%s*')`\n- `opts.sources.treesitter.valid_types:` `string[]`\n - A list of treesitter node types to include in the results\n - Default:\n ```lua\n {\n 'array',\n 'boolean',\n 'break_statement',\n 'call',\n 'case_statement',\n 'class',\n 'constant',\n 'constructor',\n 'continue_statement',\n 'delete',\n 'do_statement',\n 'enum',\n 'enum_member',\n 'event',\n 'for_statement',\n 'function',\n 'h1_marker',\n 'h2_marker',\n 'h3_marker',\n 'h4_marker',\n 'h5_marker',\n 'h6_marker',\n 'if_statement',\n 'interface',\n 'keyword',\n 'list',\n 'macro',\n 'method',\n 'module',\n 'namespace',\n 'null',\n 'number',\n 'operator',\n 'package',\n 'pair',\n 'property',\n 'reference',\n 'repeat',\n 'scope',\n 'specifier',\n 'string',\n 'struct',\n 'switch_statement',\n 'type',\n 'type_parameter',\n 'unit',\n 'value',\n 'variable',\n 'while_statement',\n 'declaration',\n 'field',\n 'identifier',\n 'object',\n 'statement',\n 'text',\n }\n ```\n\n##### LSP\n\n- `opts.sources.lsp.request.ttl_init`: `number`\n - Number of times to retry a request before giving up\n - Default: `60`\n- `opts.sources.lsp.request.interval`: `number`\n - Number of milliseconds to wait between retries\n - Default: `1000`\n\n##### Markdown\n\n- `opts.sources.markdown.parse.look_ahead`: `number`\n - Number of lines to update when cursor moves out of the parsed range\n - Default: `200`\n\n##### Terminal\n\nThanks [@willothy](https://github.com/willothy) for implementing this.\n\n- `opts.sources.terminal.icon`: `string` or `fun(buf: integer): string`\n - Icon to show before terminal names\n - Default:\n ```lua\n icon = function(buf)\n local icon = M.opts.icons.kinds.symbols.Terminal\n if M.opts.icons.kinds.use_devicons then\n icon = require('nvim-web-devicons').get_icon_by_filetype(\n vim.bo[buf].filetype\n ) or icon\n end\n return icon\n end\n ```\n\n- `opts.sources.terminal.name`: `string` or `fun(buf: integer): string`\n - Easy to integrate with other plugins (for example, [toggleterm.nvim](https://github.com/akinsho/toggleterm.nvim)):\n ```lua\n name = function(buf)\n local name = vim.api.nvim_buf_get_name(buf)\n -- the second result val is the terminal object\n local term = select(2, require(\"toggleterm.terminal\").indentify(name))\n if term then\n return term.display_name or term.name\n else\n return name\n end\n end\n ```\n - Default: `vim.api.nvim_buf_get_name`\n\n- `opts.sources.terminal.show_current: boolean`\n - Show the current terminal buffer in the menu\n - Default: `true`\n\n### API\n\n`dropbar.nvim` exposes a few functions in `lua/dropbar/api.lua` that can be\nused to interact with the winbar or the drop-down menu:\n\n- ~~`get_dropbar(buf: integer?, win: integer): dropbar_t?`~~\n prefer [`utils.bar.get()`](#bar-utility-functions)\n - Get the dropbar associated with the given buffer and window\n - For more information about the `dropbar_t` type, see\n [`dropbar_t`](#dropbar_t)\n- ~~`get_current_dropbar(): dropbar_t?`~~\n prefer [`utils.bar.get_current()`](#bar-utility-functions)\n - Get the dropbar associated with the current buffer and window\n- ~~`get_dropbar_menu(win: integer): dropbar_menu_t?`~~\n prefer [`utils.menu.get()`](#menu-utility-functions)\n - Get the drop-down menu associated with the given window\n - For more information about the `dropbar_menu_t` type, see\n [`dropbar_menu_t`](#dropbar_menu_t)\n- ~~`get_current_dropbr_menu(): dropbar_menu_t?`~~\n prefer [`utils.menu.get_current()`](#menu-utility-functions)\n - Get the drop-down menu associated with the current window\n- `goto_context_start(count: integer?)`\n - Move the cursor to the start of the current context\n - If `count` is 0 or `nil`, go to the start of current context, or the start\n at previous context if cursor is already at the start of current context\n - If `count` is positive, goto the start of `count` previous context\n- `select_next_context()`\n - Open the menu of current context to select the next context\n- `pick(idx: integer?)`\n - Pick a component from current winbar\n - If `idx` is `nil`, enter interactive pick mode to select a component\n - If `idx` is a number, directly pick the component at that index if it exists\n- `fuzzy_find_toggle(opts: table?)`\n - Toggle the fuzzy finder interface for the current dropbar menu\n - Options override the default / config options for the fuzzy finder\n- `fuzzy_find_click(component: number | (fun(entry: dropbar_menu_entry_t):dropbar_sumbol_t)?)`\n - If `component` is a `number`, the `component`-nth symbol is selected,\n unless `0` or `-1` is supplied, in which case the *first* or *last*\n clickable component is selected, respectively.\n - If it is a `function`, it receives the `dropbar_menu_entry_t` as an argument\n and should return the `dropbar_symbol_t` that is to be clicked.\n- `fuzzy_find_navigate(direction: \"up\" | \"down\")`\n - Select the previous/next entry in the menu while fuzzy finding\n\n### Utility Functions\n\nHere are some utility functions that can be handy when writing your customize\nyour config:\n\n#### Bar Utility Functions\n\nDefined in [`lua/dropbar/utils/bar.lua`](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/utils/bar.lua).\n\n- `utils.bar.get(opts?): (dropbar_t?)|table|table>`\n - Get the dropbar(s) associated with the given buffer and window\n - If only `opts.win` is specified, return the dropbar attached the window;\n - If only `opts.buf` is specified, return all dropbars attached the buffer;\n - If both `opts.win` and `opts.buf` are specified, return the dropbar\n attached the window that contains the buffer;\n - If neither `opts.win` nor `opts.buf` is specified, return all dropbars in\n the form of `table>`\n- `utils.bar.get_current(): dropbar_t?`\n - Get the dropbar associated with the current buffer and window\n\n#### Menu Utility Functions\n\nDefined in [`lua/dropbar/utils/menu.lua`](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/utils/menu.lua).\n\n- `utils.menu.get(opts): (dropbar_menu_t?)|table`\n - Get dropbar menu\n - If `opts.win` is specified, return the dropbar menu attached the window;\n - If `opts.win` is not specified, return all opened dropbar menus\n- `utils.menu.get_current(): dropbar_menu_t?`\n - Get current dropbar menu\n\n### Highlighting\n\n`dropbar.nvim` defines the following highlight groups that, override them in\nyour colorscheme to change the appearance of the drop-down menu, the names\nshould be self-explanatory:\n\n

Highlight groups

\n\n | Highlight group | Attributes |\n |----------------------------------|-----------------------------------------|\n | DropBarCurrentContext | `{ link = 'Visual' }` |\n | DropBarFzfMatch | `{ link = 'TelescopeMatching' }` |\n | DropBarHover | `{ link = 'Visual' }` |\n | DropBarIconCurrentContext | `{ link = 'Visual' }` |\n | DropBarIconKindArray | `{ link = 'Array' }` |\n | DropBarIconKindBoolean | `{ link = 'Boolean' }` |\n | DropBarIconKindBreakStatement | `{ link = 'Error' }` |\n | DropBarIconKindCall | `{ link = 'Function' }` |\n | DropBarIconKindCaseStatement | `{ link = 'Conditional' }` |\n | DropBarIconKindClass | `{ link = 'CmpItemKindClass' }` |\n | DropBarIconKindConstant | `{ link = 'Constant' }` |\n | DropBarIconKindConstructor | `{ link = 'CmpItemKindConstructor' }` |\n | DropBarIconKindContinueStatement | `{ link = 'Repeat' }` |\n | DropBarIconKindDeclaration | `{ link = 'CmpItemKindSnippet' }` |\n | DropBarIconKindDelete | `{ link = 'Error' }` |\n | DropBarIconKindDoStatement | `{ link = 'Repeat' }` |\n | DropBarIconKindElseStatement | `{ link = 'Conditional' }` |\n | DropBarIconKindEnum | `{ link = 'CmpItemKindEnum' }` |\n | DropBarIconKindEnumMember | `{ link = 'CmpItemKindEnumMember' }` |\n | DropBarIconKindEvent | `{ link = 'CmpItemKindEvent' }` |\n | DropBarIconKindField | `{ link = 'CmpItemKindField' }` |\n | DropBarIconKindFile | `{ link = 'NormalFloat' }` |\n | DropBarIconKindFolder | `{ link = 'Directory' }` |\n | DropBarIconKindForStatement | `{ link = 'Repeat' }` |\n | DropBarIconKindFunction | `{ link = 'Function' }` |\n | DropBarIconKindH1Marker | `{ link = 'markdownH1' }` |\n | DropBarIconKindH2Marker | `{ link = 'markdownH2' }` |\n | DropBarIconKindH3Marker | `{ link = 'markdownH3' }` |\n | DropBarIconKindH4Marker | `{ link = 'markdownH4' }` |\n | DropBarIconKindH5Marker | `{ link = 'markdownH5' }` |\n | DropBarIconKindH6Marker | `{ link = 'markdownH6' }` |\n | DropBarIconKindIdentifier | `{ link = 'CmpItemKindVariable' }` |\n | DropBarIconKindIfStatement | `{ link = 'Conditional' }` |\n | DropBarIconKindInterface | `{ link = 'CmpItemKindInterface' }` |\n | DropBarIconKindKeyword | `{ link = 'Keyword' }` |\n | DropBarIconKindList | `{ link = 'SpecialChar' }` |\n | DropBarIconKindMacro | `{ link = 'Macro' }` |\n | DropBarIconKindMarkdownH1 | `{ link = 'markdownH1' }` |\n | DropBarIconKindMarkdownH2 | `{ link = 'markdownH2' }` |\n | DropBarIconKindMarkdownH3 | `{ link = 'markdownH3' }` |\n | DropBarIconKindMarkdownH4 | `{ link = 'markdownH4' }` |\n | DropBarIconKindMarkdownH5 | `{ link = 'markdownH5' }` |\n | DropBarIconKindMarkdownH6 | `{ link = 'markdownH6' }` |\n | DropBarIconKindMethod | `{ link = 'CmpItemKindMethod' }` |\n | DropBarIconKindModule | `{ link = 'CmpItemKindModule' }` |\n | DropBarIconKindNamespace | `{ link = 'NameSpace' }` |\n | DropBarIconKindNull | `{ link = 'Constant' }` |\n | DropBarIconKindNumber | `{ link = 'Number' }` |\n | DropBarIconKindObject | `{ link = 'Statement' }` |\n | DropBarIconKindOperator | `{ link = 'Operator' }` |\n | DropBarIconKindPackage | `{ link = 'CmpItemKindModule' }` |\n | DropBarIconKindPair | `{ link = 'String' }` |\n | DropBarIconKindProperty | `{ link = 'CmpItemKindProperty' }` |\n | DropBarIconKindReference | `{ link = 'CmpItemKindReference' }` |\n | DropBarIconKindRepeat | `{ link = 'Repeat' }` |\n | DropBarIconKindScope | `{ link = 'NameSpace' }` |\n | DropBarIconKindSpecifier | `{ link = 'Specifier' }` |\n | DropBarIconKindStatement | `{ link = 'Statement' }` |\n | DropBarIconKindString | `{ link = 'String' }` |\n | DropBarIconKindStruct | `{ link = 'CmpItemKindStruct' }` |\n | DropBarIconKindSwitchStatement | `{ link = 'Conditional' }` |\n | DropBarIconKindTerminal | `{ link = 'Number' }` |\n | DropBarIconKindType | `{ link = 'CmpItemKindClass' }` |\n | DropBarIconKindTypeParameter | `{ link = 'CmpItemKindTypeParameter' }` |\n | DropBarIconKindUnit | `{ link = 'CmpItemKindUnit' }` |\n | DropBarIconKindValue | `{ link = 'Number' }` |\n | DropBarIconKindVariable | `{ link = 'CmpItemKindVariable' }` |\n | DropBarIconKindWhileStatement | `{ link = 'Repeat' }` |\n | DropBarIconUIIndicator | `{ link = 'SpecialChar' }` |\n | DropBarIconUIPickPivot | `{ link = 'Error' }` |\n | DropBarIconUISeparator | `{ link = 'SpecialChar' }` |\n | DropBarIconUISeparatorMenu | `{ link = 'DropBarIconUISeparator' }` |\n | DropBarMenuCurrentContext | `{ link = 'PmenuSel' }` |\n | DropBarMenuFloatBorder | `{ link = 'FloatBorder' }` |\n | DropBarMenuHoverEntry | `{ link = 'Visual' }` |\n | DropBarMenuHoverIcon | `{ reverse = true }` |\n | DropBarMenuHoverSymbol | `{ bold = true }` |\n | DropBarMenuNormalFloat | `{ link = 'NormalFloat' }` |\n | DropBarMenuSbar | `{ link = 'PmenuSbar' }` |\n | DropBarMenuThumb | `{ link = 'PmenuThumb' }` |\n | DropBarPreview | `{ link = 'Visual' }` |\n | DropBarKindArray | undefined |\n | DropBarKindBoolean | undefined |\n | DropBarKindBreakStatement | undefined |\n | DropBarKindCall | undefined |\n | DropBarKindCaseStatement | undefined |\n | DropBarKindClass | undefined |\n | DropBarKindConstant | undefined |\n | DropBarKindConstructor | undefined |\n | DropBarKindContinueStatement | undefined |\n | DropBarKindDeclaration | undefined |\n | DropBarKindDelete | undefined |\n | DropBarKindDoStatement | undefined |\n | DropBarKindElseStatement | undefined |\n | DropBarKindEnum | undefined |\n | DropBarKindEnumMember | undefined |\n | DropBarKindEvent | undefined |\n | DropBarKindField | undefined |\n | DropBarKindFile | undefined |\n | DropBarKindFolder | undefined |\n | DropBarKindForStatement | undefined |\n | DropBarKindFunction | undefined |\n | DropBarKindH1Marker | undefined |\n | DropBarKindH2Marker | undefined |\n | DropBarKindH3Marker | undefined |\n | DropBarKindH4Marker | undefined |\n | DropBarKindH5Marker | undefined |\n | DropBarKindH6Marker | undefined |\n | DropBarKindIdentifier | undefined |\n | DropBarKindIfStatement | undefined |\n | DropBarKindInterface | undefined |\n | DropBarKindKeyword | undefined |\n | DropBarKindList | undefined |\n | DropBarKindMacro | undefined |\n | DropBarKindMarkdownH1 | undefined |\n | DropBarKindMarkdownH2 | undefined |\n | DropBarKindMarkdownH3 | undefined |\n | DropBarKindMarkdownH4 | undefined |\n | DropBarKindMarkdownH5 | undefined |\n | DropBarKindMarkdownH6 | undefined |\n | DropBarKindMethod | undefined |\n | DropBarKindModule | undefined |\n | DropBarKindNamespace | undefined |\n | DropBarKindNull | undefined |\n | DropBarKindNumber | undefined |\n | DropBarKindObject | undefined |\n | DropBarKindOperator | undefined |\n | DropBarKindPackage | undefined |\n | DropBarKindProperty | undefined |\n | DropBarKindReference | undefined |\n | DropBarKindRepeat | undefined |\n | DropBarKindScope | undefined |\n | DropBarKindSpecifier | undefined |\n | DropBarKindStatement | undefined |\n | DropBarKindString | undefined |\n | DropBarKindStruct | undefined |\n | DropBarKindSwitchStatement | undefined |\n | DropBarKindTerminal | undefined |\n | DropBarKindType | undefined |\n | DropBarKindTypeParameter | undefined |\n | DropBarKindUnit | undefined |\n | DropBarKindValue | undefined |\n | DropBarKindVariable | undefined |\n | DropBarKindWhileStatement | undefined |\n\n

\n\n## Developers\n\n### Architecture\n\n```\n ┌──────────────────┐\n │winbar at win 1000│ {k}th symbol clicked\n │ contaning buf 1 ├──────────────────────┐\n └───────┬─▲────────┘ │\n ▼ │ │\n _G.dropbar.get_dropbar_str() │\n │ ▲ │\n ┌──────────────┐ ┌──────▼─┴──────┐ │\n │sources │ │_G.dropbar.bars│ │\n │ ┌───┐ │ └──────┬─▲──────┘ │\n │ │lsp│ │ ┌───────┬──▼─┴──┬───────┐ │\n │ └───┘ │ ┌─▼─┐ ┌─┴─┐ ┌─┴─┐ ... │\n │ ┌──────────┐ │ │[1]│ │[2]│ │[3]│ │\n │ │treesitter│ │ └─┬─┘ └─┬─┘ └─┬─┘ │\n │ └──────────┘ │ │ ... ... │\n │ ... │ └──┬─▲─────────────┬──────┐ │\n └─────┬─▲──────┘ ┌─▼─┴──┐ ┌──┴───┐ ... │\n │ │ │[1000]│ │[1015]│ │\n │ │ └─┬─▲──┘ └──────┘ │\n │ │ __tostring() │ │ return string cache │\n │ │ ┌───▼─┴───┐ ┌──────────────▼──────────────┐\n │ │ │dropbar_t├────────────────────▶_G.dropbar.on_click_callbacks│\n │ │ On update events └───┬─▲───┘ register symbol └──────────────┬──────────────┘\n │ │ get_symbols(1, 1000, ) │ │ on_click() callbacks │\n │ └─────────────────────────────────┘ │ ┌──────────┬────▼─────┬─────────┐\n └─────────────────────────────────────┘ ┌───▼────┐ ┌───┴────┐ ┌───┴────┐ ...\n each source returns dropbar_symbol_t[] │['buf1']│ │['buf2']│ │['buf3']│\n dropbar_t adds symbols as its components └───┬────┘ └───┬────┘ └───┬────┘\n dropbar_t flushes string cache │ ... ...\n └────────┬───────────────┬─────────┐\n ┌─────▼─────┐ ┌─────┴─────┐ ...\n │['win1000']│ │['win1015']│\n └─────┬─────┘ └─────┬─────┘\n │ ...\n ┌─────────┬────▼────┬─────────┐\n ┌───┴───┐ ... ┌────┴────┐ ...\n │['fn1']│ │['fn{k}']│\n └───────┘ └────┬────┘\n ▼\n invoke _G.dropbar.bars[1][1000].components[k]:on_click()\n │\n ▼\n open drop-down menu, goto symbol, etc\n```\n\n### Classes\n\n:warning: **Notice**\n\nThe plugin is still in its early stage, so the names and fields of classes\nmight change in the future without notice.\n\n#### `dropbar_t`\n\nDeclared and defined in [`lua/dropbar/bar.lua`](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/bar.lua).\n\n---\n\n`dropbar_t` is a class that represents a winbar.\n\nIt gets symbols_{[`dropbar_symbol_t[]`](#dropbar_symbol_t)} from\nsources_{[`dropbar_source_t`](#dropbar_source_t)} and renders them to a\nstring. It is also responsible for registering `on_click` callbacks of each\nsymbol in the global table `_G.dropbar.on_click_callbacks` so that nvim knows\nwhich function to call when a symbol is clicked.\n\n\n`dropbar_t` has the following fields:\n\n| Field | Type | Description |\n| -------------- | --------------------------------- | --------------------------------------------------------------------------------------------- |\n| `buf` | `integer` | the buffer the dropbar is attached to |\n| `win` | `integer` | the window the dropbar is attached to |\n| `sources` | [`dropbar_source_t[]`](#dropbar_source_t) | sources_{[`dropbar_source_t[]`](#dropbar_source_t)} that provide symbols to the dropbar |\n| `separator` | [`dropbar_symbol_t`](#dropbar_symbol_t) | separator_{[`dropbar_symbol_t`](#dropbar_symbol_t)} between symbols |\n| `padding` | `{left: integer, right: integer}` | padding to use between the winbar and the window border |\n| `extends` | [`dropbar_symbol_t`](#dropbar_symbol_t) | symbol_{[`dropbar_symbol_t`](#dropbar_symbol_t)} to use when a symbol is truncated |\n| `components` | [`dropbar_symbol_t[]`](#dropbar_symbol_t) | symbols_{[`dropbar_symbol_t[]`](#dropbar_symbol_t)} to render |\n| `string_cache` | `string` | string cache of the dropbar |\n| `in_pick_mode` | `boolean?` | whether the dropbar is in pick mode |\n| `symbol_on_hover` | [`dropbar_symbol_t`](#dropbar_symbol_t) | The previous symbol_{[`dropbar_symbol_t[]`](#dropbar_symbol_t)} under mouse hovering in the dropbar |\n| `last_update_request_time` | `float?` | timestamp of the last update request in ms, see `:h uv.now()` |\n\n\n`dropbar_t` has the following methods:\n\n| Method | Description |\n| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `dropbar_t:new(opts: dropbar_opts_t): dropbar_t` | constructor of `dropbar_t` |\n| `dropbar_t:del()` | destructor of `dropbar_t` |\n| `dropbar_t:displaywidth(): integer` | returns the display width of the dropbar |\n| `dropbar_t:truncate()` | truncates the dropbar if it exceeds the display width
\\*side effect: changes dropbar components_{[`dropbar_symbol_t[]`](#dropbar_symbol_t) |\n| `dropbar_t:cat(plain: boolean?): string` | concatenates the dropbar components into a string with substrings for highlights and click support if `plain` is not set; else returns a plain string without substrings for highlights and click support |\n| `dropbar_t:redraw()` | redraws the dropbar |\n| `dropbar_t:update()` | update dropbar components_{[`dropbar_symbol_t[]`](#dropbar_symbol_t)} and redraw the dropbar afterwards |\n| `dropbar_t:pick_mode_wrap(fn: fun(...): T?, ...): T?` | executes `fn` with parameters `...` in pick mode |\n| `dropbar_t:pick(idx: integer?)` | pick a component from dropbar in interactive pick mode if `idx` is not given; else pick the `idx`th component directly |\n| `dropbar_t:update_current_context_hl(bar_idx: integer)` | Update the current context highlight `hl-DropBarCurrentContext` and `hl-DropBarIconCurrentContext` assuming the `bar_idx` th symbol is clicked in the winbar |\n| `dropbar_t:update_hover_hl(col: integer?)` | Highlight the symbol at `col` as if the mouse is hovering on it |\n| `dropbar_t:__tostring(): string` | meta method to convert `dropbar_t` to its string representation |\n\n\n#### `dropbar_symbol_t`\n\nDeclared and defined in [`lua/dropbar/bar.lua`](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/bar.lua).\n\n---\n\n`dropbar_symbol_t` is a class that represents a symbol in a dropbar. It is the\nbasic element of [`dropbar_t`](#dropbar_t) and [`dropbar_menu_entry_t`](#dropbar_menu_entry_t).\n\n\n`dropbar_symbol_t` has the following fields:\n\n| Field | Type | Description |\n| ----------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `name` | `string` | name of the symbol |\n| `icon` | `string` | icon of the symbol |\n| `name_hl` | `string?` | highlight of the name of the symbol |\n| `icon_hl` | `string?` | highlight of the icon of the symbol |\n| `win` | `integer?` | the source window the symbol is shown in |\n| `buf` | `integer?` | the source buffer the symbol is defined in |\n| `view` | `table?` | The original view of the source window, created by `winsaveview()`, used to restore the view after previewing the symbol |\n| `bar` | [`dropbar_t?`](#dropbar_t) | the dropbar_{[`dropbar_t`](#dropbar_t)} the symbol belongs to, if the symbol is shown inside a winbar |\n| `menu` | [`dropbar_menu_t?`](#dropbar_menu_t) | menu_{[`dropbar_menu_t`](#dropbar_menu_t)} associated with the symbol, if the symbol is shown inside a winbar |\n| `entry` | [`dropbar_menu_entry_t?`](#dropbar_menu_entry_t) | the dropbar menu entry_{[`dropbar_menu_entry_t`](#dropbar_menu_entry_t)} the symbol belongs to, if the symbol is shown inside a menu |\n| `children` | `dropbar_symbol_t[]?` | children of the symbol (e.g. a children of a function symbol can be local variables inside the function) |\n| `siblings` | `dropbar_symbol_t[]?` | siblings of the symbol (e.g. a sibling of a symbol that represents a level 4 markdown heading can be other headings with level 4) |\n| `bar_idx` | `integer?` | index of the symbol in the dropbar_{[`dropbar_t`](#dropbar_t)} |\n| `entry_idx` | `integer?` | index of the symbol in the menu entry_{[`dropbar_menu_entry_t`](#dropbar_menu_entry_t)} |\n| `sibling_idx` | `integer?` | index of the symbol in the siblings |\n| `range` | `{start: {line: integer, character: integer}, end: {line: integer, character: integer}}` | range of the symbol in the source window |\n| `on_click` | `fun(this: dropbar_symbol_t, min_width: integer?, n_clicks: integer?, button: string?, modifiers: string?)\\|false?` | callback to invoke when the symbol is clicked, force disable `on_click` when the value if set to `false` |\n| `data` | `table?` | any extra data associated with the symbol |\n\n\n`dropbar_symbol_t` has the following methods:\n\n| Method | Description |\n| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `dropbar_symbol_t:new(opts: dropbar_symbol_t?): dropbar_symbol_t` | constructor of `dropbar_symbol_t` |\n| `dropbar_symbol_t:del()` | destructor of `dropbar_symbol_t` |\n| `dropbar_symbol_t:merge(opts: dropbar_symbol_t)` | create a new `dropbar_symbol_t` by merging `opts` into the current `dropbar_symbol_t` |\n| `dropbar_symbol_t:cat(plain: boolean?): string` | concatenates the symbol into a string with substrings for highlights and click support if `plain` is not set; else returns a plain string without substrings for highlights and click support |\n| `dropbar_symbol_t:displaywidth(): integer` | returns the display width of the symbol |\n| `dropbar_symbol_t:bytewidth(): integer` | returns the byte width of the symbol |\n| `dropbar_symbol_t:jump()` | jump to the start of the range of the dropbar symbol |\n| `dropbar_symbol_t:preview()` | preview the symbol in the source window |\n| `dropbar_symbol_t:preview_restore_hl()` | clear the preview highlights in the source window |\n| `dropbar_symbol_t:preview_restore_view()` | restore the view in the source window after previewing the symbol |\n| `dropbar_symbol_t:swap_field(field: string, new_val: any)` | temporarily change the content of a dropbar symbol |\n| `dropbar_symbol_t:restore()` | restore the original value of the fields of a dropbar symbol changed in `dropbar_symbol_t:swap_field()` |\n\n#### `dropbar_menu_t`\n\nDeclared and defined in [`lua/dropbar/menu.lua`](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/menu.lua).\n\n---\n\n`dropbar_menu_t` is a class that represents a drop-down menu.\n\n`dropbar_menu_t` has the following fields:\n\n| Field | Type | Description |\n| ------ | ------ | ------ |\n| `buf` | `integer` | buffer number of the menu |\n| `win` | `integer` | window id of the menu |\n| `is_opened` | `boolean?` | whether the menu is currently opened |\n| `entries` | [`dropbar_menu_entry_t[]`](#dropbar_menu_entry_t) | entries in the menu |\n| `win_configs` | `table` | window configuration, value can be a function, see [menu configuration options](#menu) |\n| `_win_configs` | `table?` | evaluated window configuration |\n| `cursor` | `integer[]?` | initial cursor position |\n| `prev_win` | `integer?` | previous window, assigned when calling new() or automatically determined in open() |\n| `sub_menu` | `dropbar_menu_t?` | submenu, assigned when calling new() or automatically determined when a new menu opens |\n| `prev_menu` | `dropbar_menu_t?` | previous menu, assigned when calling new() or automatically determined in open() |\n| `clicked_at` | `integer[]?` | last position where the menu was clicked, 1,0-indexed |\n| `prev_cursor` | `integer[]?` | previous cursor position in the menu |\n| `symbol_previewed` | [`dropbar_symbol_t?`](#dropbar_symbol_t) | symbol begin previewed in the menu |\n\n`dropbar_menu_t` has the following methods:\n\n| Method | Description |\n| ------ | ------ |\n| `dropbar_menu_t:new(opts: dropbar_menu_t?): dropbar_menu_t` | constructor of `dropbar_menu_t` |\n| `dropbar_menu_t:del()` | destructor of `dropbar_menu_t` |\n| `dropbar_menu_t:eval_win_configs()` | evaluate window configurations `dropbar_menu_t.win_configs` and store the result in `dropbar_menu_t._win_configs` |\n| `dropbar_menu_t:get_component_at(pos: integer[], look_ahead: boolean?): dropbar_symbol_t?, { start: integer, end: integer }?` | get the component_{[`dropbar_symbol_t`](#dropbar_symbol_t)} at position `pos` and its range it occupies in the entry it belongs to |\n| `dropbar_menu_t:click_at(pos: integer[], min_width: integer?, n_clicks: integer?, button: string?, modifiers: string?)` | simulate a click at `pos` in the menu |\n| `dropbar_menu_t:click_on(symbol: dropbar_symbol_t, min_width: integer?, n_clicks: integer?, button: string?, modifiers: string?)` | simulate a click at the component `symbol`_{[`dropbar_symbol_t`](#dropbar_symbol_t)} of the menu |\n| `dropbar_menu_t:update_hover_hl(pos: integer[])` | update the hover highlights (`DropBarMenuHover*`) assuming the cursor/mouse is hovering at `pos` in the menu |\n| `dropbar_menu_t:update_current_context_hl(linenr: integer?)` | update the current context highlight (`hl-DropBarMenuCurrentContext`) assuming the cursor is at line `linenr` in the menu |\n| `dropbar_menu_t:make_buf()` | create the menu buffer from the entries_{[`dropbar_menu_entry_t`](#dropbar_menu_entry_t), must be called after `self:eval_win_configs()` |\n| `dropbar_menu_t:make_win()` | open the menu window with `self._win_configs` and set menu options, must be called after `self:make_buf()` |\n| `dropbar_menu_t:override(opts: dropbar_menu_t?)` | override menu options |\n| `dropbar_menu_t:preview_symbol_at(pos: integer[], look_ahead: boolean?)` | preview the component_{[`dropbar_symbol_t`](#dropbar_symbol_t)} at position `pos` in the menu |\n| `dropbar_menu_t:finish_preview(restore_view: boolean?)` | finish previewing the symbol, always clear the preview highlights in the source buffer, restore the original view of the source window if `restore_view` is `true` or `nil` |\n| `dropbar_menu_t:quick_navigation(new_cursor: integer[])` | nagivate the cursor to the neartest clickable component on the current menu entry in the direction of cursor movement |\n| `dropbar_menu_t:open(opts: dropbar_menu_t?)` | open the menu with options `opts` |\n| `dropbar_menu_t:close(restore_view: boolean?)` | close the menu |\n| `dropbar_menu_t:toggle(opts: dropbar_menu_t?)` | toggle the menu |\n| `dropbar_menu_t:fuzzy_find_restore_entries()` | restore menu buffer and entries in their original order before modification by fuzzy search\n| `dropbar_menu_t:fuzzy_find_close()` | stop fuzzy finding and clean up allocated memory\n| `dropbar_menu_t:fuzzy_find_click_on_entry(component: number or fun(dropbar_menu_entry_t):dropbar_symbol_t)` | click on the currently selected fuzzy menu entry, choosing the component to click according to component\n| `dropbar_menu_t:fuzzy_find_open(opts: table?)` | open the fuzzy search menu, overriding fzf configuration with opts argument\n| `dropbar_menu_t:fuzzy_find_navigate(direction: \"up\" or \"down\")` | select the next or previous entry in the menu when the fuzzy search bar is open |\n\n#### `dropbar_menu_entry_t`\n\nDeclared and defined in [`lua/dropbar/menu.lua`](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/menu.lua).\n\n---\n\n`dropbar_menu_entry_t` is a class that represents an entry (row) in a\ndrop-down menu. A [`dropbar_menu_t`](#dropbar_menu_t) instance is made up of\nmultiple `dropbar_menu_entry_t` instances while a\n[`dropbar_menu_entry_t`](#dropbar_menu_entry_t) instance can contain multiple\n[`dropbar_symbol_t`](#dropbar_symbol_t) instances.\n\n`dropbar_menu_entry_t` has the following fields:\n\n| Field | Type | Description |\n| ------ | ------ | ------ |\n| `separator` | [`dropbar_symbol_t`](#dropbar_symbol_t) | separator to use in the entry |\n| `padding` | `{left: integer, right: integer}` | padding to use between the menu entry and the menu border |\n| `components` | [`dropbar_symbol_t[]`](#dropbar_symbol_t) | components_{[`dropbar_symbol_t[]`](#dropbar_symbol_t)} in the entry |\n| `virt_text` | `string[][]?` | list of virtual text chunks to display below the entry |\n| `menu` | [`dropbar_menu_t?`](#dropbar_menu_t) | the menu the entry belongs to |\n| `idx` | `integer?` | the index of the entry in the menu |\n\n`dropbar_menu_entry_t` has the following methods:\n\n| Method | Description |\n| ------ | ------ |\n| `dropbar_menu_entry_t:new(opts: dropbar_menu_entry_t?): dropbar_menu_entry_t` | constructor of `dropbar_menu_entry_t` |\n| `dropbar_menu_entry_t:del()` | destructor of `dropbar_menu_entry_t` |\n| `dropbar_menu_entry_t:cat(): string, dropbar_menu_hl_info_t` | concatenate the components into a string, returns the string and highlight info_{[`dropbar_menu_hl_info_t`](#dropbar_menu_hl_info_t) |\n| `dropbar_menu_entry_t:displaywidth(): integer` | calculate the display width of the entry |\n| `dropbar_menu_entry_t:bytewidth(): integer` | calculate the byte width of the entry |\n| `dropbar_menu_entry_t:first_clickable(offset: integer?): dropbar_symbol_t?, { start: integer, end: integer }?` | get the first clickable component_{[`dropbar_symbol_t`](#dropbar_symbol_t)} and its range in the dropbar menu entry starting from `offset`, which defaults to 0 |\n| `dropbar_menu_entry_t:get_component_at(col: integer, look_ahead: boolean?): dropbar_symbol_t?, { start: integer, end: integer }?` | get the component_{[`dropbar_symbol_t`](#dropbar_symbol_t)} at column position `col` and the range it occupies in the menu entry |\n| `dropbar_menu_entry_t:prev_clickable(col: integer): dropbar_symbol_t?, { start: integer, end: integer }?` | get the previous clickable component_{[`dropbar_symbol_t`](#dropbar_symbol_t)} and its range in the dropbar menu entry given current column position `col` |\n| `dropbar_menu_entry_t:next_clickable(col: integer): dropbar_symbol_t?, { start: integer, end: integer }?` | get the next clickable component_{[`dropbar_symbol_t`](#dropbar_symbol_t)} and its range in the dropbar menu entry given current column position `col` |\n\n#### `dropbar_menu_hl_info_t`\n\nDeclared and defined in [`lua/dropbar/menu.lua`](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/menu.lua).\n\n---\n\n`dropbar_menu_hl_info_t` is a class that represents a highlight range in a\nsingle line of a drop-down menu.\n\n`dropbar_menu_hl_info_t` has the following fields:\n\n| Field | Type | Description |\n| ------ | ------ | ------ |\n| `start` | `integer` | start column of the higlighted range |\n| `end` | `integer` | end column of the higlighted range |\n| `hlgroup` | `string` | highlight group to use for the range |\n| `ns` | `integer?` | namespace to use for the range, `nil` if using default namespace |\n\n#### `dropbar_source_t`\n\nDeclared in [`lua/dropbar/sources/init.lua`](https://github.com/Bekaboo/dropbar.nvim/blob/master/lua/dropbar/sources/init.lua).\n\n---\n\n`dropbar_source_t` is a class that represents a source of a drop-down menu.\n\n`dropbar_source_t` has the following field:\n\n| Field | Type | Description |\n| ------ | ------ | ------ |\n| `get_symbols` | `function(buf: integer, win: integer, cursor: integer[]): dropbar_symbol_t[]` | returns the symbols_{[`dropbar_symbol_t[]`](#dropbar_symbol_t)} to show in the winbar given buffer number `buf` and cursor position `cursor` |\n\n### Making a New Source\n\nA [`dropbar_source_t`](#dropbar_source_t) instance is just a table with\n`get_symbols` field set to a function that returns an array of\n[`dropbar_symbol_t`](#dropbar_symbol_t) instances given the buffer number, the\nwindow id, and the cursor position.\n\nWe have seen a simple example of a custom source in the [default config of\n`opts.bar.sources`](#bar) where the second source is set to a combination\nof lsp/treesitter/markdown sources using the `utils.source.fallback()` factory\nfunction, which simply returns a table containing a `get_symbols()` function\nwhere each source passed to `utils.source.fallback()` is queried and the first\nnon-empty result get from the sources is returned as the result of the combined\nsource.\n\nHere is another example of a custom source that will always return two symbols\nsaying 'Hello' and 'dropbar' with highlights `'hl-Keyword'` and `'hl-Title'`\nand a smiling face shown in `'hl-WarningMsg'` at the start of the first symbol;\nclicking on the first symbol will show a notification message saying 'Have you\nsmiled today?', followed by the smiling face icon used in the in dropbar symbol:\n\n```lua\nlocal bar = require('dropbar.bar')\nlocal custom_source = {\n get_symbols = function(_, _, _)\n return {\n bar.dropbar_symbol_t:new({\n icon = ' ',\n icon_hl = 'WarningMsg',\n name = 'Hello',\n name_hl = 'Keyword',\n on_click = function(self)\n vim.notify('Have you smiled today? ' .. self.icon)\n end,\n }),\n bar.dropbar_symbol_t:new({\n name = 'dropbar',\n name_hl = 'Title',\n }),\n }\n end,\n}\n```\n\nAdd this source to [`opts.bar.sources`](#bar) table to see it in action:\n\n```lua\nrequire('dropbar').setup({\n bar = {\n sources = {\n custom_source,\n },\n },\n})\n```\n\n#### Making a Source With Drop-Down Menus\n\nThe following example shows how to make a source that returns two symbols with\nthe first symbol having a drop-down menu with a single entry saying 'World':\n\n```lua\nlocal bar = require('dropbar.bar')\nlocal menu = require('dropbar.menu')\nlocal custom_source = {\n get_symbols = function(_, _, _)\n return {\n bar.dropbar_symbol_t:new({\n icon = ' ',\n icon_hl = 'WarningMsg',\n name = 'Hello',\n name_hl = 'Keyword',\n on_click = function(self)\n self.menu = menu.dropbar_menu_t:new({\n entries = {\n menu.dropbar_menu_entry_t:new({\n components = {\n bar.dropbar_symbol_t:new({\n icon = ' ',\n icon_hl = 'WarningMsg',\n name = 'World',\n name_hl = 'Keyword',\n on_click = function(sym)\n vim.notify('Have you smiled today? ' .. sym.icon)\n end,\n }),\n },\n }),\n },\n })\n self.menu:toggle()\n end,\n }),\n bar.dropbar_symbol_t:new({\n name = 'dropbar',\n icon = ' ',\n name_hl = 'Special',\n icon_hl = 'Error',\n }),\n }\n end,\n}\n```\n\n#### Default `on_click()` Callback\n\n[`dropbar_symbol_t:new()`](#dropbar_symbol_t) defines a default `on_click()`\ncallback if non is provided.\n\nThe default `on_click()` callback will look for these fields in the symbol\ninstance and create a drop-down menu accordingly on click, for more information\nabout these fields see [`dropbar_symbol_t`](#dropbar_symbol_t).\n\nFor creating the drop-down menu:\n\n - `dropbar_symbol_t.siblings`\n - `dropbar_symbol_t.sibling_idx`\n - `dropbar_symbol_t.children`\n\nFor jumping to the symbol or previewing it:\n\n - `dropbar_symbol_t.range`\n - `dropbar_symbol_t.win`\n - `dropbar_symbol_t.buf`\n\nThe following example shows a source that utilizes the default `on_click()`\ncallback:\n\n```lua\nlocal bar = require('dropbar.bar')\nlocal custom_source = {\n get_symbols = function(buf, win, _)\n return {\n bar.dropbar_symbol_t:new({\n name = 'Section 1',\n name_hl = 'Keyword',\n siblings = {\n bar.dropbar_symbol_t:new({\n name = 'Section 2',\n name_hl = 'WarningMsg',\n }),\n bar.dropbar_symbol_t:new({\n name = 'Section 3',\n name_hl = 'Error',\n }),\n bar.dropbar_symbol_t:new({\n name = 'Section 4',\n name_hl = 'String',\n children = {\n bar.dropbar_symbol_t:new({\n buf = buf,\n win = win,\n name = 'Section 4.1',\n name_hl = 'String',\n -- Will jump to line 3, col 4 (0-indexed) when clicked in the\n -- menu\n range = {\n start = { line = 3, character = 4 },\n ['end'] = { line = 5, character = 6 },\n }\n }),\n },\n }),\n },\n }),\n }\n end,\n}\n```\n\nTo see this source in action add it to [`opts.bar.sources`](#bar) table:\n\n```lua\nrequire('dropbar').setup({\n bar = {\n sources = {\n custom_source,\n },\n },\n})\n```\n\n#### Lazy-Loading Expensive Fields\n\nIf the symbol fields `siblings` or `children` are expensive to compute, you can\nuse meta-tables to lazy-load them, so that they are only computed when a menu\nis opened:\n\n```lua\nlocal bar = require('dropbar.bar')\nlocal custom_source = {\n get_symbols = function(_, _, _)\n return {\n bar.dropbar_symbol_t:new(setmetatable({\n name = 'Section 1',\n name_hl = 'Keyword',\n }, {\n __index = function(self, key)\n if key == 'siblings' then\n self[siblings] = -- [[ compute siblings ]]\n return self[siblings]\n end\n if key == 'children' then\n self[children] = -- [[ compute children ]]\n return self[children]\n end\n -- ...\n end,\n })),\n }\n end,\n}\n```\n\nTo see concrete examples of lazy-loading see\n[`lua/dropbar/sources`](https://github.com/Bekaboo/dropbar.nvim/tree/master/lua/dropbar/sources).\n\n## Similar Projects\n\n- [nvim-navic](https://github.com/SmiteshP/nvim-navic)\n","dotfyleShieldAddedAt":null,"stars":635,"lastSyncedAt":"2023-11-29T02:20:27.236Z","addedLastWeek":0}}}]}}]}}}