https://github.com/mvllow/modes.nvim

Prismatic line decorations for the adventurous vim user
https://github.com/mvllow/modes.nvim

hacktoberfest lua neovim neovim-lua neovim-plugin nvim

Last synced: 4 days ago
JSON representation

Prismatic line decorations for the adventurous vim user

• Host: GitHub
• URL: https://github.com/mvllow/modes.nvim
• Owner: mvllow
• Created: 2021-07-27T03:53:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-27T20:10:42.000Z (5 months ago)
• Last Synced: 2024-05-28T05:52:14.946Z (5 months ago)
• Topics: hacktoberfest, lua, neovim, neovim-lua, neovim-plugin, nvim
• Language: Lua
• Homepage:
• Size: 68.4 KB
• Stars: 478
• Watchers: 6
• Forks: 12
• Open Issues: 7
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# modes.nvim

> Prismatic line decorations for the adventurous vim user

## Usage

```lua

use({

	'mvllow/modes.nvim',

	tag = 'v0.2.0',

	config = function()

		require('modes').setup()

	end

})

```

![modes.nvim](https://user-images.githubusercontent.com/1474821/127896095-6da221cf-3327-4eed-82be-ce419bdf647c.gif)

## Options

```lua

require('modes').setup({

	colors = {

		bg = "", -- Optional bg param, defaults to Normal hl group

		copy = "#f5c359",

		delete = "#c75c6a",

		insert = "#78ccc5",

		visual = "#9745be",

	},

	-- Set opacity for cursorline and number background

	line_opacity = 0.15,

	-- Enable cursor highlights

	set_cursor = true,

	-- Enable cursorline initially, and disable cursorline for inactive windows

	-- or ignored filetypes

	set_cursorline = true,

	-- Enable line number highlights to match cursorline

	set_number = true,

	-- Disable modes highlights in specified filetypes

	-- Please PR commonly ignored filetypes

	ignore_filetypes = { 'NvimTree', 'TelescopePrompt' }

})

```

## Themes

| Highlight group | Default value   |

| --------------- | --------------- |

| `ModesCopy`     | `guibg=#f5c359` |

| `ModesDelete`   | `guibg=#c75c6a` |

| `ModesInsert`   | `guibg=#78ccc5` |

| `ModesVisual`   | `guibg=#9745be` |

## Known issues

- Some _Which Key_ presets conflict with this plugin. For example, `d` and `y` operators will not apply highlights if there are `d` and `y` prefixes hooked by _Which Key_ because _Which Key_ takes priority

_Workaround:_

```lua

require('which-key').setup({

        triggers_blacklist = {

                n = { "d", "y" }

        }

})

```