Keys

You can define key mappings in Glide using the same syntax as in vim, e.g. <leader>t, the config looks like this:

glide.keymaps.set("normal", "<leader>r", "config_reload");

  
  

Here, each argument corresponds to:

1. The mode the keymap should apply in.
2. The key sequence to activate it.
3. The excmd to run when activated. (note this can also just be a function)

You can also specify multiple modes at once using an array:

glide.keymaps.set(["normal", "visual"], "<leader>r", "...");

  
  

Instead of an excmd, you can pass a function directly:

glide.keymaps.set("normal", "<leader>r", () => {
  glide.hints.show();
});

  
  

You can also delete existing keymaps:

glide.keymaps.del("normal", "f");

  
  

1. Key combinations are case-sensitive, <C-a> and <C-A> are treated differently.
2. Modifiers are case-sensitive, <C-a> is allowed but <c-a> is not (yet).
3. Modifiers are not order-sensitive and can be specified in any order. <D-S-a> and <S-D-a> are equivalent.
4. Regular characters (a-z, 0-9) don't need to be wrapped in angle brackets unless they're combined with modifiers, e.g. <C-a>.
5. Special keys must always be wrapped in angle backets, and can be combined with modifiers, e.g. <leader> and <D-leader>.

Modifiers are added as prefixes inside angle brackets and combined with a key using a -.

• <C-> - Control key
• <S-> - Shift key
• <A-> or <M-> - Alt/Meta key
• <D-> - Command key (macOS)

e.g.

• <C-a> - Control + a
• <S-Tab> - Shift + Tab
• <C-S-v> - Control + Shift + v
• <D-s> - Command + s (macOS)

Special keys are wrapped in angle brackets <>. For example:

• <CR> or <Enter> - Enter/Return key
• <BS> or <Backspace> - Backspace key
• <Space> - Space bar
• <Esc> or <Escape> - Escape key
• <Tab> - Tab key
• <Del> or <Delete> - Delete key
• <Up>, <Down>, <Left>, <Right> - Arrow keys
• <Home> - Home key
• <End> - End key
• <PageUp> - Page Up key
• <PageDown> - Page Down key
• <F1> through <F12> - Function keys

Some keys have aliases to help disambiguate syntax:

• <Bar> - Vertical bar |
• <Bslash> - Backslash \
• <lt> - Less than <

For example, <lt> is needed in some cases so that < can be used alongside modifier keys.

• < -> valid, < by itself
• <D-> -> invalid
• <D-lt> -> valid, Command + <