{"id":19147736,"url":"https://github.com/sslivkoff/vim-scroll-barnacle","last_synced_at":"2025-10-25T13:11:06.465Z","repository":{"id":155508204,"uuid":"244241601","full_name":"sslivkoff/vim-scroll-barnacle","owner":"sslivkoff","description":"a scrollbar for vim in the terminal","archived":false,"fork":false,"pushed_at":"2021-02-02T10:06:52.000Z","size":2459,"stargazers_count":14,"open_issues_count":6,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-19T17:57:45.265Z","etag":null,"topics":["vim","vim-plugin","vim-plugins"],"latest_commit_sha":null,"homepage":null,"language":"Vim script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sslivkoff.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-01T23:40:38.000Z","updated_at":"2023-01-09T08:42:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"bb7184bc-879f-4c38-b042-de8e7794c01e","html_url":"https://github.com/sslivkoff/vim-scroll-barnacle","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sslivkoff%2Fvim-scroll-barnacle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sslivkoff%2Fvim-scroll-barnacle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sslivkoff%2Fvim-scroll-barnacle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sslivkoff%2Fvim-scroll-barnacle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sslivkoff","download_url":"https://codeload.github.com/sslivkoff/vim-scroll-barnacle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252802624,"owners_count":21806544,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["vim","vim-plugin","vim-plugins"],"created_at":"2024-11-09T07:51:21.577Z","updated_at":"2025-10-25T13:11:01.414Z","avatar_url":"https://github.com/sslivkoff.png","language":"Vim script","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# vim-scroll-barnacle\n\na scrollbar for vim in the terminal\n\n![vim-scroll-barnacle demo](demo.gif)\n\n\n## Features\n- unicode characters for high-resolution\n- mouse click support\n- customizable colors and glyphs\n\n\n## Install\n- vundle: `Plugin 'sslivkoff/vim-scroll-barnacle'`\n- vim-plug: `Plug 'sslivkoff/vim-scroll-barnacle'`\n\n\n## Usage\n\n#### Functions\n- change scrollbar state with\n    - `:ScrollbarToggle`\n    - `:ScrollbarOn`\n    - `:ScrollbarOff`\n- can bind to keys e.g. `nnoremap \u003csilent\u003e \u003cF1\u003e :ScrollbarToggle\u003ccr\u003e`\n\n\n#### Configuration\n- can put these in your vimrc, e.g. `let g:sb_default_behavior = \"always\"`\n- `g:sb_default_behavior` whether scrollbar is on by default (default = `\"overflow\"`)\n    - `\"always\"`: scrollbar always on\n    - `\"overflow\"`: scrollbar on when buffer does not fit in window\n    - `\"never\"`: scrollbar off by default\n- `g:sb_bar_style` style to use for scrollbar (default = `\"solid\"`)\n    - `\"solid\"` solid scrollbar using `▁▂▃▄▅▆▇█`\n    - `\"left dot\"` dot scrollbar using `⠁⠂⠄⡀⠃⠆⡄⠇⡆⡇`\n    - `\"right dot\"` dot scrollbar using `⠈⠐⠠⢀⠘⠰⢠⠸⢰⢸`\n    - `\"double dot\"` dot scrollbar using `⠉⠒⠤⣀⠛⠶⣤⠿⣶⣿`\n- `g:sb_patch_mouse` whether to patch mouse for mouse click events (default = `1`)\n    - see section below\n- `g:sb_patch_keys` whether to patch certain keys for scroll events (default = `1`)\n- `Scrollbar` highlight group\n    - change scrollbar color using the `Scrollbar` highlight group\n    - e.g.\n        - `highlight Scrollbar guifg=grey`\n        - `highlight link Scrollbar Normal` [default]\n        - `highlight link Scrollbar Comment`\n\n\n## Implementation\n- uses floating window, window has filetype `scrollbar`\n- [gifine](https://github.com/leafo/gifine) and [vim-smoothie](https://github.com/psliwka/vim-smoothie) used for creating the gif in this readme\n- weclome to suggestions, bug reports, and pull requests\n\n\n## Shortcomings\n- Neovim only for now\n    - some `nvim_*` functions in the neovim [api](https://neovim.io/doc/user/api.html) were crucial for functionality and efficiency\n    - suggestions on how to port to vim welcome\n- Can only mouse click, not mouse drag\n    - The vim mouse api is very limited\n    - Clicking requires patching `\u003cLeftMouse\u003e` input\n    - Can disable this patching with `let g:sb_patch_mouse = 0`\n- Vim does not emit scroll events directly\n    - Most actions that affect the scrollbar can be detected indirectly using vim events (e.g. `CursorMove` and `VimResize`)\n    - However, some scroll actions are not detectable with events\n    - ScrollBarnacle patches these key combinations so that they can affect the scrollbar: `zz`, `zt`, `zb`, `\u003cC-e\u003e`, `\u003cC-y\u003e`, `\u003cScrollWheelUp\u003e`, `\u003cScrollWheelDown\u003e`\n    - You can disable this patching with `let g:sb_patch_keys = 0`\n- Does not work with tabs\n    - 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.\n    - 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)\n\n\n## Related Projects\n- https://github.com/lornix/vim-scrollbar\n- https://github.com/gcavallanti/vim-noscrollbar\n- https://github.com/drzel/vim-line-no-indicator\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsslivkoff%2Fvim-scroll-barnacle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsslivkoff%2Fvim-scroll-barnacle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsslivkoff%2Fvim-scroll-barnacle/lists"}