nvim-scrollview

nvim-scrollview is a Neovim plugin that displays (non-interactive) scrollbars. The plugin is customizable (see :help scrollview-configuration).

Requirements

• nvim>=0.5

Installation

A package manager can be used to install nvim-scrollview.

Examples

• Vim8 packages:
  • git clone https://github.com/dstein64/nvim-scrollview ~/.local/share/nvim/site/pack/plugins/start/nvim-scrollview
• Vundle:
  • Add Plugin 'dstein64/nvim-scrollview' to ~/.config/nvim/init.vim
  • :PluginInstall or $ nvim +PluginInstall +qall
• Pathogen:
  • git clone --depth=1 https://github.com/dstein64/nvim-scrollview ~/.local/share/nvim/site/bundle/nvim-scrollview
• vim-plug:
  • Add Plug 'dstein64/nvim-scrollview', { 'branch': 'main' } to ~/.config/nvim/init.vim
  • :PlugInstall or $ nvim +PlugInstall +qall
• dein.vim:
  • Add call dein#add('dstein64/nvim-scrollview') to ~/.config/nvim/init.vim
  • :call dein#install()
• NeoBundle:
  • Add NeoBundle 'dstein64/nvim-scrollview' to ~/.config/nvim/init.vim
  • Re-open Neovim or execute :source ~/.config/nvim/init.vim

Usage

• nvim-scrollview works automatically, displaying (non-interactive) scrollbars.
• The :ScrollViewDisable command disables scrollbars.
• The :ScrollViewEnable command enables scrollbars. This is only necessary if scrollbars have previously been disabled.
• The :ScrollViewRefresh command refreshes the scrollbars. This is relevant when the scrollbars are out-of-sync, which can occur as a result of some window arrangement actions.

Configuration

There are various settings that can be configured.

• Whether scrollbars are enabled or disabled on startup
• File types for which scrollbars should not be displayed
• Scrollbar color and transparency level
• Whether scrollbars should be displayed in all windows, or just the current window

Please see the documentation for details.

Documentation

Documentation can be accessed with:

:help nvim-scrollview

The underlying markup is in scrollview.txt.

License

The source code has an MIT License.

See LICENSE.