Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/camspiers/animate.vim
A Vim Window Animation Library
https://github.com/camspiers/animate.vim
animation neovim neovim-plugin vim vim-plugin
Last synced: 10 days ago
JSON representation
A Vim Window Animation Library
- Host: GitHub
- URL: https://github.com/camspiers/animate.vim
- Owner: camspiers
- License: other
- Created: 2020-02-08T13:47:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-03-30T22:47:53.000Z (about 4 years ago)
- Last Synced: 2024-03-01T19:35:49.711Z (4 months ago)
- Topics: animation, neovim, neovim-plugin, vim, vim-plugin
- Language: Vim script
- Size: 20.5 KB
- Stars: 201
- Watchers: 5
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - camspiers/animate.vim - A Vim Window Animation Library (Vim Script)
- awesome-stars - camspiers/animate.vim - A Vim Window Animation Library (Vim Script)
README
```
█████╗ ███╗ ██╗██╗███╗ ███╗ █████╗ ████████╗███████╗ ██╗ ██╗██╗███╗ ███╗
██╔══██╗████╗ ██║██║████╗ ████║██╔══██╗╚══██╔══╝██╔════╝ ██║ ██║██║████╗ ████║
███████║██╔██╗ ██║██║██╔████╔██║███████║ ██║ █████╗ ██║ ██║██║██╔████╔██║
██╔══██║██║╚██╗██║██║██║╚██╔╝██║██╔══██║ ██║ ██╔══╝ ╚██╗ ██╔╝██║██║╚██╔╝██║
██║ ██║██║ ╚████║██║██║ ╚═╝ ██║██║ ██║ ██║ ███████╗██╗╚████╔╝ ██║██║ ╚═╝ ██║
╚═╝ ╚═╝╚═╝ ╚═══╝╚═╝╚═╝ ╚═╝╚═╝ ╚═╝ ╚═╝ ╚══════╝╚═╝ ╚═══╝ ╚═╝╚═╝ ╚═╝
```
# Animate.vim
A Vim Window Animation Library
`Animate.vim` is a general window animation library for Vim, it provides the ability
to animate window height and width via:
- `delta` from current size
- `percent` of screen
- `absolute` size
## Installation
To install `Animate.vim`, use your plugin manager of choice, e.g:
```
Plug 'camspiers/animate.vim'
```
## Usage
Given the general purpose nature of resizing windows `Animate.vim` can be used in many contexts.
The following gives and example of using animate to more smoothly change window size using the directional keys:
### Example: Animated Directional Keys
```
nnoremap :call animate#window_delta_height(10)
nnoremap :call animate#window_delta_height(-10)
nnoremap :call animate#window_delta_width(10)
nnoremap :call animate#window_delta_width(-10)
```
### Example: Animated FZF Bottom Drawer
Here is an example that integrates `Animate.vim` with Fuzzy Finder (FZF) to animate its opening:
```
let g:fzf_layout = {
\ 'window': 'new | wincmd J | resize 1 | call animate#window_percent_height(0.5)'
\ }
```
### Example: Animated Neovim Terminal Drawers
```
function! OpenAnimatedHtop() abort
" Open a htop in terminal
new term://htop
" Send window to bottom and start with small height
wincmd J | resize 1
" Animate height to 66%
call animate#window_percent_height(0.66)
endfunction
```
## Options
### Distribute Space
By default `Animate.vim` distributes space of non-animating windows while resizing
this can be destructive to intended window sizes when those sizes aren't fixed. To disable:
```
let g:animate#distribute_space = 0
```
### Duration
Animation duration in milliseconds can be controlled via a global flag:
```
let g:animate#duration = 300.0
```
### Easing
Animation easing can be controlled via a global flag:
```
let g:animate#easing_func = 'animate#ease_linear'
```
#### Easing Options
Currently there are 3 easing options available:
- `animate#ease_linear`
- `animate#ease_out_quad`
- `animate#ease_out_cubic`
- `animate#ease_in_out_sine` (default)
To set a custom easing function:
```
let g:animate#easing_func = 'animate#ease_out_cubic'
```
You can also set your own easing function using the following signature:
```
function! MyEasingFunction(elapsed, initial, delta, duration) abort
" return value
endfunction
let g:animate#easing_func = 'MyEasingFunction'
```
## API
### Delta Functions
Animate current window by delta:
```
animate#window_delta(width_delta, height_delta)
```
Animate current window by width delta:
```
animate#window_delta_width(delta)
```
Animate current window by height delta:
```
animate#window_delta_height(delta)
```
### Percent Functions
Animate current window by percent of screen:
```
animate#window_percent(width_percent, height_percent)
```
Animate current window by percent of screen width:
```
animate#window_percent_width(percent)
```
Animate current window by percent of screen height:
```
animate#window_percent_height(percent)
```
### Absolute Functions
Animate current window to absolute size:
```
animate#window_absolute(width, height)
```
Animate current window by absolute width:
```
animate#window_absolute_width(width)
```
Animate current window by absolute height:
```
animate#window_absolute_height(height)
```
### Helper Functions
Focus window:
```
function! animate#window_focus(target_window) abort
```
Determines with target window is animating:
```
function! animate#window_is_animating(target_window) abort
```
Get the current time as a float in milliseconds:
```
animate#time()
```
Get the available height factoring in cmdheight and status line:
```
animate#get_available_height()
```
Linear easing function:
```
animate#ease_linear(elapsed, initial, delta, duration)
```
Out quad easing function:
```
animate#ease_out_quad(elapsed, initial, delta, duration)
```
Out cubic easing function:
```
animate#ease_out_cubic(elapsed, initial, delta, duration)
```
In out sine easing function:
```
animate#ease_in_out_sine(elapsed, initial, delta, duration)
```