You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
User-friendly framework for building your dream tabline in a few lines of code.
Do you know the lua basics and nothing about tablines? Or maybe are you just lazy and don't want to write all the necessary code before fun part? Do you prefer vim tabs or buffer-lines? Or maybe you hate both and just wanted an extra status line? You know what? This plugin is just for you.
use {"rafcamlet/tabline-framework.nvim",requires="kyazdani42/nvim-web-devicons"}
Configuration
require('tabline_framework').setup {-- Render function is resposible for generating content of tabline-- This is the place where you do your magic!render=function(f)f.add'This is my tabline!'end,-- Default color of tabline items: tabs/bufs-- if not set TF uses TabLine highlight group colorshl= {fg="#abb2bf"bg="#31353f"}-- Default color of selected item-- if not set TF uses TabLineSel highlight group colorshl_sel= {fg="#282c34"bg="#abb2bf"gui="bold,underline"}-- Default color of everything except items-- if not set TF uses TabLineFill highlight group colorshl_fill= {fg="#282c34"bg="#abb2bf"}}
How to use it
The render function is a heart of TablineFramework. The whole tabline is defined inside it. It takes a single argument, which contains a table of functions required to manipulating the final result. Let's look at a simple example:
add function can take a string or a table as its argument. The first item in table is a content which will be added to tabline. Using thefg,bg keys, you can specify its highlighting.
Okay, so we have a fancy bug icon, but that isn't too useful. Let's add tabs to it!
Themake_tabs function takes callback which will be called for each existing tab. As argument it provides table with tab-related information, which you can use in item content. In the example above, we used index number and the filename of focused buffer.
Don't you like tabs? Just replacemake_tabs withmake_bufs. Simple as that.
Do you want something more fancy?
localrender=function(f)f.add {' ',fg="#bb0000"}f.make_tabs(function(info)f.add(''..info.index..'')ifinfo.filenamethen-- let's add + sign if the buffer is modifiedf.add(info.modifiedand'+')f.add(info.filename)else-- Why waste space for [no name] ?-- Let's use [-] if the buffer has no name-- or [+] if it is also modifiedf.add(info.modifiedand'[+]'or'[-]')endf.add''end)end
Icons? People love icons!
localrender=function(f)f.add {' ',fg="#bb0000"}f.make_tabs(function(info)-- With the help of kyazdani42/nvim-web-devicons we can fetch color-- associated with the filetypelocalicon_color=f.icon_color(info.filename)-- If this is the current tab then highlight itifinfo.currentthen-- We can use set_fg to change default fg color-- so you won't need to specify it every timef.set_fg(icon_color)endf.add(''..info.index..'')ifinfo.filenamethenf.add(info.modifiedand'+')f.add(info.filename)-- The icon function returns a filetype icon based on the filenamef.add(''..f.icon(info.filename))elsef.add(info.modifiedand'[+]'or'[-]')endf.add''end)end
The right side looks a bit blank. Maybe lsp diagnostic indicators?
localrender=function(f)f.add {' ',fg="#bb0000"}f.make_tabs(function(info)-- ...end)-- Let's add a spacer wich will justify the rest of the tabline to the rightf.add_spacer()-- get some info from lsplocalerrors=#vim.diagnostic.get(0, {severity=vim.diagnostic.severity.ERROR })localwarnings=#vim.diagnostic.get(0, {severity=vim.diagnostic.severity.WARN })-- and display itf.add {' '..errors,fg="#e86671"}f.add {' '..warnings,fg="#e5c07b"}f.add''end
Addsstring to the tabline and optionally sets its highlighting.
f.set_fg('#ffffff')
Sets the default foreground color. Useful for changing highlight of many elements. Callingmake_tabs or make_bufs resets the default colors, same as each tab/bufs item iteration.
Add separation point between alignment sections. Add one to split line into left and right, use two to add centre.
f.icon('filename.lua')
Returns the icon associated with filetype based on the passed filename.
f.icon_color('filename.lua')
Returns the color associated with filetype based on the passed filename.
f.make_tabs()
f.make_tabs(callback)
f.make_tabs(callback, tablist)
It iterates over all tabs and passes to its callback table with tab related info. Optionally takes a second argument with a list of tab IDs, allowing you to specify custom ordering or filtering.
info.index - tab index
info.tab - tab id
info.win - id of the focused window inside the tab
info.buf - id of the buffer displayed in the focused window inside the tab
info.buf_name - buffer name
info.filename - filename extracted from buffer name or nil whenbuf_name is empty
info.modified - boolean: indicates if the buffer has been modified
info.current - boolean: indicates if the buffer is focused
info.before_current - boolean: indicates if the next buffer is the focused one. Might be useful for conditionally adding item separators.
info.after_current - boolean: indicates if the previous buffer was the focused one.
info.first - boolean: indicates if tab is first in list
info.last - boolean: indicates if tab is last in list
f.make_bufs()
f.make_bufs(callback)
f.make_bufs(callback, buflist)
Likemake_tabs but iterates over listed buffers (check the:h buflisted). The info table has nowin andtab keys, because buffers can be associated with multiple (or none) windows/tabs.
