https://github.com/Xuyuanp/scrollbar.nvim

scrollbar for neovim
https://github.com/Xuyuanp/scrollbar.nvim

Last synced: about 1 month ago
JSON representation

scrollbar for neovim

• Host: GitHub
• URL: https://github.com/Xuyuanp/scrollbar.nvim
• Owner: Xuyuanp
• License: apache-2.0
• Created: 2020-09-17T08:32:12.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-06-16T10:21:14.000Z (almost 2 years ago)
• Last Synced: 2024-01-24T10:44:56.653Z (4 months ago)
• Language: Lua
• Size: 696 KB
• Stars: 255
• Watchers: 7
• Forks: 9
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-neovim - Xuyuanp/scrollbar.nvim - Scrollbar. (Scrolling / Scrollbar)
• awesome-stars - Xuyuanp/scrollbar.nvim - scrollbar for neovim (Lua)
• awesome-stars - Xuyuanp/scrollbar.nvim - scrollbar for neovim (Lua)
• awesome-stars - Xuyuanp/scrollbar.nvim - scrollbar for neovim (Lua)
• my-awesome-starred - Xuyuanp/scrollbar.nvim - scrollbar for neovim (Lua)
• awesome-stars - Xuyuanp/scrollbar.nvim - scrollbar for neovim (Lua)
• awesome-stars - Xuyuanp/scrollbar.nvim - scrollbar for neovim (Lua)
• awesome-neovim - Xuyuanp/scrollbar.nvim - Scrollbar. (Scrolling / Scrollbar)
• awesome-neovim - Xuyuanp/scrollbar.nvim - Scrollbar. (Scrolling / Scrollbar)

README

        
# scrollbar.nvim

[![Github Action](https://img.shields.io/github/workflow/status/Xuyuanp/scrollbar.nvim/CI)](https://github.com/Xuyuanp/scrollbar.nvim/actions?query=workflow%3ACI)

[![License](https://img.shields.io/github/license/Xuyuanp/scrollbar.nvim)](https://opensource.org/licenses/Apache-2.0)

[![GitHub Contributors](https://img.shields.io/github/contributors/Xuyuanp/scrollbar.nvim)](https://github.com/Xuyuanp/scrollbar.nvim/graphs/contributors)

scrollbar for neovim(nightly)

![](doc/preview.gif)

## Installation

Just use your favorite plugin manager. e.g. vim-plug:

```vim

Plug 'Xuyuanp/scrollbar.nvim'

```

## Startup

This plugin provides only two `lua` functions, `show` and `clear`. The following config is recommended.

```vim

augroup ScrollbarInit

  autocmd!

  autocmd WinScrolled,VimResized,QuitPre * silent! lua require('scrollbar').show()

  autocmd WinEnter,FocusGained           * silent! lua require('scrollbar').show()

  autocmd WinLeave,BufLeave,BufWinLeave,FocusLost            * silent! lua require('scrollbar').clear()

augroup end

```

**NOTE:** `clear` is NOT `disable`. To disable it, call `clear`, then remove all the autocommands.

## Options

See in doc `:h Scrollbar.nvim`.

## Similar Projects

* [minimap.vim](https://github.com/wfxr/minimap.vim) by @wfxr