20 KiB

Raw Blame History

lualine.nvim

A blazing fast and easy to configure Neovim statusline written in Lua

lualine.nvim requires neovim 0.5

Contributing

Feel free to create an issue/pr if you want to see anything else implemented. If you have some question or need help with configuration start a discussion.

Please read CONTRIBUTING.md before opening a pr. You can also help with documentation in wiki

Screenshots

Here is a preview of how lualine can look like.

Screenshots of all available themes are listed in THEMES.md

For those who want to break the norms. You can create custom looks in lualine.

Example :

Performance compared to other plugins

Unlike other statusline plugins lualine loads only defined components, nothing else.

Startup time performance measured with an amazing plugin dstein64/vim-startuptime

All times are measured with clean init.vim with only vim-startuptime, vim-plug and given statusline plugin installed. In control just vim-startuptime andvim-plug is installed. And measured time is complete startuptime of vim not time spent on specific plugin. These numbers are average of 20 runs.

control	lualine	lightline	airline
8.943 ms	10.140 ms	12.522 ms	38.850 ms

Last Updated On: 20-09-2021

Installation

vim-plug

Plug 'nvim-lualine/lualine.nvim'
" If you want to have icons in your statusline choose one of these
Plug 'kyazdani42/nvim-web-devicons'

packer.nvim

use {
  'nvim-lualine/lualine.nvim',
  requires = {'kyazdani42/nvim-web-devicons', opt = true}
}

You'll also need to have a patched font if you want icons.

Usage and customization

Lualine has sections as shown below.

+-------------------------------------------------+
| A | B | C                             X | Y | Z |
+-------------------------------------------------+

Each sections holds it's components e.g. current vim's mode.

Configuring lualine in init.vim

All the examples below are in lua. You can use the same examples in .vim file by wrapping them in lua heredoc like this:

lua << END
require'lualine'.setup()
END

checkout :help lua-heredoc.

Default config

require'lualine'.setup {
  options = {
    icons_enabled = true,
    theme = 'auto',
    component_separators = { left = '', right = ''},
    section_separators = { left = '', right = ''},
    disabled_filetypes = {},
    always_divide_middle = true,
  },
  sections = {
    lualine_a = {'mode'},
    lualine_b = {'branch', 'diff', 'diagnostics'},
    lualine_c = {'filename'},
    lualine_x = {'encoding', 'fileformat', 'filetype'},
    lualine_y = {'progress'},
    lualine_z = {'location'}
  },
  inactive_sections = {
    lualine_a = {},
    lualine_b = {},
    lualine_c = {'filename'},
    lualine_x = {'location'},
    lualine_y = {},
    lualine_z = {}
  },
  tabline = {},
  extensions = {}
}

If you want to get your current lualine config. you can do so with

require'lualine'.get_config()

Starting lualine

require('lualine').setup()

Setting a theme

options = {theme = 'gruvbox'}

All available themes are listed in THEMES.md

Please create a pr if you managed to port a popular theme before me, here is how to do it.

Customizing themes

local custom_gruvbox = require'lualine.themes.gruvbox'
-- Change the background of lualine_c section for normal mode
custom_gruvbox.normal.c.bg = '#112233' -- RGB colors are supported
require'lualine'.setup{
  options = { theme  = custom_gruvbox },
  ...
}

Theme structure is available here

Separators

Lualine defines two kinds of separators:

section_separators - separators between sections
components_separators - separators between components in sections

options = {
  section_separators = { left = '', right = ''},
  component_separators = { left = '', right = ''}
}

Here left means it'll be used for left sections (a, b, c) and right means it'll be used for right sections (x, y, z).

Disabling separators

options = {section_separators = '', component_separators = ''}

Changing components in lualine sections

sections = {lualine_a = {'mode'}}

Available components

branch (git branch)
buffers (shows currently available buffers)
diagnostics (diagnostics count from your prefered source)
diff (git diff status)
encoding (file encoding)
fileformat (file format)
filename
filesize
filetype
hostname
location (location in file in line:column format)
mode (vim mode)
progress (%progress in file)
tabs (shows currently available tabs)

Custom components

Lua functions as lualine component

local function hello()
  return [[hello world]]
end
sections = {lualine_a = {hello}}

Vim functions as lualine component

sections = {lualine_a = {'FugitiveHead'}}

Vim's statusline items as lualine component

sections = {lualine_c = {'%=', '%t%m', '%3p'}}

Vim variables as lualine component

Variables from g:, v:, t:, w:, b:, o, go:, vo:, to:, wo:, bo: scopes can be used.

See :h lua-vim-variables and :h lua-vim-options if you are not sure what to use.

sections = {lualine_a = {'g:coc_status', 'bo:filetype'}}

Lua expressions as lualine component

You can use any valid lua expression as a component including

oneliners
global variables
require statements

sections = {lualine_c = {"os.date('%a')", 'data', "require'lsp-status'.status()"}}

data is a global variable in this example.

Component options

Component options can change the way a component behave. There are two kinds of options:

global options affecting all components
local options affecting specific

Global options can be used as local options (can be applied to specific components) but you cannot use local options as global. Global option used locally overwrites the global, for example:

    require'lualine'.setup {
      options = {fmt = string.lower},
      sections = {lualine_a = {
        {'mode', fmt = function(str) return str:sub(1,1) end}},
                  lualine_b = {'branch'}}
    }

mode will be formatted with the passed fa=unction so only first char will be shown . On the other hand branch will be formatted with global formatter string.lower so it will be showed in lower case.

Available options

Global options

These are options that are used in options table. They set behavior of lualine.

Values set here are treated as default for other options that work in component level.

for example even though icons_enabled is a general component option. you can set icons_enabled to false and icons will be disabled on all component. You can still overwrite defaults set in option table by specifying the option value in component.

options = {
  theme = 'auto',              -- lualine theme
  component_separators = {left = '', right = ''},
  section_separators = {left = '', right = ''},
  disabled_filetypes = {},     -- Filetypes to disable lualine for.
  always_divide_middle = true, -- When set to true, left sections i.e. 'a','b' and 'c'
                               -- can't take over the entire statusline even
                               -- if neither of 'x', 'y' or 'z' are present.
}

General component options

These are options that control behavior at component level and are available for all components.

sections = {
  lualine_a = {
    {
      'mode',
      icons_enabled = true, -- Enables the display of icons alongside the component.
      icon = nil,      -- Defines the icon to be displayed in front of the component.

      separator = nil, -- Determines what separator to use for the component.
                       -- When a string is provided it's treated as component_separator.
                       -- When a table is provided it's treated as section_separator.
                       -- These options can be used to set colored separators
                       -- around a component. 
                       --
                       -- The options need to be set like:
                       --   separator = { left = '', right = ''}
                       --
                       -- Where left will be placed on left side of component,
                       -- and right will be placed on its right.
                       -- Passing an empty string disables the separator.

      cond = nil, -- Condition function, the component is loaded when the function returns `true`.

      -- Custom color for the component in format
      -- here, '|' refers to 'or', meaning a different acceptable format for that placeholder e.g.:
      -- 'highlight_group_name' | {fg = '#rrggbb'|cterm_value(0-255)|'color_name(red)', bg= '#rrggbb', gui='style'}
      --
      -- Note: all other color options like diff_color including themes accept same color values
      --
      -- example:
      --   color = {fg = '#ffaa88', bg = 'grey', gui='italic,bold'},
      --   color = {fg = 204}   -- when fg/bg is skiped they default to themes fg/bg
      --   color = 'WarningMsg' -- highlight groups can also be used
      --
      color = nil, -- default is themes color for that section and mode

      -- This option specifies what type a component is.
      -- When it's omitted lualine will guess it for you.
      -- 
      -- Available types are:
      --   [format: type_name(example)], mod(branch/filename),
      --   stl(%f/%m), var(g:coc_status/bo:modifiable),
      --   lua_expr(lua expressions), vim_fun(viml function name)
      --
      -- lua_expr is short for lua-expression and vim_fun is short fror vim-function
      type = nil,
      padding = 1, -- Adds padding to the left and right of components.
                   -- Padding can be specified to left or right independently, e.g.:
                   --   padding = { left = left_padding, right = right_padding }
      fmt = nil,   -- Format function, formats the component's output.
    }
  }
}

Component specific options

These are options that are available on specific components. For example you have option on diagnostics component to specify what your diagnostic sources will be.

buffers component options

sections = {
  lualine_a = {
    {
      'buffers',
      show_filename_only = true,   -- Shows shortened relative path when set to false
      show_modified_status = true, -- Shows indicator then buffer is modified
      mode = 0, -- 0: Shows buffer name
                -- 1: Shows buffer index (bufnr)
                -- 2: Shows buffer name + buffer index (bufnr)
      max_length = vim.o.columns * 2 / 3, -- Maximum width of buffers component,
                                          -- it can also be a function that returns
                                          -- the value of `max_length` dynamically.
      filetype_names = {
        TelescopePrompt = 'Telescope',
        dashboard = 'Dashboard',
        packer = 'Packer',
        fzf = 'FZF',
        alpha = 'Alpha'
      }, -- Shows specific buffer name for that filetype ( { `filetype` = `buffer_name`, ... } )
      buffers_color = {
        -- Same values like general color option can be used here.
        active = 'lualine_{section}_normal',     -- Color for active buffer
        inactive = 'lualine_{section}_inactive', -- Color for inactive buffer
      },
    }
  }
}

diagnostics component options

sections = {
  lualine_a = {
    {
      'diagnostics',
      -- Table of diagnostic sources, available sources are:
      --   'nvim_lsp', 'nvim_diagnostic', 'coc', 'ale', 'vim_lsp'.
      -- or a function that returns a table like:
      --   {error=error_cnt, warn=warn_cnt, info=info_cnt, hint=hint_cnt}
      sources = {'nvim_diagnostic', 'coc'},
      -- displays diagnostics from defined severity
      sections = {'error', 'warn', 'info', 'hint'},
      diagnostics_color = {
        -- Same values like general color option can be used here.
        error = 'DiagnosticError', -- Changes diagnostics' error color
        warn  = 'DiagnosticWarn',  -- Changes diagnostics' warn color
        info  = 'DiagnosticInfo',  -- Changes diagnostics' info color
        hint  = 'DiagnosticHint',  -- Changes diagnostics' hint color
      },
      symbols = {error = 'E', warn = 'W', info = 'I', hint = 'H'},
      colored = true,           -- Displays diagnostics status in color if set to true
      update_in_insert = false, -- Update diagnostics in insert mode
      always_visible = false,   -- Show diagnostics even if there are none
    }
  }
}

diff component options

sections = {
  lualine_a = {
    {
      'diff',
      colored = true, -- Displays diff status in color if set to true
      diff_color = {
        -- Same values like general color option can be used here.
        added    = 'DiffAdd',    -- Changes the diff's added color
        modified = 'DiffChange', -- Changes the diff's modified color
        removed  = 'DiffDelete', -- Changes the diff's removed color you
      },
      symbols = {added = '+', modified = '~', removed = '-'}, -- Changes the symbols used by the diff
      source = nil, -- A function that works as a data source for diff.
                    -- It must return a table like:
                    --   {added = add_count, modified = modified_count, removed = removed_count }
                    -- or nil on failure. count <= 0 won't be displayed.
    }
  }
}

fileformat component options

sections = {
  lualine_a = {
    {
      'fileformat',
      symbols = {
        unix = '', -- e712
        dos = '',  -- e70f
        mac = '',  -- e711
      }
    }
  }
}

filename component options

sections = {
  lualine_a = {
    {
      'filename',
      file_status = true, -- Displays file status (readonly status, modified status)
      path = 0,           -- 0: Just the filename
                          -- 1: Relative path
                          -- 2: Absolute path


      shorting_target = 40, -- Shortens path to leave 40 spaces in the window
                            -- for other components. (terrible name, any suggestions?)
      symbols = {
        modified = '[+]',      -- Text to show when the file is modified
        readonly = '[-]',      -- Text to show when the file is non-modifiable or readonly
        unnamed = '[No Name]', -- Text to show for unnamed buffers
      }
    }
  }
}

filetype component options

sections = {
  lualine_a = {
    {
      'filetype',
      colored = true, -- Displays filetype icon in color if set to true
      icon_only = false -- Display only an icon for filetype
    }
  }
}

tabs component options

sections = {
  lualine_a = {
    {
      'tabs',
      max_length = vim.o.columns / 3, -- Maximum width of tabs component,
                                      -- it can also be a function that returns 
                                      -- the value of `max_length` dynamically.
      mode = 0, -- 0: Shows tab_nr
                -- 1: Shows tab_name
                -- 2: Shows tab_nr + tab_name

      tabs_color = {
        -- Same values like general color option can be used here.
        active = 'lualine_{section}_normal',   -- color for active tab
        inactive = 'lualine_{section}_inactive', -- color for inactive tab
      },
    }
  }
}

Tabline

You can use lualine to display components in tabline. The configuration for tabline sections is exactly the same as for statusline.

tabline = {
  lualine_a = {},
  lualine_b = {'branch'},
  lualine_c = {'filename'},
  lualine_x = {},
  lualine_y = {},
  lualine_z = {}
}

This will show branch and filename component in top of neovim inside tabline .

lualine also provides 2 components buffers & tabs that you can use to get more traditional tabline/bufferline.

tabline = {
  lualine_a = {'buffers'},
  lualine_b = {'branch'},
  lualine_c = {'filename'},
  lualine_x = {},
  lualine_y = {},
  lualine_z = {'tabs'}
}

You can also completely move your statusline to tabline by configuring lualine.tabline and disabling lualine.sections and lualine.inactive_sections.

tabline = {
......
  },
sections = {},
inactive_sections = {},

If you want a more sophisticated tabline you can use other tabline plugins with lualine too . For example:

tabline.nvim even uses lualines theme by default 🙌 You can find a bigger list here

Extensions

Lualine extensions change statusline appearance for a window/buffer with specified filetypes.

By default no extensions are loaded to improve performance. You can load extensions with:

extensions = {'quickfix'}

Available extensions

chadtree
fern
fugitive
fzf
nerdtree
nvim-tree
quickfix
toggleterm
symbols-outline

Custom extensions

You can define your own extensions. If you think an extension might be useful for others then please submit a pr.

local my_extension = {sections = {lualine_a = {'mode'}}, filetypes = {'lua'}}
require'lualine'.setup {extensions = {my_extension}}

Disabling lualine

You can disable lualine for specific filetypes

options = {disabled_filetypes = {'lua'}}

Contributors

Thanks to these wonderful people we enjoy this awesome plugin.

Wiki

Check out the wiki for more info .

You can find some useful configuration snippets here. You can also share your awesome snippents with others.

If you want to extened lualine with plugins or want to know which ones already do wiki/plugins is for you.

20 KiB Raw Blame History