https://github.com/Aasim-A/scrollEOF.nvim

Scroll past the end of file just like scrolloff option
https://github.com/Aasim-A/scrollEOF.nvim

Last synced: about 2 months ago
JSON representation

Scroll past the end of file just like scrolloff option

• Host: GitHub
• URL: https://github.com/Aasim-A/scrollEOF.nvim
• Owner: Aasim-A
• License: mit
• Created: 2023-02-02T13:16:04.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-11T02:01:04.000Z (10 months ago)
• Last Synced: 2024-08-02T18:36:54.775Z (5 months ago)
• Language: Lua
• Size: 16.6 KB
• Stars: 95
• Watchers: 1
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-neovim-pluginlist - Aasim-A/scrollEOF.nvim - A/scrollEOF.nvim)   (View / Screen position)

README

        
scrollEOF.nvim

==============

A simple and lightweight plugin to make scrolloff go past the end of the file. It uses the value of `scrolloff` to determine the amount of blank space to mimic the behaviour of scrolloff.

https://user-images.githubusercontent.com/23695024/216361766-34784d03-d9ae-4510-aee1-1536038c100f.mp4

Getting started

---------------

### Install

Using [lazy](https://github.com/folke/lazy.nvim)

```lua

{

  'Aasim-A/scrollEOF.nvim',

  event = { 'CursorMoved', 'WinScrolled' },

  opts = {},

}

```

Using [packer](https://github.com/wbthomason/packer.nvim):

```lua

use('Aasim-A/scrollEOF.nvim')

```

Using [vim-plug](https://github.com/junegunn/vim-plug):

```vim

Plug 'Aasim-A/scrollEOF.nvim'

```

### Setup

#### Quick start

Make sure that you set the `scrolloff` setting then add the following line to your Neovim config:

Lua:

```lua

require('scrollEOF').setup()

```

Vimscript:

```vim

lua require('scrollEOF').setup()

```

#### Settings

These are the default settings. Any changes can be made in the call to `setup`.

```lua

-- Default settings

require('scrollEOF').setup({

  -- The pattern used for the internal autocmd to determine

  -- where to run scrollEOF. See https://neovim.io/doc/user/autocmd.html#autocmd-pattern

  pattern = '*'

  -- Whether or not scrollEOF should be enabled in insert mode

  insert_mode = false,

  -- Whether or not scrollEOF should be enabled in floating windows

  floating = true,

  -- List of filetypes to disable scrollEOF for.

  disabled_filetypes = {},

  -- List of modes to disable scrollEOF for. see https://neovim.io/doc/user/builtin.html#mode()

  disabled_modes = {},

})

```