satellite.nvim
A Neovim plugin that displays decorated scrollbars with marks for cursor, search results, diagnostics, git hunks, and more.
What is satellite.nvim?
satellite.nvim is a Neovim plugin that replaces the standard scrollbar with a decorated version showing visual marks for various buffer elements. It helps developers quickly locate cursor position, search results, diagnostics, git changes, and other important markers while navigating code files.
Neovim users who want enhanced visual feedback and better context awareness while working with code, particularly developers who frequently navigate large files or need to track multiple types of buffer annotations.
Unlike basic scrollbars, satellite.nvim provides rich visual context by displaying multiple decoration types simultaneously, supports mouse interaction, and integrates with popular Neovim plugins like gitsigns.nvim for comprehensive buffer awareness.
Overview
Decorate scrollbar for Neovim
Use Cases
Best For
- Navigating large codebases with visual position indicators
- Tracking search results across long files
- Monitoring diagnostic errors and warnings while scrolling
- Reviewing git changes within a file
- Working with multiple buffer marks and annotations
- Enhancing Neovim's UI with informative scrollbar decorations
Not Ideal For
- Users on stable Neovim releases, as it requires nightly builds
- Performance-sensitive environments where plugin overhead must be minimized
- Developers who prefer a minimal UI without scrollbar decorations
- Teams needing plug-and-play setup without configuration tweaks
Pros & Cons
Pros
Displays cursor position, search matches, diagnostics, git hunks, marks, and quickfix items, providing rich visual context for buffer navigation as shown in the feature list.
Allows per-handler symbol customization, such as setting different signs for diagnostic severities or git actions, evident in the configuration examples.
Seamlessly integrates with gitsigns.nvim for git changes and supports built-in Neovim features like folds and mouse interaction, enhancing workflow.
Includes commands like :SatelliteDisable and :SatelliteRefresh for easy management, ensuring scrollbars stay in sync with window actions.
Cons
Only compatible with Neovim nightly builds, excluding users on stable versions and potentially introducing instability.
Admits to 'unideal and unoptimised workarounds' due to missing Neovim APIs, which could lead to performance issues or bugs.
Requires manual setup with multiple handlers and settings, which might be daunting for users seeking a simple drop-in solution.
Frequently Asked Questions
Related Projects
nvim-scrollbarExtensible Neovim Scrollbar
nvim-scrollviewA Neovim plugin that displays interactive vertical scrollbars and signs.
codewindow.nvimCodewindow.nvim is a minimap plugin for Neovim that provides a visual overview of your code in a floating window. It enhances the traditional minimap by integrating deeply with Neovim's built-in LSP and Tree-sitter to show syntax highlighting, errors, warnings, and git changes directly within the minimap view. ## Key Features - **Tree-sitter Integration** — Applies syntax highlighting from Tree-sitter to the minimap, showing the most common highlights in each region. - **LSP Diagnostics** — Displays errors and warnings as colored dots next to affected lines using Neovim's built-in LSP. - **Git Integration** — Shows small dots to indicate git additions and deletions in the code. - **Viewport Visualization** — Marks the current visible area with two white lines around the observed code block. - **Focus Mode** — Allows focusing the minimap to quickly navigate through large files. - **Customizable Appearance** — Configurable width, borders, colors, and highlight groups to match your theme. ## Philosophy Codewindow.nvim aims to provide a highly integrated minimap experience that leverages Neovim's modern features like Tree-sitter and LSP to deliver more contextual information than traditional minimaps, while maintaining performance and customizability.
scrollbar.nvimscrollbar for neovim
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.