better-escape.nvim
A Neovim plugin that eliminates typing delays when using escape key mappings like 'jk' or 'jj'.
What is better-escape.nvim?
better-escape.nvim is a Neovim plugin that eliminates typing delays when using escape key mappings like 'jk' or 'jj'. It solves the problem where typing individual characters that are part of escape sequences causes Neovim to wait for timeoutlen before inserting the character, which impacts typing speed and plugin responsiveness.
Neovim users who use escape key mappings and want to eliminate typing delays, particularly those who use plugins like Telescope where instant filtering is important.
It provides delay-free escape mappings while maintaining full compatibility with Neovim's modes and allowing customization through both key sequences and Lua functions, making it more flexible than similar solutions.
Overview
Map keys without delay when typing
Use Cases
Best For
- Eliminating typing delays when using 'jk' or 'jj' escape mappings
- Improving responsiveness in Telescope and other filtering plugins
- Creating custom escape sequences without performance penalties
- Mapping Lua functions to key combinations for advanced workflows
- Using escape mappings across multiple Neovim modes (insert, command-line, terminal)
- Optimizing typing speed for developers who frequently use escape sequences
Not Ideal For
- Users who rely exclusively on the default Escape key or Ctrl-C without custom escape mappings
- Vim users or those on editors incompatible with Neovim-specific plugins
- Configurations that prioritize minimal plugin dependencies for simplicity or performance
Pros & Cons
Pros
Eliminates the 100-500ms delay when typing characters in escape sequences, as demonstrated with Telescope where filtering becomes instant without slowdowns.
Works across insert, command-line, terminal, visual, and select modes, providing flexibility for various editing contexts without mode limitations.
Allows definition of key sequences or Lua functions as escape triggers, with examples for advanced behaviors like clearing empty lines using custom Lua code.
Described as 'really small and fast' in the README, ensuring minimal overhead and efficient operation within Neovim.
Cons
The recent rewrite removed the 'mapping' config option, forcing users to update their setups, which can be disruptive for existing installations.
Advanced features like Lua function mappings require Lua knowledge, posing a barrier for Vimscript-oriented users or those preferring simpler setups.
For basic escape mapping needs, the nested configuration structure may be unnecessarily complex compared to adjusting 'timeoutlen' directly or using simpler plugins.
Frequently Asked Questions
Related Projects
which-key.nvim💥 Create key bindings that stick. WhichKey helps you remember your Neovim keymaps, by showing available keybindings in a popup as you type.
legendary.nvim🗺️ A legend for your keymaps, commands, and autocmds, integrates with which-key.nvim, lazy.nvim, and more.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.