mirror of
https://github.com/itchyny/lightline.vim.git
synced 2025-11-12 21:43:50 -05:00
update explanations for options in the help
This commit is contained in:
@@ -4,7 +4,7 @@ Version: 0.1
|
|||||||
Author: itchyny (https://github.com/itchyny)
|
Author: itchyny (https://github.com/itchyny)
|
||||||
License: MIT License
|
License: MIT License
|
||||||
Repository: https://github.com/itchyny/lightline.vim
|
Repository: https://github.com/itchyny/lightline.vim
|
||||||
Last Change: 2017/05/28 00:40:46.
|
Last Change: 2017/05/28 01:07:02.
|
||||||
|
|
||||||
CONTENTS *lightline-contents*
|
CONTENTS *lightline-contents*
|
||||||
|
|
||||||
@@ -54,17 +54,15 @@ SPIRIT *lightline-spirit*
|
|||||||
OPTIONS *lightline-option*
|
OPTIONS *lightline-option*
|
||||||
|
|
||||||
g:lightline *g:lightline*
|
g:lightline *g:lightline*
|
||||||
All the options are stored into this global variable.
|
All the configurations are stored in this global variable.
|
||||||
|
|
||||||
g:lightline.active *g:lightline.active*
|
g:lightline.active *g:lightline.active*
|
||||||
g:lightline.inactive *g:lightline.inactive*
|
g:lightline.inactive *g:lightline.inactive*
|
||||||
g:lightline.tabline *g:lightline.tabline*
|
g:lightline.tabline *g:lightline.tabline*
|
||||||
Dictionaries to specify the statusline/tabline components.
|
Dictionaries to store the statusline/tabline components.
|
||||||
The components are gathered from either |g:lightline.component|,
|
|
||||||
|g:lightline.component_function| or
|
|
||||||
|g:lightline.component_expand|.
|
|
||||||
Note that right groups of components are stored from right to
|
Note that right groups of components are stored from right to
|
||||||
left. The default values are:
|
left.
|
||||||
|
The default values are:
|
||||||
>
|
>
|
||||||
let g:lightline.active = {
|
let g:lightline.active = {
|
||||||
\ 'left': [ [ 'mode', 'paste' ],
|
\ 'left': [ [ 'mode', 'paste' ],
|
||||||
@@ -81,10 +79,7 @@ OPTIONS *lightline-option*
|
|||||||
\ 'right': [ [ 'close' ] ] }
|
\ 'right': [ [ 'close' ] ] }
|
||||||
<
|
<
|
||||||
g:lightline.tab *g:lightline.tab*
|
g:lightline.tab *g:lightline.tab*
|
||||||
Dictionaries to specify the components in each tabs.
|
A dictionary to store the tab components in each tabs.
|
||||||
The components are gathered from either
|
|
||||||
|g:lightline.tab_component| or
|
|
||||||
|g:lightline.tab_component_function|.
|
|
||||||
The default values are:
|
The default values are:
|
||||||
>
|
>
|
||||||
let g:lightline.tab = {
|
let g:lightline.tab = {
|
||||||
@@ -92,7 +87,7 @@ OPTIONS *lightline-option*
|
|||||||
\ 'inactive': [ 'tabnum', 'filename', 'modified' ] }
|
\ 'inactive': [ 'tabnum', 'filename', 'modified' ] }
|
||||||
<
|
<
|
||||||
g:lightline.component *g:lightline.component*
|
g:lightline.component *g:lightline.component*
|
||||||
Dictionary for statusline/tabline components.
|
A dictionary for statusline/tabline components.
|
||||||
The default value is:
|
The default value is:
|
||||||
>
|
>
|
||||||
let g:lightline.component = {
|
let g:lightline.component = {
|
||||||
@@ -119,11 +114,11 @@ OPTIONS *lightline-option*
|
|||||||
<
|
<
|
||||||
g:lightline.component_visible_condition
|
g:lightline.component_visible_condition
|
||||||
*g:lightline.component_visible_condition*
|
*g:lightline.component_visible_condition*
|
||||||
Dictionary to store the visible condition of the components.
|
A dictionary to store the visible condition of the components.
|
||||||
Each expression should correspond to the condition each
|
Note that this configuration is used to control the visibility
|
||||||
component is not empty. This configuration is used to control
|
of the subseparators, not to control the visibility of the
|
||||||
the visibility of the subseparators. You cannot use this
|
components themselves. Each expression should correspond to
|
||||||
configuration to control the visibility of the components.
|
the condition on which each component is not empty.
|
||||||
The default value is:
|
The default value is:
|
||||||
>
|
>
|
||||||
let g:lightline.component_visible_condition = {
|
let g:lightline.component_visible_condition = {
|
||||||
@@ -132,14 +127,11 @@ OPTIONS *lightline-option*
|
|||||||
\ 'paste': '&paste',
|
\ 'paste': '&paste',
|
||||||
\ 'spell': '&spell' }
|
\ 'spell': '&spell' }
|
||||||
<
|
<
|
||||||
Users are recommended to set this option together with the
|
|
||||||
component itself.
|
|
||||||
|
|
||||||
g:lightline.component_function *g:lightline.component_function*
|
g:lightline.component_function *g:lightline.component_function*
|
||||||
User can register component functions in this dictionary.
|
A dictionary to store the function components.
|
||||||
This is useful to write a complex component configuration and
|
This is useful to write a complex component configuration and
|
||||||
to integrate with other plugins. If a component set to both
|
to integrate with other plugins. If a component set in both
|
||||||
component and component_function, the setting of
|
component and component_function, the configuration of
|
||||||
component_function has priority.
|
component_function has priority.
|
||||||
|
|
||||||
The default value is:
|
The default value is:
|
||||||
@@ -147,7 +139,7 @@ OPTIONS *lightline-option*
|
|||||||
let g:lightline.component_function = {}
|
let g:lightline.component_function = {}
|
||||||
<
|
<
|
||||||
For example, if you want to display the name of the git branch,
|
For example, if you want to display the name of the git branch,
|
||||||
install vim-fugitive plugin and then configure as:
|
install |vim-fugitive| plugin and then configure as:
|
||||||
>
|
>
|
||||||
let g:lightline = {
|
let g:lightline = {
|
||||||
\ 'active': {
|
\ 'active': {
|
||||||
@@ -161,21 +153,21 @@ OPTIONS *lightline-option*
|
|||||||
<
|
<
|
||||||
g:lightline.component_function_visible_condition
|
g:lightline.component_function_visible_condition
|
||||||
*g:lightline.component_function_visible_condition*
|
*g:lightline.component_function_visible_condition*
|
||||||
Dictionary to store the visible conditions of the function
|
A dictionary to store the visible conditions of the function
|
||||||
components. Each expression should correspond to the condition
|
components. Each expression should correspond to the condition
|
||||||
each component is not empty. This configuration is used to
|
each component is not empty. This configuration is used to
|
||||||
control the visibility of the subseparators. You can use this
|
control the visibility of the subseparators. You can use this
|
||||||
configuration to reduce the number of function calls for
|
configuration to reduce the number of function calls for
|
||||||
function components by setting the value 1 (to tell lightline
|
performance improvement by setting the value 1 (to tell lightline
|
||||||
that the component is always visible).
|
that the component is always visible).
|
||||||
The default value is:
|
The default value is:
|
||||||
>
|
>
|
||||||
let g:lightline.component_function_visible_condition = {}
|
let g:lightline.component_function_visible_condition = {}
|
||||||
<
|
<
|
||||||
g:lightline.component_expand *g:lightline.component_expand*
|
g:lightline.component_expand *g:lightline.component_expand*
|
||||||
Another dictionary for components. You can create a component
|
A dictionary to store expanding components. You can create
|
||||||
which has a special color. For example, error components or
|
warning and critical components. The values should be the name
|
||||||
warning components. The functions should return one of:
|
of functions should return either one of:
|
||||||
+ a string
|
+ a string
|
||||||
+ an array of three elements:
|
+ an array of three elements:
|
||||||
[[ left ], [ middle ], [ right ]]
|
[[ left ], [ middle ], [ right ]]
|
||||||
@@ -282,7 +274,6 @@ OPTIONS *lightline-option*
|
|||||||
\ 'tabline': 1
|
\ 'tabline': 1
|
||||||
\ }
|
\ }
|
||||||
<
|
<
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
FONT *lightline-font*
|
FONT *lightline-font*
|
||||||
You can use the patched font you used for |vim-powerline| and |powerline|.
|
You can use the patched font you used for |vim-powerline| and |powerline|.
|
||||||
|
|||||||
Reference in New Issue
Block a user