Use (neo)vim terminal in the floating/popup window.
Features
- Support neovim floatwin and vim8 popupwin
- Manage multiple terminal instances
- Customizable terminal window style
- Switch/preview floating terminal buffers using fuzzy-finder plugins such as
denite.nvim or
fzf, etc.
- Use with other external command-line tools(ranger, fzf, ripgrep etc.)
- Use as a custom task runner for asynctasks.vim
or asyncrun.vim
Requirements
- Vim or neovim with
terminal feature
Installation
use 'voldikss/vim-floaterm'
Plug 'voldikss/vim-floaterm'
call dein#add('voldikss/vim-floaterm')
Get Started
Use :FloatermNew to open a terminal window, use :FloatermToggle to
hide/reopen that. The filetype of the terminal buffer is floaterm.
If you've opened multiple floaterm instances, they will be attached to a
double-circular-linkedlist. Then you can use :FloatermNext or
: FloatermPrev to switch between them.
❗️Note: Long-running jobs (e.g. yarn watch) inside the builtin terminal
would probably slowdown your operation. It's recommended to put them into the
external terminals.
Commands
:FloatermNew[!] [options] [cmd] Open a floaterm window.
- If
! is given, execute cmd in $SHELL. Try :FloatermNew python and
: FloatermNew! python to learn about the difference.
- If execute without
cmd, open $SHELL.
- The
options is formed as --key[=value], it is used to specify local
attributes of a specific floaterm instance. Note that in order to input
space, you have to form it as \ followed by space, and \ must be typed
as \\
cwd working directory that floaterm will be opened at. Accepts a
path, the literal <root> which represents the project root directory,
the literal <buffer> which specifies the directory of the active buffer,
or the literal <buffer-root> which corresponds to the project root
directory of the active buffer.name name of the floatermsilent If --silent is given, spawn a floaterm but not open the window,
you may toggle it afterwardsdisposable If --disposable is given, the floaterm will be destroyed
once it is hidden.title see g:floaterm_titlewidth see g:floaterm_widthheight see g:floaterm_heightopener see g:floaterm_openerwintype see g:floaterm_wintypeposition see g:floaterm_positionautoclose see g:floaterm_autocloseautoinsert see g:floaterm_autoinsertborderchars see g:floaterm_bordercharstitleposition see g:floaterm_titleposition
- This command basically shares the consistent behaviors with the builtin
:terminal:
- The special characters(
:help cmdline-special) such as % and <cfile>
will be auto-expanded, to get standalone characters, use \ followed by
the corresponding character(e.g., \%).
- Note that
<bar>(i.e., |) will be seen as an argument of the command,
therefore it can not be followed by another Vim command.
For example, the command
:FloatermNew --height=0.6 --width=0.4 --wintype=float --name=floaterm1 --position=topleft --autoclose=always ranger --cmd="cd ~"
will open a new floating/popup floaterm instance named floaterm1 running
ranger --cmd="cd ~" in the topleft corner of the main window.
The following command allows you to compile and run your C code in the floaterm window:
:FloatermNew --autoclose=never gcc % -o %< && ./%<
:FloatermPrev Switch to the previous floaterm instance
:FloatermNext Switch to the next floaterm instance
:FloatermFirst Switch to the first floaterm instance
:FloatermLast Switch to the last floaterm instance
:FloatermUpdate[!] [options] Update floaterm window attributes(height, width, etc.).
- The
options is the same as in :FloatermNew (except --silent).
- With
!, apply the update to every floaterm instance.
- Use
<TAB> to get completion.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
