https://github.com/tsuyoshicho/statuslineupdatetimer.vim
vim statusline periodic update plugin; Generic clock function attached.
https://github.com/tsuyoshicho/statuslineupdatetimer.vim
clock plugin vim
Last synced: 8 months ago
JSON representation
vim statusline periodic update plugin; Generic clock function attached.
- Host: GitHub
- URL: https://github.com/tsuyoshicho/statuslineupdatetimer.vim
- Owner: tsuyoshicho
- License: mit
- Created: 2018-09-12T03:55:46.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-06-01T06:58:08.000Z (about 1 year ago)
- Last Synced: 2025-06-01T15:24:46.092Z (about 1 year ago)
- Topics: clock, plugin, vim
- Language: Vim Script
- Homepage: https://tsuyoshicho.github.io/StatuslineUpdateTimer.vim/
- Size: 67.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# StatuslineUpdateTimer : vim statusline periodic update plugin
[](https://deepwiki.com/tsuyoshicho/StatuslineUpdateTimer.vim)
## attached
- Generic clock function - Common usage:statusline clock
## Installation
### [dein](https://github.com/Shougo/dein.vim)
Add this section in `dein.toml`.
```toml
[[plugins]]
repo = 'tsuyoshicho/StatuslineUpdateTimer.vim'
```
## Usage
Install via vim or plugin manager.
Vim statusline is updated automatically.
### Commands
When manually start.
```vim
:StatuslineUpdateStart
```
And then manually stop.
```vim
:StatuslineUpdateStop
```
### Option variable
```vim
g:StatuslineUpdateTimer#enable
```
Plugin enable/disable.
Set as before plugin load.
default value: `1`(enable) .
```vim
g:StatuslineUpdateTimer#updatetime
```
Statusline update interval.
Set as before plugin load.
default value: same as `updatetime`.
```vim
g:StatuslineUpdateTimer#adjust_minute
```
Update interval adjust next min+1sec point.
If set as enable, `g:StatuslineUpdateTimer#updatetime` are no affect.
```vim
g:StatuslineUpdateTimer#interval_function
```
Interval call function. default `redrawstatus!` call
```vim
g:StatuslineUpdateTimer#clockformat
```
Clock function format(strftime style).
default value: `'%m/%d(%a) %H:%M'`.
### Function
```vim
StatuslineUpdateTimer#clock()
```
Return formatted clock string.
```vim
StatuslineUpdateTimer#emoji_clock()
```
Return emoji clock string.
### Use-case
#### case 1. statusline direct setting
Write to `.vimrc`.
```vim
set statusline=%{StatuslineUpdateTimer#clock()}
```
#### case 2. lightline at dein
When use [dein](https://github.com/Shougo/dein.vim) plugin manager and [lightline](https://github.com/itchyny/lightline.vim) plugin,
write to `dein.toml`.
```toml
[[plugins]]
repo = 'itchyny/lightline.vim'
depends = ['StatuslineUpateTimer.vim']
hook_add = '''
let g:lightline = {
\ 'colorscheme': 'solarized',
\ 'active': {
\ 'left': [
\ [ 'mode', 'paste' ],
\ [ 'readonly', 'filename', 'modified' ]
\ ],
\ 'right': [
\ ['clock'],
\ ['lineinfo', 'percent'],
\ ['fileformat', 'fileencoding', 'filetype'],
\ ]
\ },
\ 'component_function': {
\ 'clock': 'StatuslineUpdateTimer#clock',
\ },
\ }
'''
```
#### case 3. sky-color-clock.vim
Setting : see [mopp/sky-color-clock.vim](https://github.com/mopp/sky-color-clock.vim)
## Limitation
Buffer refreshed by timer.
As a result, opening splash-string,multiline message disappears.
## Author
- Tsuyoshi CHO (https://github.com/tsuyoshicho)
## License
This software is released under the MIT License, see LICENSE.