Add docs
This commit is contained in:
parent
d8a2a640e0
commit
7fc7175ed6
|
@ -264,7 +264,13 @@ sections = {
|
||||||
{
|
{
|
||||||
'mode',
|
'mode',
|
||||||
icon = nil, -- displays icon in front of the component
|
icon = nil, -- displays icon in front of the component
|
||||||
separator = nil, -- overwrites component_separators for 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 = {'', ''}`.
|
||||||
|
-- Where first element is left_separator and 2nd element is right separator.
|
||||||
|
-- Passing empty string disables that separator
|
||||||
condition = nil, -- condition function, component is loaded when function returns true
|
condition = nil, -- condition function, component is loaded when function returns true
|
||||||
-- custom color for component in format
|
-- custom color for component in format
|
||||||
-- color = {fg = '#rrggbb', bg= '#rrggbb', gui='style'}
|
-- color = {fg = '#rrggbb', bg= '#rrggbb', gui='style'}
|
||||||
|
|
|
@ -203,7 +203,13 @@ Local options~
|
||||||
{
|
{
|
||||||
'mode',
|
'mode',
|
||||||
icon = nil, -- displays icon in front of the component
|
icon = nil, -- displays icon in front of the component
|
||||||
separator = nil, -- overwrites component_separators for 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 = {'', ''}`.
|
||||||
|
-- Where first element is left_separator and 2nd element is right separator.
|
||||||
|
-- Passing empty string disables that separator
|
||||||
condition = nil, -- condition function, component is loaded when function returns true
|
condition = nil, -- condition function, component is loaded when function returns true
|
||||||
-- custom color for component in format
|
-- custom color for component in format
|
||||||
-- color = {fg = '#rrggbb', bg= '#rrggbb', gui='style'}
|
-- color = {fg = '#rrggbb', bg= '#rrggbb', gui='style'}
|
||||||
|
|
Loading…
Reference in New Issue