s/component_func/component_function/, s/component_flag/component_visible_condition/ (sorry for breaking back conpatibility)

This commit is contained in:
itchyny
2013-08-23 07:35:01 +09:00
parent 8b76c73502
commit 9f7ef31d5f
3 changed files with 32 additions and 34 deletions

View File

@@ -4,7 +4,7 @@ Version: 0.0
Author: itchyny (https://github.com/itchyny)
License: MIT License
Repository: https://github.com/itchyny/lightline.vim
Last Change: 2013/08/22 22:34:41.
Last Change: 2013/08/23 07:11:18.
CONTENTS *lightline-contents*
@@ -60,23 +60,23 @@ OPTIONS *lightline-options*
\ 'lineinfo': '%3l:%-2v',
\ 'fugitive': '%{exists("*fugitive#head")?fugitive#head():""}' }
<
g:lightline.component_flag *g:lightline.component_flag*
g:lightline.component_visible_condition *g:lightline.component_visible_condition*
Dictionary of boolean expressions for the components.
Each expression corresponds to if the component have non-zero
length.
For example, the flag for paste component is:
Each expression should correspond to the condition each
component have non-zero length.
For example, the visible condition for paste component is:
>
let g:lightline.component_flag = {
let g:lightline.component_visible_condition = {
\ 'paste': '(&paste)' }
<
Users are recommended to set this option together with the
component itself.
g:lightline.component_func *g:lightline.component_func*
g:lightline.component_function *g:lightline.component_function*
Another dictionary for components. This is more convenient
because the user does not have to set both component and
component_flag. If a component set to both component and
component_func, the setting of component_func has priority.
component_visible_condition. If a component set to both component and
component_function, the setting of component_function has priority.
For example, if you want a component for read-only mark, which
disappears in help windows:
>
@@ -85,7 +85,7 @@ OPTIONS *lightline-options*
\ 'left': [ [ 'mode', 'paste' ],
\ [ 'myreadonly', 'filename', 'modified' ] ],
\ },
\ 'component_func': {
\ 'component_function': {
\ 'myreadonly': 'MyReadonly'
\ },
\ }
@@ -134,7 +134,7 @@ nice.
\ 'component': {
\ 'lineinfo': ' %3l:%-2v',
\ },
\ 'component_func': {
\ 'component_function': {
\ 'readonly': 'MyReadonly',
\ 'fugitive': 'MyFugitive'
\ },
@@ -155,7 +155,7 @@ look nice.
\ 'component': {
\ 'lineinfo': '⭡ %3l:%-2v',
\ },
\ 'component_func': {
\ 'component_function': {
\ 'readonly': 'MyReadonly',
\ 'fugitive': 'MyFugitive'
\ },
@@ -189,7 +189,7 @@ In order to define own component:
\ 'active': {
\ 'left': [ [ 'mode', 'paste' ], [ 'myfilename' ] ]
\ },
\ 'component_func': {
\ 'component_function': {
\ 'myfilename': 'MyFilename',
\ 'myreadonly': 'MyReadonly',
\ 'mymodified': 'MyModified',
@@ -244,7 +244,7 @@ A nice example for |vim-powerline| font users:
\ 'active': {
\ 'left': [ [ 'mode', 'paste' ], [ 'fugitive', 'filename' ] ]
\ },
\ 'component_func': {
\ 'component_function': {
\ 'fugitive': 'MyFugitive',
\ 'filename': 'MyFilename'
\ },