rob
/
lualine.nvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: generated vimdoc (#519) 

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This commit is contained in:
github-actions[bot] 2022-01-02 09:42:43 +06:00 committed by GitHub
parent 0382f89dc4
commit c2107f52e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 158 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

223
doc/lualine.txt
View File

@ -12,33 +12,33 @@ Table of Contents *lualine-table-of-contents*
============================================================================== ==============================================================================
1. lualine.nvim *lualine-lualine.nvim* 1. lualine.nvim *lualine-lualine.nvim*
A blazing fast and easy to configure Neovim statusline written in Lua A blazing fast and easy to configure Neovim statusline written in Lua.
`lualine.nvim` requires neovim 0.5 `lualine.nvim` requires Neovim >= 0.5.
CONTRIBUTING *lualine-contributing* CONTRIBUTING *lualine-contributing*
Feel free to create an issue/pr if you want to see anything else implemented. 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 If you have some question or need help with configuration, start a discussion
<https://github.com/nvim-lualine/lualine.nvim/discussions>. <https://github.com/nvim-lualine/lualine.nvim/discussions>.
Please read CONTRIBUTING.md <./CONTRIBUTING.md> before opening a pr. You can Please read CONTRIBUTING.md <./CONTRIBUTING.md> before opening a PR. You can
also help with documentation in wiki also help with documentation in the wiki
<https://github.com/nvim-lualine/lualine.nvim/wiki> <https://github.com/nvim-lualine/lualine.nvim/wiki>.
PERFORMANCE COMPARED TO OTHER PLUGINS*lualine-performance-compared-to-other-plugins* PERFORMANCE COMPARED TO OTHER PLUGINS*lualine-performance-compared-to-other-plugins*
Unlike other statusline plugins lualine loads only defined components, nothing Unlike other statusline plugins, lualine loads only the components you specify,
else. and nothing else.
Startup time performance measured with an amazing plugin Startup time performance measured with an amazing plugin
dstein64/vim-startuptime <https://github.com/dstein64/vim-startuptime> dstein64/vim-startuptime <https://github.com/dstein64/vim-startuptime>
All times are measured with clean `init.vim` with only `vim-startuptime`, Times are measured with a clean `init.vim` with only `vim-startuptime`,
`vim-plug` and given statusline plugin installed. In control just `vim-plug` and given statusline plugin installed. In control just
`vim-startuptime` and`vim-plug` is installed. And measured time is complete `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 startuptime of vim not time spent on specific plugin. These numbers are the
of 20 runs. average of 20 runs.
│control │ lualine │lightline│ airline │ │control │ lualine │lightline│ airline │
│8.943 ms│10.140 ms│12.522 ms│38.850 ms│ │8.943 ms│10.140 ms│12.522 ms│38.850 ms│
@ -80,29 +80,29 @@ Lualine has sections as shown below.
< <
Each sections holds it’s components e.g. current vim’s mode. Each sections holds its components e.g. Vim’s current mode.
*lualine-Configuring-lualine-in-init.vim* *lualine-Configuring-lualine-in-init.vim*
Configuring lualine in init.vim All the examples below are in lua. You Configuring lualine in init.vim All the examples below are in lua. You
can use the same examples in `.vim` file can use the same examples in `.vim`
by wrapping them in lua heredoc like files by wrapping them in lua heredoc
this: like this:
> >
lua << END lua << END
require'lualine'.setup() require('lualine').setup()
END END
< <
checkout `:help lua-heredoc`. For more information, check out `:help lua-heredoc`.
*lualine-Default-config* *lualine-Default-configuration*
> >
require'lualine'.setup { require('lualine').setup {
options = { options = {
icons_enabled = true, icons_enabled = true,
theme = 'auto', theme = 'auto',
@ -133,12 +133,12 @@ checkout `:help lua-heredoc`.
< <
Default config If you want to get your current lualine Default configuration If you want to get your current lualine
config. you can do so with config, you can do so with:
> >
require'lualine'.get_config() require('lualine').get_config()
< <
@ -160,18 +160,20 @@ SETTING A THEME ~
< <
All available themes are listed in THEMES.md <./THEMES.md> 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 Please create a PR if you managed to port a popular theme before us, here is
how to do it <./CONTRIBUTING.md>. how to do it <./CONTRIBUTING.md>.
*lualine-Customizing-themes* *lualine-Customizing-themes*
> >
local custom_gruvbox = require'lualine.themes.gruvbox' local custom_gruvbox = require'lualine.themes.gruvbox'
-- Change the background of lualine_c section for normal mode -- Change the background of lualine_c section for normal mode
custom_gruvbox.normal.c.bg = '#112233' -- RGB colors are supported custom_gruvbox.normal.c.bg = '#112233'
require'lualine'.setup{
require('lualine').setup {
options = { theme = custom_gruvbox }, options = { theme = custom_gruvbox },
... ...
} }
@ -179,18 +181,18 @@ how to do it <./CONTRIBUTING.md>.
Customizing themes Theme structure is available here Customizing themes Theme structure is available here
<https://github.com/nvim-lualine/lualine.nvim/wiki/Writting-a-theme> <https://github.com/nvim-lualine/lualine.nvim/wiki/Writing-a-theme>.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
SEPARATORS ~ SEPARATORS ~
Lualine defines two kinds of separators: lualine defines two kinds of separators:
- `section_separators` - separators between sections - `section_separators` - separators between sections
- `components_separators` - separators between components in sections - `components_separators` - separators between the different components in sections
> >
@ -201,8 +203,8 @@ Lualine defines two kinds of separators:
< <
Here left means it’ll be used for left sections (a, b, c) and right means Here, left refers to the left-most sections (a, b, c), and right refers to the
it’ll be used for right sections (x, y, z). right-most sections (x, y, z).
*lualine-Disabling-separators* *lualine-Disabling-separators*
@ -225,7 +227,7 @@ CHANGING COMPONENTS IN LUALINE SECTIONS ~
- `branch` (git branch) - `branch` (git branch)
- `buffers` (shows currently available buffers) - `buffers` (shows currently available buffers)
- `diagnostics` (diagnostics count from your prefered source) - `diagnostics` (diagnostics count from your preferred source)
- `diff` (git diff status) - `diff` (git diff status)
- `encoding` (file encoding) - `encoding` (file encoding)
- `fileformat` (file format) - `fileformat` (file format)
@ -280,13 +282,8 @@ use.
LUA EXPRESSIONS AS LUALINE COMPONENT LUA EXPRESSIONS AS LUALINE COMPONENT
You can use any valid lua expression as a component including You can use any valid lua expression as a component including: - oneliners -
global variables - require statements
- oneliners
- global variables
- require statements
> >
sections = { lualine_c = { "os.date('%a')", 'data', "require'lsp-status'.status()" } } sections = { lualine_c = { "os.date('%a')", 'data', "require'lsp-status'.status()" } }
@ -300,19 +297,15 @@ You can use any valid lua expression as a component including
COMPONENT OPTIONS ~ COMPONENT OPTIONS ~
Component options can change the way a component behave. There are two kinds of Component options can change the way a component behave. There are two kinds of
options: options: - global options affecting all components - local options affecting
specific
- global options affecting all components
- local options affecting specific
Global options can be used as local options (can be applied to 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 components) but you cannot use local options as global. Global option used
locally overwrites the global, for example: locally overwrites the global, for example:
> >
require'lualine'.setup { require('lualine').setup {
options = { fmt = string.lower }, options = { fmt = string.lower },
sections = { lualine_a = { sections = { lualine_a = {
{ 'mode', fmt = function(str) return str:sub(1,1) end } }, { 'mode', fmt = function(str) return str:sub(1,1) end } },
@ -371,46 +364,51 @@ General component options These are options that control behavior
icon = nil, -- Defines the icon to be displayed in front of 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. separator = nil, -- Determines what separator to use for the component.
-- Note:
-- When a string is provided it's treated as component_separator. -- When a string is provided it's treated as component_separator.
-- When a table is provided it's treated as section_separator. -- When a table is provided it's treated as section_separator.
-- Passing an empty string disables the separator.
--
-- These options can be used to set colored separators -- These options can be used to set colored separators
-- around a component. -- around a component.
-- --
-- The options need to be set like: -- The options need to be set as such:
-- separator = { left = '', right = ''} -- separator = { left = '', right = ''}
-- --
-- Where left will be placed on left side of component, -- Where left will be placed on left side of component,
-- and right will be placed on its right. -- 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`. cond = nil, -- Condition function, the component is loaded when the function returns `true`.
-- Custom color for the component in format -- Defines a custom color for the component:
-- 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' } -- 'highlight_group_name' | { fg = '#rrggbb'|cterm_value(0-255)|'color_name(red)', bg= '#rrggbb', gui='style' }
-- Note:
-- '|' is synonymous with 'or', meaning a different acceptable format for that placeholder.
-- --
-- Note: all other color options like diff_color including themes accept same color values -- Examples:
--
-- example:
-- color = { fg = '#ffaa88', bg = 'grey', gui='italic,bold' }, -- color = { fg = '#ffaa88', bg = 'grey', gui='italic,bold' },
-- color = {fg = 204} -- when fg/bg is skiped they default to themes fg/bg -- color = { fg = 204 } -- When fg/bg are omitted, they default to the your theme's fg/bg.
-- color = 'WarningMsg' -- highlight groups can also be used -- color = 'WarningMsg' -- Highlight groups can also be used.
-- --
color = nil, -- default is themes color for that section and mode color = nil, -- The default is your theme's color for that section and mode.
-- This option specifies what type a component is. -- Specify what type a component is, if omitted, lualine will guess it for you.
-- When it's omitted lualine will guess it for you.
-- --
-- Available types are: -- Available types are:
-- [format: type_name(example)], mod(branch/filename), -- [format: type_name(example)], mod(branch/filename),
-- stl(%f/%m), var(g:coc_status/bo:modifiable), -- stl(%f/%m), var(g:coc_status/bo:modifiable),
-- lua_expr(lua expressions), vim_fun(viml function name) -- lua_expr(lua expressions), vim_fun(viml function name)
-- --
-- lua_expr is short for lua-expression and vim_fun is short fror vim-function -- Note:
-- lua_expr is short for lua-expression and vim_fun is short for vim-function.
type = nil, type = nil,
padding = 1, -- Adds padding to the left and right of components. padding = 1, -- Adds padding to the left and right of components.
-- Padding can be specified to left or right independently, e.g.: -- Padding can be specified to left or right independently, e.g.:
-- padding = { left = left_padding, right = right_padding } -- padding = { left = left_padding, right = right_padding }
fmt = nil, -- Format function, formats the component's output. fmt = nil, -- Format function, formats the component's output.
} }
} }
@ -427,18 +425,20 @@ Component specific options These are options that are available on
will be. will be.
*lualine-buffers-component-options* *lualine-`buffers`-component-options*
> >
sections = { sections = {
lualine_a = { lualine_a = {
{ {
'buffers', 'buffers',
show_filename_only = true, -- Shows shortened relative path when set to false show_filename_only = true, -- Shows shortened relative path when set to false.
show_modified_status = true, -- Shows indicator then buffer is modified show_modified_status = true, -- Shows indicator when the buffer is modified.
mode = 0, -- 0: Shows buffer name mode = 0, -- 0: Shows buffer name
-- 1: Shows buffer index (bufnr) -- 1: Shows buffer index (bufnr)
-- 2: Shows buffer name + buffer index (bufnr) -- 2: Shows buffer name + buffer index (bufnr)
max_length = vim.o.columns * 2 / 3, -- Maximum width of buffers component, max_length = vim.o.columns * 2 / 3, -- Maximum width of buffers component,
-- it can also be a function that returns -- it can also be a function that returns
-- the value of `max_length` dynamically. -- the value of `max_length` dynamically.
@ -449,10 +449,11 @@ Component specific options These are options that are available on
fzf = 'FZF', fzf = 'FZF',
alpha = 'Alpha' alpha = 'Alpha'
}, -- Shows specific buffer name for that filetype ( { `filetype` = `buffer_name`, ... } ) }, -- Shows specific buffer name for that filetype ( { `filetype` = `buffer_name`, ... } )
buffers_color = { buffers_color = {
-- Same values like general color option can be used here. -- Same values as the general color option can be used here.
active = 'lualine_{section}_normal', -- Color for active buffer active = 'lualine_{section}_normal', -- Color for active buffer.
inactive = 'lualine_{section}_inactive', -- Color for inactive buffer inactive = 'lualine_{section}_inactive', -- Color for inactive buffer.
}, },
} }
} }
@ -460,54 +461,57 @@ Component specific options These are options that are available on
< <
*lualine-diagnostics-component-options* *lualine-`diagnostics`-component-options*
> >
sections = { sections = {
lualine_a = { lualine_a = {
{ {
'diagnostics', 'diagnostics',
-- Table of diagnostic sources, available sources are: -- Table of diagnostic sources, available sources are:
-- 'nvim_lsp', 'nvim_diagnostic', 'coc', 'ale', 'vim_lsp'. -- 'nvim_lsp', 'nvim_diagnostic', 'coc', 'ale', 'vim_lsp'.
-- or a function that returns a table like: -- or a function that returns a table as such:
-- { error=error_cnt, warn=warn_cnt, info=info_cnt, hint=hint_cnt } -- { error=error_cnt, warn=warn_cnt, info=info_cnt, hint=hint_cnt }
sources = { 'nvim_diagnostic', 'coc' }, sources = { 'nvim_diagnostic', 'coc' },
-- displays diagnostics from defined severity
-- Displays diagnostics for the defined severity types
sections = { 'error', 'warn', 'info', 'hint' }, sections = { 'error', 'warn', 'info', 'hint' },
diagnostics_color = { diagnostics_color = {
-- Same values like general color option can be used here. -- Same values as the general color option can be used here.
error = 'DiagnosticError', -- Changes diagnostics' error color error = 'DiagnosticError', -- Changes diagnostics' error color.
warn = 'DiagnosticWarn', -- Changes diagnostics' warn color warn = 'DiagnosticWarn', -- Changes diagnostics' warn color.
info = 'DiagnosticInfo', -- Changes diagnostics' info color info = 'DiagnosticInfo', -- Changes diagnostics' info color.
hint = 'DiagnosticHint', -- Changes diagnostics' hint color hint = 'DiagnosticHint', -- Changes diagnostics' hint color.
}, },
symbols = {error = 'E', warn = 'W', info = 'I', hint = 'H'}, symbols = {error = 'E', warn = 'W', info = 'I', hint = 'H'},
colored = true, -- Displays diagnostics status in color if set to true colored = true, -- Displays diagnostics status in color if set to true.
update_in_insert = false, -- Update diagnostics in insert mode update_in_insert = false, -- Update diagnostics in insert mode.
always_visible = false, -- Show diagnostics even if there are none always_visible = false, -- Show diagnostics even if there are none.
} }
} }
} }
< <
*lualine-diff-component-options* *lualine-`diff`-component-options*
> >
sections = { sections = {
lualine_a = { lualine_a = {
{ {
'diff', 'diff',
colored = true, -- Displays diff status in color if set to true colored = true, -- Displays a colored diff status if set to true
diff_color = { diff_color = {
-- Same values like general color option can be used here. -- Same color values as the general color option can be used here.
added = 'DiffAdd', -- Changes the diff's added color added = 'DiffAdd', -- Changes the diff's added color
modified = 'DiffChange', -- Changes the diff's modified color modified = 'DiffChange', -- Changes the diff's modified color
removed = 'DiffDelete', -- Changes the diff's removed color you removed = 'DiffDelete', -- Changes the diff's removed color you
}, },
symbols = {added = '+', modified = '~', removed = '-'}, -- Changes the symbols used by the diff symbols = {added = '+', modified = '~', removed = '-'}, -- Changes the symbols used by the diff.
source = nil, -- A function that works as a data source for diff. source = nil, -- A function that works as a data source for diff.
-- It must return a table like: -- It must return a table as such:
-- { added = add_count, modified = modified_count, removed = removed_count } -- { added = add_count, modified = modified_count, removed = removed_count }
-- or nil on failure. count <= 0 won't be displayed. -- or nil on failure. count <= 0 won't be displayed.
} }
@ -516,7 +520,7 @@ Component specific options These are options that are available on
< <
*lualine-fileformat-component-options* *lualine-`fileformat`-component-options*
> >
sections = { sections = {
@ -534,7 +538,7 @@ Component specific options These are options that are available on
< <
*lualine-filename-component-options* *lualine-`filename`-component-options*
> >
sections = { sections = {
@ -546,13 +550,12 @@ Component specific options These are options that are available on
-- 1: Relative path -- 1: Relative path
-- 2: Absolute path -- 2: Absolute path
shorting_target = 40, -- Shortens path to leave 40 spaces in the window shorting_target = 40, -- Shortens path to leave 40 spaces in the window
-- for other components. (terrible name, any suggestions?) -- for other components. (terrible name, any suggestions?)
symbols = { symbols = {
modified = '[+]', -- Text to show when the file is modified modified = '[+]', -- Text to show when the file is modified.
readonly = '[-]', -- Text to show when the file is non-modifiable or readonly readonly = '[-]', -- Text to show when the file is non-modifiable or readonly.
unnamed = '[No Name]', -- Text to show for unnamed buffers unnamed = '[No Name]', -- Text to show for unnamed buffers.
} }
} }
} }
@ -560,7 +563,7 @@ Component specific options These are options that are available on
< <
*lualine-filetype-component-options* *lualine-`filetype`-component-options*
> >
sections = { sections = {
@ -575,24 +578,25 @@ Component specific options These are options that are available on
< <
*lualine-tabs-component-options* *lualine-`tabs`-component-options*
> >
sections = { sections = {
lualine_a = { lualine_a = {
{ {
'tabs', 'tabs',
max_length = vim.o.columns / 3, -- Maximum width of tabs component, max_length = vim.o.columns / 3, -- Maximum width of tabs component.
-- it can also be a function that returns -- Note:
-- It can also be a function that returns
-- the value of `max_length` dynamically. -- the value of `max_length` dynamically.
mode = 0, -- 0: Shows tab_nr mode = 0, -- 0: Shows tab_nr
-- 1: Shows tab_name -- 1: Shows tab_name
-- 2: Shows tab_nr + tab_name -- 2: Shows tab_nr + tab_name
tabs_color = { tabs_color = {
-- Same values like general color option can be used here. -- Same values as the general color option can be used here.
active = 'lualine_{section}_normal', -- color for active tab active = 'lualine_{section}_normal', -- Color for active tab.
inactive = 'lualine_{section}_inactive', -- color for inactive tab inactive = 'lualine_{section}_inactive', -- Color for inactive tab.
}, },
} }
} }
@ -605,7 +609,7 @@ Component specific options These are options that are available on
TABLINE ~ TABLINE ~
You can use lualine to display components in tabline. The configuration for You can use lualine to display components in tabline. The configuration for
tabline sections is exactly the same as for statusline. tabline sections is exactly the same as that of the statusline.
> >
tabline = { tabline = {
@ -619,10 +623,11 @@ tabline sections is exactly the same as for statusline.
< <
This will show branch and filename component in top of neovim inside tabline. This will show the branch and filename components on top of neovim inside
tabline.
lualine also provides 2 components buffers & tabs that you can use to get more lualine also provides 2 components, buffers and tabs, that you can use to get a
traditional tabline/bufferline. more traditional tabline/bufferline.
> >
tabline = { tabline = {
@ -636,9 +641,9 @@ traditional tabline/bufferline.
< <
You can also completely move your statusline to tabline by configuring You can also completely move your statusline to a tabline by configuring
`lualine.tabline` and disabling `lualine.sections` and `lualine.tabline` and disabling `lualine.sections` and
`lualine.inactive_sections`. `lualine.inactive_sections`:
> >
tabline = { tabline = {
@ -650,21 +655,21 @@ You can also completely move your statusline to tabline by configuring
If you want a more sophisticated tabline you can use other tabline plugins with If you want a more sophisticated tabline you can use other tabline plugins with
lualine too. For example: lualine too, for example:
- nvim-bufferline <https://github.com/akinsho/nvim-bufferline.lua> - nvim-bufferline <https://github.com/akinsho/nvim-bufferline.lua>
- tabline.nvim <https://github.com/kdheepak/tabline.nvim> - tabline.nvim <https://github.com/kdheepak/tabline.nvim>
tabline.nvim even uses lualines theme by default 🙌 You can find a bigger tabline.nvim even uses lualine’s theme by default 🙌 You can find a bigger
list here <https://github.com/rockerBOO/awesome-neovim#tabline> list here <https://github.com/rockerBOO/awesome-neovim#tabline>.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
EXTENSIONS ~ EXTENSIONS ~
Lualine extensions change statusline appearance for a window/buffer with lualine extensions change statusline appearance for a window/buffer with
specified filetypes. specified filetypes.
By default no extensions are loaded to improve performance. You can load By default no extensions are loaded to improve performance. You can load
@ -692,13 +697,13 @@ extensions with:
*lualine-Custom-extensions* *lualine-Custom-extensions*
Custom extensions You can define your own extensions. If Custom extensions You can define your own extensions. If
you think an extension might be useful you believe an extension may be useful
for others then please submit a pr. to others, then please submit a PR.
> >
local my_extension = { sections = { lualine_a = {'mode'} }, filetypes = {'lua'} } local my_extension = { sections = { lualine_a = {'mode'} }, filetypes = {'lua'} }
require'lualine'.setup {extensions = {my_extension}} require('lualine').setup { extensions = { my_extension } }
< <
@ -706,7 +711,7 @@ Custom extensions You can define your own extensions. If
DISABLING LUALINE ~ DISABLING LUALINE ~
You can disable lualine for specific filetypes You can disable lualine for specific filetypes:
> >
options = { disabled_filetypes = {'lua'} } options = { disabled_filetypes = {'lua'} }