satellite.nvim
is a Neovim plugin that displays decorated scrollbars.
- Display marks for different kinds of decorations across the buffer. Builtin handlers include:
- search results
- diagnostic
- Git hunks (via gitsigns.nvim)
- Marks
- Handling for folds
- Mouse support (currently broken)
Neovim >= 0.7.0
use 'lewis6991/satellite.nvim'
For basic setup with all batteries included:
require('satellite').setup()
If using packer.nvim Satellite can be setup directly in the plugin spec:
use {
'lewis6991/satellite.nvim',
config = function()
require('satellite').setup()
end
}
Configuration can be passed to the setup function. Here is an example with most of the default settings:
require('satellite').setup {
current_only = false,
winblend = 50,
zindex = 40,
excluded_filetypes = {},
width = 2,
handlers = {
search = {
enable = true,
},
diagnostic = {
enable = true,
},
gitsigns = {
enable = true,
},
marks = {
enable = true,
show_builtins = false, -- shows the builtin marks like [ ] < >
},
},
}
- The
:SatelliteDisable
command disables scrollbars. - The
:SatelliteEnable
command enables scrollbars. This is only necessary if scrollbars have previously been disabled. - The
:SatelliteRefresh
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.
There are various settings that can be configured. Please see the documentation for details.
TODO
Documentation can be accessed with:
:help satellite
This plugin was based on nvim-scrollview which provides a very good implementation for a normal scrollbar.