https://github.com/wsdjeg/scrollbar.nvim
floating scrollbar plugin for neovim
https://github.com/wsdjeg/scrollbar.nvim
neovim-plugin
Last synced: 25 days ago
JSON representation
floating scrollbar plugin for neovim
- Host: GitHub
- URL: https://github.com/wsdjeg/scrollbar.nvim
- Owner: wsdjeg
- License: gpl-3.0
- Created: 2020-09-21T13:06:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-16T15:13:47.000Z (about 1 month ago)
- Last Synced: 2025-04-16T21:26:28.173Z (about 1 month ago)
- Topics: neovim-plugin
- Language: Lua
- Homepage:
- Size: 72.3 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# scrollbar.nvim
> _scrollbar.nvim_ is floating scrollbar plugin for neovim.
* [Installation](#installation)
* [Setup](#setup)
* [Debug](#debug)
* [Self-Promotion](#self-promotion)
* [Credits](#credits)
* [Feedback](#feedback)
## Installation
Using [nvim-plug](https://github.com/wsdjeg/nvim-plug)
```lua
require('plug').add({
{
'wsdjeg/scrollbar.vim',
config = function()
require('scrollbar').setup()
end,
},
})
```
For vim support, please checkout [v1.0.0](https://github.com/wsdjeg/scrollbar.nvim/releases/tag/v1.0.0):
```
Plug 'wsdjeg/scrollbar.nvim', { 'tag': 'v1.0.0' }
```
## Setup
The default option:
```lua
require('scrollbar').setup({
max_size = 10,
min_size = 5,
width = 1,
right_offset = 1,
excluded_filetypes = {
'startify',
'git-commit',
'leaderf',
'NvimTree',
'tagbar',
'defx',
'neo-tree',
'qf',
},
shape = {
head = '▲',
body = '█',
tail = '▼',
},
highlight = {
head = 'Normal',
body = 'Normal',
tail = 'Normal',
},
})
```
## Debug
Using [logger.nvim](https://github.com/wsdjeg/logger.nvim):
```lua
require('plug').add({
{
'wsdjeg/scrollbar.vim',
config = function()
require('scrollbar').setup()
end,
depends = {
{ 'wsdjeg/logger.nvim' },
},
},
})
```
## Self-Promotion
Like this plugin? Star the repository on
GitHub.
Love this plugin? Follow [me](https://wsdjeg.net/) on
[GitHub](https://github.com/wsdjeg) and
[Twitter](http://twitter.com/wsdtty).
## Credits
- [Xuyuanp/scrollbar.nvim](https://github.com/Xuyuanp/scrollbar.nvim)
## Feedback
If you encounter any bugs or have suggestions, please file an issue in the [issue tracker](https://github.com/wsdjeg/scrollbar.vim/issues)