leblocks/toggle.nvim

github

utility

11

1

0

0

CREATED

2026-02-28

UPDATED

2026-06-14

---

toggle.nvim

A Neovim plugin to toggle words under the cursor to their counterpart (e.g., true → false, public → protected → private).

Installation

packer.nvim

use({ 'leblocks/toggle.nvim', })

Configuration

require('toggle').setup({
  -- Include built-in toggle pairs (default: true)
  defaults = true,

  -- Restore cursor position after toggling a word (default: true)
  keep_cursor_position = true,

  -- Additional toggle pairs (merged with defaults)
  mappings = {
    { 'yes', 'no' },
    { 'foo', 'bar', 'baz' },  -- cycles: foo → bar → baz → foo
  },
})

Options

Usage

Keymap example

vim.keymap.set({ 'n', 'v' }, '<leader>t', require('toggle').toggle, { desc = 'Toggle word' })
vim.keymap.set({ 'n', 'v' }, '<leader>T', function() require('toggle').toggle(true) end, { desc = 'Toggle word (backward)' })

How it works

toggle.toggle() checks replacers in this order (first match wins):

1. Visual selection
2. cWORD (ciW)
3. cword (ciw)
4. End-of-word match (ce) for cases like goto_prev → goto_next
5. Single character (r)

Pass true to toggle backwards in the mapping cycle:

require('toggle').toggle(true)

Mappings are circular: for a group like { 'public', 'protected', 'private' }, each value cycles to the next, and the last wraps to the first.

Default mappings

See lua/toggle/defaults.lua for the full list of built-in toggle pairs.