The glide.keymaps API allows you to create custom key mappings that execute commands or functions when pressed.
Methods
set()
Create a key mapping for one or more modes.
glide.keymaps.set<const LHS>(
modes: GlideMode | GlideMode[],
lhs: string,
rhs: string | Function,
opts?: KeymapOpts
): void
Parameters
modes
GlideMode | GlideMode[]
required
The mode(s) in which the mapping applies. Can be a single mode or an array of modes.Available modes: "normal", "insert", "visual", "ignore", "command", "op-pending"
The key sequence to map. Supports special key notation like <C-a>, <leader>, <Space>, etc.
rhs
string | Function
required
What the key sequence should execute:
- A string for excmds:
"tab_close", "mode_change normal"
- A callback function:
({ tab_id }) => { ... }
- A content function:
glide.content.fn(() => { ... })
Optional configuration:
description - Description shown in which-keybuffer - Apply mapping only to current bufferretain_key_display - Keep key sequence displayed after execution
Examples
Simple excmd mapping:
glide.keymaps.set('normal', 'gt', 'tab_next');
glide.keymaps.set('normal', 'gT', 'tab_prev');
glide.keymaps.set(['normal', 'visual'], '<C-c>', 'yank');
glide.keymaps.set('normal', '<leader>p', ({ tab_id }) => {
console.log('Tab ID:', tab_id);
});
glide.keymaps.set('normal', '<leader>f', glide.content.fn(() => {
document.body.focus();
}));
glide.keymaps.set('normal', '<leader>w', 'window_close', {
description: 'Close current window'
});
keymaps: {
set(modes, lhs, rhs, opts) {
GlideBrowser.key_manager.set(modes, lhs as string, rhs, opts);
},
}
del()
Remove a key mapping for one or more modes.
glide.keymaps.del<const LHS>(
modes: GlideMode | GlideMode[],
lhs: string,
opts?: KeymapDeleteOpts
): void
Parameters
modes
GlideMode | GlideMode[]
required
The mode(s) from which to remove the mapping.
The key sequence to unmap.
Optional configuration:
buffer - Remove only buffer-local mapping
Examples
Remove a mapping:
glide.keymaps.del('normal', 'gt');
glide.keymaps.del(['normal', 'visual'], '<C-c>');
glide.keymaps.del('normal', '<leader>x', { buffer: true });
del(modes, lhs, opts) {
GlideBrowser.key_manager.del(modes, lhs as string, opts);
},
list()
List all global key mappings.
glide.keymaps.list(modes?: GlideMode | GlideMode[]): glide.Keymap[]
Parameters
Optional filter to only list mappings for specific mode(s).
Returns
type Keymap = {
sequence: string[]; // e.g. ["g", "t"]
lhs: string; // e.g. "gt"
rhs: string | Function; // The mapped command/function
description: string | undefined;
mode: GlideMode; // e.g. "normal"
}
Examples
List all mappings:
const mappings = glide.keymaps.list();
mappings.forEach(map => {
console.log(`${map.mode}: ${map.lhs} -> ${map.rhs}`);
});
const normalMaps = glide.keymaps.list('normal');
const insertMaps = glide.keymaps.list('insert');
const maps = glide.keymaps.list(['normal', 'visual']);
list(modes) {
return GlideBrowser.key_manager.list(modes);
},
Buffer-Local Keymaps
The glide.buf.keymaps API provides the same interface but creates buffer-local mappings that are automatically cleaned up when navigating away.
glide.buf.keymaps.set()
glide.buf.keymaps.set(
modes: GlideMode | GlideMode[],
lhs: string,
rhs: string | Function,
opts?: Omit<KeymapOpts, 'buffer'>
): void
glide.autocmds.create('UrlEnter', { hostname: 'github.com' }, () => {
glide.buf.keymaps.set('normal', '<leader>i', () => {
console.log('GitHub-specific mapping');
});
});
keymaps: {
set(modes, lhs, rhs, opts) {
GlideBrowser.key_manager.set(modes, lhs as string, rhs, { ...opts, buffer: true });
},
}
glide.buf.keymaps.del()
glide.buf.keymaps.del(
modes: GlideMode | GlideMode[],
lhs: string,
opts?: Omit<KeymapDeleteOpts, 'buffer'>
): void
glide.buf.keymaps.del('normal', '<leader>i');
del(modes, lhs, opts) {
GlideBrowser.key_manager.del(modes, lhs as string, { ...opts, buffer: true });
},
Key Notation
Glide uses Vim-style key notation:
Special Keys
<Space> - Space bar<Tab> - Tab key<CR> or <Enter> - Enter/Return<Esc> or <Escape> - Escape<BS> or <Backspace> - Backspace<leader> - Leader key (default: <Space>)<Up>, <Down>, <Left>, <Right> - Arrow keys<Home>, <End>, <PageUp>, <PageDown><F1> through <F12> - Function keys<lt> - Literal < character<bar> - Literal | character<bslash> - Literal \ character
Modifiers
<C-x> - Control + x<A-x> - Alt + x<S-x> - Shift + x<D-x> - Command/Super + x (macOS)<M-x> - Meta + x (same as Alt)
Combinations
// Control + Alt + x
glide.keymaps.set('normal', '<C-A-x>', 'some_command');
// Leader followed by w
glide.keymaps.set('normal', '<leader>w', 'window_close');
// Two-key sequence
glide.keymaps.set('normal', 'gt', 'tab_next');
Complete Example
// Basic navigation
glide.keymaps.set('normal', 'H', 'history_back');
glide.keymaps.set('normal', 'L', 'history_forward');
// Tab management
glide.keymaps.set('normal', '<leader>tn', 'tab_new', {
description: 'New tab'
});
glide.keymaps.set('normal', '<leader>tc', 'tab_close', {
description: 'Close tab'
});
// Custom function
glide.keymaps.set('normal', '<leader>d', ({ tab_id }) => {
console.log('Current tab:', tab_id);
glide.excmds.execute('tab_duplicate');
});
// Content-specific mapping
glide.keymaps.set('normal', '<leader>s', glide.content.fn(() => {
window.scrollTo({ top: 0, behavior: 'smooth' });
}));
// Buffer-local mapping for GitHub
glide.autocmds.create('UrlEnter', { hostname: 'github.com' }, () => {
glide.buf.keymaps.set('normal', 'gp', () => {
const url = new URL(glide.ctx.url);
const parts = url.pathname.split('/').filter(Boolean);
if (parts.length >= 2) {
console.log(`Repo: ${parts[0]}/${parts[1]}`);
}
});
});
// List all normal mode mappings
const mappings = glide.keymaps.list('normal');
console.log('Normal mode mappings:', mappings.length);