Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lewis6991/satellite.nvim
Decorate scrollbar for Neovim
https://github.com/lewis6991/satellite.nvim
neovim-plugin
Last synced: 9 days ago
JSON representation
Decorate scrollbar for Neovim
- Host: GitHub
- URL: https://github.com/lewis6991/satellite.nvim
- Owner: lewis6991
- License: mit
- Created: 2022-05-10T15:39:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T14:49:31.000Z (about 1 month ago)
- Last Synced: 2024-10-10T23:25:55.061Z (29 days ago)
- Topics: neovim-plugin
- Language: Lua
- Homepage:
- Size: 1.42 MB
- Stars: 551
- Watchers: 9
- Forks: 21
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - lewis6991/satellite.nvim - Decorate scrollbar. (Scrolling / Scrollbar)
README
# satellite.nvim
`satellite.nvim` is a Neovim plugin that displays decorated scrollbars.
**NOTE**: Many API's required to implement a decorated scrollbar in Neovim do not yet exist,
and because of this, this plugin implements fairly unideal and unoptimised workarounds to get desired behaviours.
## Features
* Display marks for different kinds of decorations across the buffer. Builtin handlers include:
* Cursor
* Search results
* Diagnostic
* Git hunks (via [gitsigns.nvim])
* Marks
* Quickfix
* Handling for folds
* Mouse support
## Requirements
Neovim nightly
## Usage
Enabled by default. Configuration can optionally be passed to the `setup()`
function. Here is an example with most of the default settings:
```lua
require('satellite').setup {
current_only = false,
winblend = 50,
zindex = 40,
excluded_filetypes = {},
width = 2,
handlers = {
cursor = {
enable = true,
-- Supports any number of symbols
symbols = { '⎺', '⎻', '⎼', '⎽' }
-- symbols = { '⎻', '⎼' }
-- Highlights:
-- - SatelliteCursor (default links to NonText
},
search = {
enable = true,
-- Highlights:
-- - SatelliteSearch (default links to Search)
-- - SatelliteSearchCurrent (default links to SearchCurrent)
},
diagnostic = {
enable = true,
signs = {'-', '=', '≡'},
min_severity = vim.diagnostic.severity.HINT,
-- Highlights:
-- - SatelliteDiagnosticError (default links to DiagnosticError)
-- - SatelliteDiagnosticWarn (default links to DiagnosticWarn)
-- - SatelliteDiagnosticInfo (default links to DiagnosticInfo)
-- - SatelliteDiagnosticHint (default links to DiagnosticHint)
},
gitsigns = {
enable = true,
signs = { -- can only be a single character (multibyte is okay)
add = "│",
change = "│",
delete = "-",
},
-- Highlights:
-- SatelliteGitSignsAdd (default links to GitSignsAdd)
-- SatelliteGitSignsChange (default links to GitSignsChange)
-- SatelliteGitSignsDelete (default links to GitSignsDelete)
},
marks = {
enable = true,
show_builtins = false, -- shows the builtin marks like [ ] < >
key = 'm'
-- Highlights:
-- SatelliteMark (default links to Normal)
},
quickfix = {
signs = { '-', '=', '≡' },
-- Highlights:
-- SatelliteQuickfix (default links to WarningMsg)
}
},
}
```
* 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.
## Configuration
There are various settings that can be configured. Please see the documentation
for details.
## Handlers
Satellite provides an API to implement handlers for the scrollbar, see [HANDLERS](HANDLERS.md) for more details.
## Documentation
Documentation can be accessed with:
```vim
:help satellite
```
## Credit
This plugin was based on [nvim-scrollview] which provides a very good implementation for a normal scrollbar.
## Similar plugins
- [nvim-scrollview]
- [nvim-scrollbar]
[gitsigns.nvim]: https://github.com/lewis6991/gitsigns.nvim
[nvim-scrollbar]: https://github.com/petertriho/nvim-scrollbar
[nvim-scrollview]: https://github.com/dstein64/nvim-scrollview