674 lines
19 KiB
Markdown
674 lines
19 KiB
Markdown
# lualine.nvim
|
|
|
|
<!-- panvimdoc-ignore-start -->
|
|
|
|
|
|
|
|
|
|
<!-- panvimdoc-ignore-end -->
|
|
|
|
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](https://github.com/nvim-lualine/lualine.nvim/discussions).
|
|
|
|
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) before opening a pr.
|
|
You can also help with documentation in [wiki](https://github.com/nvim-lualine/lualine.nvim/wiki)
|
|
|
|
<!-- panvimdoc-ignore-start -->
|
|
|
|
## Screenshots
|
|
|
|
Here is a preview of how lualine can look like.
|
|
|
|
<p>
|
|
<img width='700' src='https://user-images.githubusercontent.com/41551030/108650373-bb025580-74bf-11eb-8682-2c09321dd18e.png'/>
|
|
<img width='700' src='https://user-images.githubusercontent.com/41551030/108650377-bd64af80-74bf-11eb-9c55-fbfc51b39fe8.png'/>
|
|
<img width='700' src='https://user-images.githubusercontent.com/41551030/108650378-be95dc80-74bf-11eb-9718-82b242ecdd54.png'/>
|
|
<img width='700' src='https://user-images.githubusercontent.com/41551030/108650381-bfc70980-74bf-11eb-9245-85c48f0f154a.png'/>
|
|
<img width='700' src='https://user-images.githubusercontent.com/41551030/103467925-32372b00-4d54-11eb-88d6-6d39c46854d8.png'/>
|
|
</p>
|
|
|
|
Screenshots of all available themes are listed in [THEMES.md](./THEMES.md)
|
|
|
|
For those who want to break the norms. You can create custom looks in lualine.
|
|
|
|
**Example** :
|
|
|
|
- [evil_lualine](examples/evil_lualine.lua)
|
|
<img width='700' src='https://user-images.githubusercontent.com/13149513/113875129-4453ba00-97d8-11eb-8f21-94a9ef565db3.png'/>
|
|
- [slanted-gaps](examples/slanted-gaps.lua)
|
|
<img width='700' src='https://user-images.githubusercontent.com/13149513/143395518-f6d6f748-c1ca-491b-9dab-246d0a8cf23f.png'/>
|
|
- [bubbles](examples/bubbles.lua)
|
|
<img width='700' src='https://user-images.githubusercontent.com/20235646/131350468-fc556196-5f46-4bfe-a72e-960f6a58db2c.png'/>
|
|
|
|
<!-- panvimdoc-ignore-end -->
|
|
|
|
## 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](https://github.com/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` and`vim-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](https://github.com/junegunn/vim-plug)
|
|
|
|
```vim
|
|
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](https://github.com/wbthomason/packer.nvim)
|
|
|
|
```lua
|
|
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:
|
|
|
|
```vim
|
|
lua << END
|
|
require'lualine'.setup()
|
|
END
|
|
```
|
|
|
|
checkout `:help lua-heredoc`.
|
|
|
|
#### Default config
|
|
|
|
```lua
|
|
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
|
|
|
|
```lua
|
|
require'lualine'.get_config()
|
|
|
|
```
|
|
|
|
---
|
|
|
|
### Starting lualine
|
|
|
|
```lua
|
|
require('lualine').setup()
|
|
```
|
|
|
|
---
|
|
|
|
### Setting a theme
|
|
|
|
```lua
|
|
options = {theme = 'gruvbox'}
|
|
```
|
|
|
|
All available themes are listed in [THEMES.md](./THEMES.md)
|
|
|
|
Please create a pr if you managed to port a popular theme before me, [here is how to do it](./CONTRIBUTING.md).
|
|
|
|
#### Customizing themes
|
|
|
|
```lua
|
|
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](https://github.com/nvim-lualine/lualine.nvim/wiki/Writting-a-theme)
|
|
|
|
---
|
|
|
|
### Separators
|
|
|
|
Lualine defines two kinds of separators:
|
|
|
|
- `section_separators` - separators between sections
|
|
- `components_separators` - separators between components in sections
|
|
|
|
```lua
|
|
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
|
|
|
|
```lua
|
|
options = {section_separators = '', component_separators = ''}
|
|
```
|
|
|
|
---
|
|
|
|
### Changing components in lualine sections
|
|
|
|
```lua
|
|
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
|
|
|
|
```lua
|
|
local function hello()
|
|
return [[hello world]]
|
|
end
|
|
sections = {lualine_a = {hello}}
|
|
```
|
|
|
|
##### Vim functions as lualine component
|
|
|
|
```lua
|
|
sections = {lualine_a = {'FugitiveHead'}}
|
|
```
|
|
|
|
##### Vim's statusline items as lualine component
|
|
|
|
```lua
|
|
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.
|
|
|
|
```lua
|
|
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
|
|
|
|
```lua
|
|
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:
|
|
|
|
```lua
|
|
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.
|
|
|
|
```lua
|
|
options = {
|
|
theme = 'auto', -- lualine theme
|
|
component_separators = {left = '', right = ''},
|
|
section_separators = {left = '', right = ''},
|
|
disabled_filetypes = {}, -- filetypes to diable lualine on
|
|
always_divide_middle = true, -- When true left_sections (a,b,c) can't
|
|
-- take over entiee statusline even
|
|
-- when none of section x, y, z is present.
|
|
}
|
|
```
|
|
|
|
#### General component options
|
|
|
|
These are options that control behavior at component level
|
|
and are available for all components.
|
|
|
|
```lua
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'mode',
|
|
icons_enabled = true, -- displays icons in alongside component
|
|
icon = nil, -- displays icon in front of the component
|
|
separator = nil, -- Determines what separator to use for the component.
|
|
-- when a string is given it's treated as component_separator.
|
|
-- When a table is given it's treated as section_separator.
|
|
-- This options can be used to set colored separators
|
|
-- arround component. Option need to be set like
|
|
-- `separator = { left = '', right = ''}`.
|
|
-- Where left will be placed in left side of component
|
|
-- and right will be placed in right side of component
|
|
-- Passing empty string disables that separator
|
|
cond = nil, -- condition function, component is loaded when function returns true
|
|
-- custom color for the component in format
|
|
-- here '|' refers to or meaning a different acceptable format for that placeholder
|
|
-- 'highlight_group_name' | {fg = '#rrggbb'|cterm_value(0-255)|'color_name(red)', bg= '#rrggbb', gui='style'}
|
|
-- Note: all other color options including themes accept like diff_color 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'
|
|
-- or highlight group
|
|
-- color = "WarningMsg"
|
|
color = nil, -- default is themes color for that section and mode
|
|
-- Type option specifies what type a component is.
|
|
-- When type is omitted lualine will guess it.
|
|
-- Available types [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 separately like
|
|
-- padding = { left = left_padding, right = right_padding }
|
|
fmt = nil, -- format function, formats 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
|
|
|
|
```lua
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'buffers',
|
|
show_filename_only = true, -- shows shortened relative path when false
|
|
show_modified_status = true, -- shows indicator then buffer is modified
|
|
mode = 0, -- 0 shows buffer name
|
|
-- 1 buffer index (bufnr)
|
|
-- 2 shows buffer name + buffer index (bufnr)
|
|
max_length = vim.o.columns * 2 / 3, -- maximum width of buffers component
|
|
-- can also be a function that returns value of max_length dynamicaly
|
|
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
|
|
|
|
```lua
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'diagnostics',
|
|
-- table of diagnostic sources, available sources:
|
|
-- '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 diagnostic's error color
|
|
warn = 'DiagnosticWarn', -- changes diagnostic's warn color
|
|
info = 'DiagnosticInfo', -- changes diagnostic's info color
|
|
hint = 'DiagnosticHint', -- changes diagnostic's 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 count is 0, boolean or function returning boolean
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
#### diff component options
|
|
|
|
```lua
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'diff',
|
|
colored = true, -- displays diff status in color if set to true
|
|
-- all colors are in format #rrggbb
|
|
diff_color = {
|
|
-- Same values like general color option can be used here.
|
|
added = 'DiffAdd', -- changes diff's added color
|
|
modified = 'DiffChange', -- changes diff's modified color
|
|
removed = 'DiffDelete', -- changes diff's removed color you
|
|
},
|
|
symbols = {added = '+', modified = '~', removed = '-'}, -- changes diff symbols
|
|
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
|
|
|
|
```lua
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'fileformat',
|
|
symbols = {
|
|
unix = '', -- e712
|
|
dos = '', -- e70f
|
|
mac = '', -- e711
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
#### filename component options
|
|
|
|
```lua
|
|
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
|
|
shorting_target = 40, -- Shortens path to leave 40 space in the window
|
|
-- for other components. Terrible name any suggestions?
|
|
symbols = {
|
|
modified = '[+]', -- when the file was modified
|
|
readonly = '[-]', -- if the file is not modifiable or readonly
|
|
unnamed = '[No Name]', -- default display name for unnamed buffers
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
#### filetype component options
|
|
|
|
```lua
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'filetype',
|
|
colored = true, -- displays filetype icon in color if set to `true
|
|
icon_only = false -- Display only icon for filetype
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
#### tabs component options
|
|
|
|
```lua
|
|
sections = {
|
|
lualine_a = {
|
|
{
|
|
'tabs',
|
|
max_length = vim.o.columns / 3, -- maximum width of tabs component
|
|
-- can also be a function that returns value of max_length dynamicaly
|
|
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.
|
|
|
|
```lua
|
|
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.
|
|
|
|
```lua
|
|
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`.
|
|
|
|
```lua
|
|
tabline = {
|
|
......
|
|
},
|
|
sections = {},
|
|
inactive_sections = {},
|
|
```
|
|
|
|
If you want a more sophisticated tabline you can use other
|
|
tabline plugins with lualine too . For example:
|
|
|
|
- [nvim-bufferline](https://github.com/akinsho/nvim-bufferline.lua)
|
|
- [tabline.nvim](https://github.com/kdheepak/tabline.nvim)
|
|
|
|
tabline.nvim even uses lualines theme by default 🙌
|
|
You can find a bigger list [here](https://github.com/rockerBOO/awesome-neovim#tabline)
|
|
|
|
---
|
|
|
|
### 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:
|
|
|
|
```lua
|
|
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.
|
|
|
|
```lua
|
|
local my_extension = {sections = {lualine_a = {'mode'}}, filetypes = {'lua'}}
|
|
require'lualine'.setup {extensions = {my_extension}}
|
|
```
|
|
|
|
---
|
|
|
|
### Disabling lualine
|
|
|
|
You can disable lualine for specific filetypes
|
|
|
|
```lua
|
|
options = {disabled_filetypes = {'lua'}}
|
|
```
|
|
|
|
<!-- panvimdoc-ignore-start -->
|
|
|
|
### Contributors
|
|
|
|
Thanks to these wonderful people we enjoy this awesome plugin.
|
|
|
|
<a href="https://github.com/nvim-lualine/lualine.nvim/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=nvim-lualine/lualine.nvim" />
|
|
</a>
|
|
|
|
### Wiki
|
|
|
|
Check out the [wiki](https://github.com/nvim-lualine/lualine.nvim/wiki) for more info .
|
|
|
|
You can find some useful [configuration snippets](https://github.com/nvim-lualine/lualine.nvim/wiki/Component-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](https://github.com/nvim-lualine/lualine.nvim/wiki/Plugins) is for you.
|
|
|
|
<!-- panvimdoc-ignore-end -->
|