Smooth scrolling neovim plugin written in lua

Neoscroll: a simple smooth scrolling plugin written in lua

High quality video

Features

• Smooth scrolling for window movement commands (mappings optional): <C-u>, <C-d>, <C-b>, <C-f>, <C-y>, <C-e>, zt, zz and zb.
• Takes into account folds.
• A single scrolling function that accepts either the number of lines or the percentage of the window to scroll.
• Cursor is hidden while scrolling (optional) for a more pleasing scrolling experience.
• Customizable scrolling behaviour.
• Performance mode that turns off syntax highlighting while scrolling for slower machines or files with heavy regex syntax highlighting.

Installation

You will need neovim 0.5 for this plugin to work. Install it using your favorite plugin manager:

• With Packer: use 'karb94/neoscroll.nvim'

• With vim-plug: Plug 'karb94/neoscroll.nvim'

Quickstart

Add the setup() function to your init file.

For init.lua:

require('neoscroll').setup()

For init.vim:

lua require('neoscroll').setup()

Options

Setup function with the full list of options:

require('neoscroll').setup({
    -- All these keys will be mapped. Pass an empty table ({}) for no mappings
    mappings = {'<C-u>', '<C-d>', '<C-b>', '<C-f>',
                '<C-y>', '<C-e>', 'zt', 'zz', 'zb'},
    hide_cursor = true,          -- Hide cursor while scrolling
    stop_eof = true,             -- Stop at <EOF> when scrolling downwards
    respect_scrolloff = false,   -- Stop scrolling when the cursor reaches the scrolloff margin of the file
    cursor_scrolls_alone = true  -- The cursor will keep on scrolling even if the window cannot scroll further
})

Known issues

• Scrolling might stop before reaching the top/bottom of the file when wrapped lines are present.
• <C-u>, <C-d>, <C-b>, <C-f> mess up macros (issue).

Acknowledgements

This plugin was inspired by vim-smoothie and neo-smooth-scroll.nvim. Big thank you to their authors!