Skip to content

Whenever cursor jumps some distance or moves between windows, it will flash so you can see where it is

Notifications You must be signed in to change notification settings

DanilaMihailov/beacon.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Beacon.nvim - never lose your cursor again!

Highlight cursor when it moves, changes windows and more! This plugin is heavily inspired by emacs package beacon.

beaconv2.mov

Installation

{ 'danilamihailov/beacon.nvim' } -- lazy calls setup() by itself

Or use your favorite plugin manager, you'll need to call setup require('beacon').setup()

Note

For Vim versions checkout v1 tags v1.3.4

Customization

Default config

 {
  enabled = true, --- (boolean | fun():boolean) check if enabled
  speed = 2, --- integer speed at wich animation goes
  width = 40, --- integer width of the beacon window
  winblend = 70, --- integer starting transparency of beacon window :h winblend
  fps = 60, --- integer how smooth the animation going to be
  min_jump = 10, --- integer what is considered a jump. Number of lines
  cursor_events = { 'CursorMoved' }, -- table<string> what events trigger check for cursor moves
  window_events = { 'WinEnter', 'FocusGained' }, -- table<string> what events trigger cursor highlight
  highlight = { bg = 'white', ctermbg = 15 }, -- vim.api.keyset.highlight table passed to vim.api.nvim_set_hl
}

Changing color

Beacon is highlighted by Beacon group, so you can change it like this:

vim.api.nvim_set_hl(0, 'Beacon', { bg = 'white' })

or simplier way is to change highlight params in config

check :help nvim_set_hl() for more options.

Note

checkout doc/beacon.txt for more

Similar plugins

About

Whenever cursor jumps some distance or moves between windows, it will flash so you can see where it is

Topics

Resources

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages