diff --git a/options.html b/options.html index fd21e9e..122d0ca 100644 --- a/options.html +++ b/options.html @@ -21425,6 +21425,1192 @@ null or string
Default:
"<leader>bsi"
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts
+
+
+Option table to pass into the setup function of Bufferline-nvim
You can pass in any additional options even if they’re +not listed in the docs
+ +Type: +attribute set of anything
+ +Default:
+{ }
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.highlights
+
+
+Overrides the highlight groups of bufferline.
See :help bufferline-highlights
.
Type: +(attribute set) or (luaInline)
+ +Default:
+{ }
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.always_show_bufferline
+
+
+Whether to always show bufferline
+ +Type: +boolean
+ +Default:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.auto_toggle_bufferline
+
+
+Whether to auto toggle bufferline
+ +Type: +boolean
+ +Default:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.buffer_close_icon
+
+
+Icon for close button
+ +Type: +string
+ +Default:
+" "
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.close_command
+
+
+Command to run when closing a buffer
+ +Type: +string or (luaInline)
+ +Default:
{
+ _type = "lua-inline";
+ expr = ''
+ function(bufnum)
+ require("bufdelete").bufdelete(bufnum, false)
+ end
+ '';
+}
+
+
+Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.close_icon
+
+
+Icon for close button
+ +Type: +string
+ +Default:
+" "
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.color_icons
+
+
+Whether or not to add filetype icon highlights
+ +Type: +boolean
+ +Default:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.custom_filter
+
+
+Custom filter function for filtering out buffers.
This will be called a lot, so you are encouraged to keep it as +short and lightweight as possible unless you are fully aware +of the performance implications.
Type: +null or (luaInline)
+ +Default:
+null
Example:
custom_filter = function(buf_number, buf_numbers)
+ -- filter out filetypes you don't want to see
+ if vim.bo[buf_number].filetype ~= "<i-dont-want-to-see-this>" then
+ return true
+ end
+ -- filter out by buffer name
+ if vim.fn.bufname(buf_number) ~= "<buffer-name-I-dont-want>" then
+ return true
+ end
+ -- filter out based on arbitrary rules
+ -- e.g. filter out vim wiki buffer from tabline in your work repo
+ if vim.fn.getcwd() == "<work-repo>" and vim.bo[buf_number].filetype ~= "wiki" then
+ return true
+ end
+ -- filter out by it's index number in list (don't show first buffer)
+ if buf_numbers[1] ~= buf_number then
+ return true
+ end
+end
+
+
+
+Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.diagnostics
+
+
+Diagnostics provider to be used in buffer LSP indicators
+ +Type: +one of false, “nvim_lsp”, “coc”
+ +Default:
+"nvim_lsp"
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.diagnostics_indicator
+
+
+Function to get the diagnostics indicator. +The function should return a string to be used as the indicator.
Can be set to nil to keep the buffer name highlight, but delete the +highlighting.
+ +Type: +null or (luaInline)
+ +Default:
{
+ _type = "lua-inline";
+ expr = ''
+ function(count, level, diagnostics_dict, context)
+ local s = " "
+ for e, n in pairs(diagnostics_dict) do
+ local sym = e == "error" and " "
+ or (e == "warning" and " " or " " )
+ s = s .. n .. sym
+ end
+ return s
+ end
+ '';
+}
+
+
+Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.diagnostics_update_in_insert
+
+
+Whether to update diagnostics while in insert mode.
Setting this to true has performance implications, but they may be +negligible depending on your setup. Set it to true if you know what +you are doing.
+ +Type: +boolean
+ +Default:
+false
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.duplicates_across_groups
+
+
+Whether to consider duplicate paths in different groups as duplicates
+ +Type: +boolean
+ +Default:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.enforce_regular_tabs
+
+
+Whether to enforce regular tabs
+ +Type: +boolean
+ +Default:
+false
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.get_element_icon
+
+
+The function bufferline uses to get the icon. Recommended to leave as default.
+ +Type: +null or (luaInline)
+ +Default:
+null
Example:
function(element)
+ local custom_map = {my_thing_ft: {icon = "my_thing_icon", hl = "DevIconDefault"}}
+ return custom_map[element.filetype]
+end
+
+
+
+Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.hover.enabled
+
+
+Whether to enable hover.
+ +Type: +boolean
+ +Default:
+true
Example:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.hover.delay
+
+
+Delay for hover, in ms
+ +Type: +signed integer
+ +Default:
+200
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.hover.reveal
+
+
+Reveal hover window
+ +Type: +list of string
+ +Default:
[
+ "close"
+]
+
+
+Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.indicator.icon
+
+
+The indicatotor icon to use for the current buffer.
This must be ommitted while style is not icon
Type: +null or string
+ +Default:
+null
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.indicator.style
+
+
+Style for indicator
+ +Type: +one of “icon”, “underline”, “none”
+ +Default:
+"underline"
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.left_mouse_command
+
+
+Command to run when left clicking a buffer
+ +Type: +null or string or (luaInline)
+ +Default:
+"buffer %d"
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.left_trunc_marker
+
+
+Icon for left truncation
+ +Type: +string
+ +Default:
+""
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.max_name_length
+
+
+Max name length
+ +Type: +signed integer
+ +Default:
+18
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.max_prefix_length
+
+
+Length of the prefix used when a buffer is de-duplicated
+ +Type: +signed integer
+ +Default:
+15
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.middle_mouse_command
+
+
+Command to run when middle clicking a buffer
+ +Type: +null or string or (luaInline)
+ +Default:
+null
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.mode
+
+
+Mode to use for bufferline
+ +Type: +one of “tabs”, “buffers”
+ +Default:
+"buffers"
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.modified_icon
+
+
+Icon for modified buffer
+ +Type: +string
+ +Default:
+"● "
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.move_wraps_at_ends
+
+
+Whether or not the move command “wraps” at the first or last position
+ +Type: +boolean
+ +Default:
+false
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.name_formatter
+
+
+name_formatter
can be used to change the buffer’s label in the
+bufferline.
Some names can/will break the bufferline so use this at your +discretion knowing that it has some limitations that will +NOT be fixed.
Type: +null or (luaInline)
+ +Default:
+null
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.numbers
+
+
+Whether or not to show buffer numbers
+ +Type: +one of “none”, “ordinal”, “buffer_id”, “both” or (luaInline)
+ +Default:
{
+ _type = "lua-inline";
+ expr = ''
+ function(opts)
+ return string.format('%s·%s', opts.raise(opts.id), opts.lower(opts.ordinal))
+ end
+ '';
+}
+
+
+Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.offsets
+
+
+The windows to offset bufferline above, see :help bufferline-offset
Type: +list of (attribute set)
+ +Default:
[
+ {
+ filetype = "NvimTree";
+ highlight = "Directory";
+ separator = true;
+ text = "File Explorer";
+ }
+]
+
+
+Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.persist_buffer_sort
+
+
+Whether or not custom sorted buffers should persist
+ +Type: +boolean
+ +Default:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.right_mouse_command
+
+
+Command to run when right clicking a buffer
+ +Type: +null or string or (luaInline)
+ +Default:
+"vertical sbuffer %d"
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.right_trunc_marker
+
+
+Icon for right truncation
+ +Type: +string
+ +Default:
+""
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.separator_style
+
+
+The type of separator used to separate buffers and tabs.
Either one of the listed types, or a list of 2 characters for either side.
+ +Type: +null or one of “slant”, “padded_slant”, “slope”, “padded_slope”, “thick”, “thin” or list of string
+ +Default:
+"thin"
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.seperator_style
+
+
+Style of the buffer separator.
Can be either one of the suspported values, or a list containing
+at most two elements for focused
and unfocused
respectively.
Type: +one of “thick”, “thin”, “slope”, “slant” or list of string
+ +Default:
[
+ " "
+ " "
+]
+
+
+Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.show_buffer_close_icons
+
+
+Whether or not to show buffer close icons
+ +Type: +boolean
+ +Default:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.show_buffer_icons
+
+
+Whether or not to show buffer icons
+ +Type: +boolean
+ +Default:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.show_close_icon
+
+
+Whether or not to show the close icon
+ +Type: +boolean
+ +Default:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.show_duplicate_prefix
+
+
+Whether or not to show duplicate buffer prefixes
+ +Type: +boolean
+ +Default:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.show_tab_indicators
+
+
+Whether or not to show tab indicators
+ +Type: +boolean
+ +Default:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.sort_by
+
+
+Method to sort buffers by. Must be one of the supported values, or an inline Lua value.
+ +Type: +one of “insert_after_current”, “insert_at_end”, “id”, “extension”, “relative_directory”, “directory”, “tabs” or (luaInline)
+ +Default:
+"extension"
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.style_preset
+
+
+The base style of bufferline
+ +Type: +one of “default”, “minimal”, “no_bold”, “no_italic”
+ +Default:
+"default"
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.tab_size
+
+
+The size of the tabs in bufferline
+ +Type: +signed integer
+ +Default:
+18
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.themable
+
+
+Whether or not to allow highlight groups to be overriden.
While false, bufferline.nvim sets highlights as default.
+ +Type: +boolean
+ +Default:
+true
Declared by:
+
+
+<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix>
+
+ |
vim.tabline.nvimBufferline.setupOpts.options.truncate_names
+
+
+Truncate names
+ +Type: +boolean
+ +Default:
+true
Declared by:
diff --git a/release-notes.html b/release-notes.html
index 42c6f5f..b989087 100644
--- a/release-notes.html
+++ b/release-notes.html
@@ -148,7 +148,7 @@ from anything to a submodule<
group for |