Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Iron-E/nvim-tabmode
A rewrite of Iron-E/vim-tabmode using Iron-E/nvim-libmodal
https://github.com/Iron-E/nvim-tabmode
modal-editing neovim nvim nvim-libmodal tabmode tabs tabs-management vim vim-plugin vim-tabmode
Last synced: about 2 months ago
JSON representation
A rewrite of Iron-E/vim-tabmode using Iron-E/nvim-libmodal
- Host: GitHub
- URL: https://github.com/Iron-E/nvim-tabmode
- Owner: Iron-E
- License: other
- Created: 2020-05-15T21:52:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-17T20:03:46.000Z (over 1 year ago)
- Last Synced: 2024-05-22T18:31:51.226Z (4 months ago)
- Topics: modal-editing, neovim, nvim, nvim-libmodal, tabmode, tabs, tabs-management, vim, vim-plugin, vim-tabmode
- Language: Lua
- Size: 29.3 KB
- Stars: 20
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Description
`nvim-tabmode` is a plugin that provides a new mode in Neo/vim for managing tabs.
Although it is recommended that splits and buffers are used over tabs when possible, there _are_ scenarios when tabs are necessary. This plugin hopes to make that easier.
## Installation
Either use `packadd` or any package manager. I recommend using [lazy.nvim](https://github.com/folke/lazy.nvim).
### Requirements
* Neovim 0.7+
* [nvim-libmodal](https://github.com/Iron-E/nvim-libmodal)
* [vim-tabmode](https://github.com/Iron-E/vim-tabmode) is __NOT__ installed.
### Examples
`lazy.nvim`:
```lua
{'Iron-E/nvim-tabmode',
cmd = 'TabmodeEnter', -- don't load until using this command
config = true, -- automatically call `bufmode.setup()`; not needed if you specify `opts`
dependencies = {'Iron-E/nvim-libmodal'},
keys = {{'', desc = 'Enter buffer mode', mode = 'n'}}, -- don't load until pressing these keys
-- opts = {}, (put `setup` options here, e.g. `opts = {enter_mapping = false}`
},
```
Other examples:
* [dein.vim](https://github.com/Shougo/dein.vim):
* Add `call dein#add('https://github.com/Iron-E/nvim-bufmode')` to `~/.config/nvim/init.vim`
* `:call dein#install()`
* [NeoBundle](https://github.com/Shougo/neobundle.vim):
* Add `NeoBundle 'https://github.com/Iron-E/nvim-bufmode'` to `~/.config/nvim/init.vim`
* Re-open vim or execute `:source ~/.vimrc`
* [vim-plug](https://github.com/junegunn/vim-plug):
* Add `Plug 'https://github.com/Iron-E/nvim-bufmode'` to `~/.config/nvim/init.vim`
* `:PlugInstall` or `$ vim +PlugInstall +qall`
* [Vundle](https://github.com/gmarik/vundle):
* Add `Plugin 'https://github.com/Iron-E/nvim-bufmode'` to `~/.config/nvim/init.vim`
* `:PluginInstall` or `$ vim +PluginInstall +qall`
## Usage
Enter `nvim-tabmode` with `` or `:TabmodeEnter`.
| Key | Use |
|:-----------:|:------------------------------------------------------:|
| `` | Leave `tabmode` |
| `?` | Show help message |
| `^`/`0` | Go to the beginning of the tab list. |
| `` | Move the current tab to the beginning of the tab list. |
| `$` | Go to the end of the tab list. |
| `%` | Move the current tab to the end of the tab list. |
| `b`/`j`/`h` | Tab left |
| `w`/`k`/`l` | Tab right |
| `a` | Append a tab and switch to it. |
| `A` | Append a tab to the end and switch to it. |
| `i` | Prepend a tab and switch to it. |
| `I` | Prepend a tab to the beginning and switch to it. |
| `d` | Delete the current tab. |
| `s` | Replace the current tab with a new tab. |
See `:help tabmode-usage` for additional details.
## Configuration
To customize the plugin, set `vim.g.bufmode_mappings` before loading it, or call
`setup` after:
```vim
let g:bufmode_mappings = {
\ '$': 'tablast',
\ '%': '$tabmove',
\ ')': '0tabmove',
\ '0': 'tabfirst',
\ '?': 'help tabmode-usage',
\ 'a': 'tabnew',
\ 'A': '$tabnew',
\ 'b': 'tabprevious',
\ 'B': '-tabmove',
\ 'd': 'tabclose',
\ 'i': '-tabnew',
\ 'I': '0tabnew',
}
```
```lua
require('tabmode').setup {
enter_mapping = '', -- false to disable
bufferline = false, -- add bufferline.nvim keymaps
barbar = false, -- add barbar.nvim keymaps
keymaps = { -- defaults:
['$'] = 'tablast',
['%'] = '$tabmove',
[')'] = '0tabmove',
['0'] = 'tabfirst',
['?'] = 'help tabmode-usage',
['a'] = 'tabnew',
['A'] = '$tabnew',
['b'] = 'tabprevious',
['B'] = '-tabmove',
['d'] = 'tabclose',
['i'] = '-tabnew',
['I'] = '0tabnew',
}
}
```