Windline

Features:

* custom statusline for every file type * built-in animation library * change colors with your colorscheme * fast and powerful customization * custommize display of global statusline

demo

Displaying two different animated status line (markdown and lua file types).

Intro

We offer a built-in animations and color library for status line. I know it is not useful but why not :).

It is not loaded if you don't use animations.

Setup

You can create your own custom status line, using as a base/example the included status line setups is recommended for new users.

local windline = require('windline')
windline.setup({
  statuslines = {
    --- you need to define your status lines here
  }
})

Included Status lines

bubble line

require('wlsample.bubble')

bubble line

require('wlsample.bubble2')

evil line

require('wlsample.evil_line')

airline

require('wlsample.airline')
--  the animated alternative. you can toggle animation by press <leader>u9
require('wlsample.airline_anim')

vscode

require('wlsample.vscode')

basic animation

require('wlsample.basic')

wind animation

require('wlsample.wind')

luffy

require('wlsample.airline_luffy')

[cava]

-- only support linux it need install cava
lua require("windline.components.cava").toggle()

Remember windline can display a different status line per file type, so you can have bubble line for markdown or latex file, and airline for your working file.

You need install gitsigns.nvim to get git information.

Status line

You need to define a default status line that will be used on all filetypes that do not define a custom one.

local default = {
    filetypes={'default'},
    active={
      --- components...
    },
    inactive={
      --- components...
    }
}
local explorer = {     filetypes = {'fern', 'NvimTree','netrw'},     active = {         {'  ', {'white', 'black'} },     },     --- show active components when the window is inactive     always_active = true,     --- It will display a last window statusline even that window should inactive     showlaststatus = true }

components

local default = {
    filetypes={'default'},
    active={
      --- components...
      {'[',{'red', 'black'}},
      {'%f',{'green','black'}},
      {']',{'red','black'}},
-- empty color definition uses the previous component colors       {"%=", ''} ,
-- hightlight groups can also be used       {' ','StatusLine'},
{' %3l:%-2c ',{'white','black'}}     }, }

A text function has a bufnr and winid parameter that can be used to get data from the buffer or window

A text function can return a group of child components

local lsp_comps = require('windline.components.lsp')
basic.lsp_diagnos = {     name = 'diagnostic',     hl_colors = {         red_text = {'red', 'black'}     },     text = function(bufnr, winid, width)         if lspcomps.checklsp() then             return {
{ '[ lsp: ', 'red_text' },                 -- redtext define in hlcolors. It make easy cache value first                 -- because text function run multiple time on redraw
{ lspcomps.lspname() , 'IncSearch'},                 -- it use a hightlight group IncSearch
-- but you can create a hightlight on child component too                 { lspcomps.lsperror({ format = '  %s' }), {'red','black'} },
{ lspcomps.lspwarning({ format = '  %s' }), {'yellow',''} },                 -- it have same background black with the previous component
{ lspcomps.lsphint({ format = '  %s' }), {'', 'blue'} },                 -- it have same foreground yellow with the previous component
{ ' ] ' },             }         end         return ''     end, }

Never use a Job or run system command inside component. You need to use it inside cache component

Windline doesn't have a component condition just return an empty string ''or nil to remove it.

It doesn't have seperator or padding so you can add it by create a child component.

More info

Width setting

local git_comps = require('windline.components.git')

-- short syntax local gitbranch = { gitcomps.git_branch(), {'white', 'black'}, 100}
-- syntax using table local git_branch = {     text = gitcomps.gitbranch(),     hl_colors = {'white','black'},     --- component not visible if window width is less than 100     width = 100, }

Colors

Color name is use to define component and animation

lua
-- sample
local colors = {
  black         = "",  -- terminalcolor0,
  red           = "",  -- terminalcolor1,
  green         = "",  -- terminalcolor2,
  yellow        = "",  -- terminalcolor3,
  blue          = "",  -- terminalcolor4,
  magenta       = "",  -- terminalcolor5,
  cyan          = "",  -- terminalcolor6,
  white         = "",  -- terminalcolor7,
  blacklight   = "",  -- terminalcolor_8,
  redlight     = "",  -- terminalcolor_9,
  greenlight   = "",  -- terminalcolor_10,
  yellowlight  = "",  -- terminalcolor_11,
  bluelight    = "",  -- terminalcolor_12,
  magentalight = "",  -- terminalcolor_13,
  cyanlight    = "",  -- terminalcolor_14,
  whitelight   = "",  -- terminalcolor_15,
NormalFg      = "",  -- hightlight Normal fg   NormalBg      = "",  -- hightlight Normal bg   ActiveFg      = "",  -- hightlight StatusLine fg   ActiveBg      = "",  -- hightlight StatusLine bg   InactiveFg    = "",  -- hightlight StatusLineNc fg   InactiveBg    = "",  -- hightlight StatusLineNc bg } return colors

If you need to define a new color to use on animation you need to define it on the colors_name function.

local windline = require('windline')
windline.setup({   -- this function will run on ColorScheme autocmd   colors_name = function(colors)       --- add new colors       colors.FilenameFg = colors.white_light       colors.FilenameBg = colors.black
-- this color will not update if you change a colorscheme       colors.gray = "#fefefe"
-- dynamically get color from colorscheme hightlight group       local searchFg, searchBg = require('windline.themes').gethlcolor('Search')       colors.SearchFg = searchFg or colors.white       colors.SearchBg = searchBg or colors.yellow
return colors   end,
})

animations

lua
animation.animation({
   data = {
        {'red_light',efffects.rainbow()},
        {'green_light',efffects.rainbow()},
        {'cyan_light',efffects.blackwhite()},
        {'FilenameBg',efffects.rainbow()},
        {'FilenameFg',efffects.blackwhite()}
    },
    timeout = 10,
    delay = 200,
    interval = 100,
})
you can create multi animation but only list of data on animation is sync

effects

| Usage | KEY | |----------------------------|---------------------------------------| | rainbow() | a rainbow animation color | | blackwhite() | toggle between black and white | | listcolor({..listcolor}) | swap color from list | | flashyH([number 0-360]) | increase H on every step of animation | | flashyS(number 0.01 - 1) | increase S on every step of animation | | flashyL([number 0.01 - 1) | increase L on every step of animation |

-- you can write your own effect
local Hsl = require('wlanimation.hsl')
animation.animation({
   data = {
        {'red',efffects.wrap(function(color)
            return HSL.new(color.H + 1, color.S, color.L)
        end)},
    },
    timeout = 100,
    delay = 200,
    interval = 100,
})

windline.setup({
  -- hide that filetype on global statusline
    globalskipfiletypes = {
        'NvimTree',
        'lir',
    }
})

local telescope = {     filetypes = {'TelescopePrompt'},     active = {         {'  ', {'white', 'black'} },     },     --- for global statusline (laststatus = 3).      --- by default it skip all floating window on global statusline but you can     --- change it here     globalshowfloat = false }

[view

Click

view

Benchmark

Tabline

Document