https://github.com/sslivkoff/vim-scroll-barnacle

a scrollbar for vim in the terminal
https://github.com/sslivkoff/vim-scroll-barnacle

vim vim-plugin vim-plugins

Last synced: 8 months ago
JSON representation

a scrollbar for vim in the terminal

• Host: GitHub
• URL: https://github.com/sslivkoff/vim-scroll-barnacle
• Owner: sslivkoff
• License: apache-2.0
• Created: 2020-03-01T23:40:38.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-02-02T10:06:52.000Z (over 5 years ago)
• Last Synced: 2025-04-19T17:57:45.265Z (about 1 year ago)
• Topics: vim, vim-plugin, vim-plugins
• Language: Vim script
• Size: 2.35 MB
• Stars: 14
• Watchers: 0
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          

# vim-scroll-barnacle

a scrollbar for vim in the terminal

![vim-scroll-barnacle demo](demo.gif)

## Features

- unicode characters for high-resolution

- mouse click support

- customizable colors and glyphs

## Install

- vundle: `Plugin 'sslivkoff/vim-scroll-barnacle'`

- vim-plug: `Plug 'sslivkoff/vim-scroll-barnacle'`

## Usage

#### Functions

- change scrollbar state with

    - `:ScrollbarToggle`

    - `:ScrollbarOn`

    - `:ScrollbarOff`

- can bind to keys e.g. `nnoremap   :ScrollbarToggle`

#### Configuration

- can put these in your vimrc, e.g. `let g:sb_default_behavior = "always"`

- `g:sb_default_behavior` whether scrollbar is on by default (default = `"overflow"`)

    - `"always"`: scrollbar always on

    - `"overflow"`: scrollbar on when buffer does not fit in window

    - `"never"`: scrollbar off by default

- `g:sb_bar_style` style to use for scrollbar (default = `"solid"`)

    - `"solid"` solid scrollbar using `▁▂▃▄▅▆▇█`

    - `"left dot"` dot scrollbar using `⠁⠂⠄⡀⠃⠆⡄⠇⡆⡇`

    - `"right dot"` dot scrollbar using `⠈⠐⠠⢀⠘⠰⢠⠸⢰⢸`

    - `"double dot"` dot scrollbar using `⠉⠒⠤⣀⠛⠶⣤⠿⣶⣿`

- `g:sb_patch_mouse` whether to patch mouse for mouse click events (default = `1`)

    - see section below

- `g:sb_patch_keys` whether to patch certain keys for scroll events (default = `1`)

- `Scrollbar` highlight group

    - change scrollbar color using the `Scrollbar` highlight group

    - e.g.

        - `highlight Scrollbar guifg=grey`

        - `highlight link Scrollbar Normal` [default]

        - `highlight link Scrollbar Comment`

## Implementation

- uses floating window, window has filetype `scrollbar`

- [gifine](https://github.com/leafo/gifine) and [vim-smoothie](https://github.com/psliwka/vim-smoothie) used for creating the gif in this readme

- weclome to suggestions, bug reports, and pull requests

## Shortcomings

- Neovim only for now

    - some `nvim_*` functions in the neovim [api](https://neovim.io/doc/user/api.html) were crucial for functionality and efficiency

    - suggestions on how to port to vim welcome

- Can only mouse click, not mouse drag

    - The vim mouse api is very limited

    - Clicking requires patching `` input

    - Can disable this patching with `let g:sb_patch_mouse = 0`

- Vim does not emit scroll events directly

    - Most actions that affect the scrollbar can be detected indirectly using vim events (e.g. `CursorMove` and `VimResize`)

    - However, some scroll actions are not detectable with events

    - ScrollBarnacle patches these key combinations so that they can affect the scrollbar: `zz`, `zt`, `zb`, ``, ``, ``, ``

    - You can disable this patching with `let g:sb_patch_keys = 0`

- Does not work with tabs

    - This is because there is no way to close floating windows in a tab when it is closed. Attempting to close the window results in an error.

    - A neovim patch is in the works, see [issue](https://github.com/neovim/neovim/issues/11440) and [WIP PR](https://github.com/neovim/neovim/pull/11938)

## Related Projects

- https://github.com/lornix/vim-scrollbar

- https://github.com/gcavallanti/vim-noscrollbar

- https://github.com/drzel/vim-line-no-indicator