11 KiB

Raw Blame History

lualine.nvim

A blazing fast and easy to configure neovim statusline written in pure lua.

lualine.nvim requires neovim 0.5

Contributing

Feel free to create an issue/pr if you want to see anything else implemented.

Please read CONTRIBUTING.md before opening a pr.

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 :

evil_lualine

Performance compared to other plugins

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

Startup time performance measured with an amazing plugin tweekmonster/startuptime.vim

All times are measured with only startuptime.vim and given statusline plugin installed

clean vimrc	lualine	lightline	airline
8.943 ms	9.034 ms	11.463 ms	13.425 ms

Installation

vim-plug

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

packer.nvim

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

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.

Default config

require'lualine'.setup {
  options = {
    icons_enabled = true,
    theme = 'gruvbox',
    component_separators = {'', ''},
    section_separators = {'', ''},
    disabled_filetypes = {}
  },
  sections = {
    lualine_a = {'mode'},
    lualine_b = {'branch'},
    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 = {}
}

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 seperators:

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

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

Disabling separators

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

Changing components in lualine sections

sections = {lualine_a = {'mode'}}

Available components

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

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 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.data('%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 = {lower = true},
      sections = {lualine_a = {{'mode', lower = false}}, lualine_b = {'branch'}}
    }

mode will be displayed with lower = false and branch will be displayed with lower = true

Available options

Global options

options = {
  icons_enabled = 1, -- displays icons in alongside component
  padding = 1, -- adds padding to the left and right of components
  left_padding = 1, -- adds padding to the left of components
  right_padding =1, -- adds padding to the right of components
  upper = false, -- displays components in uppercase
  lower = false, -- displays components in lowercase
  format = nil -- format function, formats component's output
}

Local options

sections = {
  lualine_a = {
    {
      'mode',
      icon = nil, -- displays icon in front of the component
      separator = nil, -- Determines what separator to use for the component.
      condition = nil, -- condition function, component is loaded when function returns true
      -- custom color for component in format
      -- color = {fg = '#rrggbb', bg= '#rrggbb', gui='style'}
      -- or highlight group
      -- color = "WarningMsg"
      color = nil
    }
  }
}

Component specific local options

`diagnostics` component options

sections = {
  lualine_a = {
    {
      'diagnostics',
      -- table of diagnostic sources, available sources:
      -- nvim_lsp, coc, ale, vim_lsp
      sources = nil,
      -- displays diagnostics from defined severity
      sections = {'error', 'warn', 'info', 'hint'},
      -- all colors are in format #rrggbb
      color_error = nil, -- changes diagnostic's error foreground color
      color_warn = nil, -- changes diagnostic's warn foreground color
      color_info = nil, -- Changes diagnostic's info foreground color
      color_hint = nil, -- Changes diagnostic's hint foreground color
      symbols = {error = 'E', warn = 'W', info = 'I', hint = 'H'}
      update_in_insert = false, -- Update diagnostics in insert mode
    }
  }
}

`filename` component options

sections = {
  lualine_a = {
    {
      'filename',
      file_status = true, -- displays file status (readonly status, modified status)
      path = 0 -- 0 = just filename, 1 = relative path, 2 = absolute path
    }
  }
}

`filetype` component options

sections = {
  lualine_a = {
    {
      'filetype',
      colored = true, -- displays filetype icon in color if set to `true
      disable_text = false -- Display only icon for filetype
    }
  }
}

`diff` component options

sections = {
  lualine_a = {
    {
      'diff',
      colored = true, -- displays diff status in color if set to true
      -- all colors are in format #rrggbb
      color_added = nil, -- changes diff's added foreground color
      color_modified = nil, -- changes diff's modified foreground color
      color_removed = nil, -- changes diff's removed foreground color
      symbols = {added = '+', modified = '~', removed = '-'} -- changes diff symbols
    }
  }
}

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 .

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

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

Extensions

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

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

extensions = {'quickfix'}

Available extensions

chadtree
fugitive
fzf
nerdtree
nvim-tree
quickfix

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'}}

11 KiB Raw Blame History