Core Concepts
Keyboard
Every keyboard shortcut in Qikbar, and how to define your own.
Built-in keys
| Key | Action |
|---|---|
| ⌘K / CtrlK | Open or close the bar (hotkey) |
| ↑ ↓, CtrlN / CtrlP | Move the selection (wraps around) |
| ⌘↑ / ⌘↓ | Jump to the first or last item |
| PgUp / PgDn | Move by 8 |
| ↵ | Run the primary action |
| ⌘↵ | Run the secondary action |
| ⌘. | Open the action panel (actionsHotkey) |
| Tab | Ask AI, or fill in a command’s arguments |
| Esc | Close the panel, stop the AI, go back, clear the search, then close the bar |
| ⌫ on an empty input | Go back |
| ← → | Move within a grid |
Shortcut syntax
mod+k ⌘K on Mac, Ctrl+K elsewhere
shift+mod+p modifiers in any order: mod, cmd/meta, ctrl, alt/option, shift
alt+enter named keys: enter, escape/esc, tab, space, backspace, delete, up, down, left, right
g s a sequence: press G, then S (within 900 ms)
? a single character
Letter shortcuts use the physical key (KeyboardEvent.code), so ⌥ combinations work on macOS and on non-QWERTY layouts.
Where shortcuts apply
| Defined on | Works |
|---|---|
hotkey (config) |
Everywhere, always |
Command shortcut |
Globally while the bar is closed. Combos with modifiers also work inside text fields. Single keys and sequences don’t. |
Action shortcut |
While the bar is open and the item is selected |
Accessory kbd |
Display only |
Changing defaults
createQikbar({
hotkey: ['mod+k', '/'], // several hotkeys, or false to disable
actionsHotkey: 'mod+j',
shortcuts: false, // turn off global command shortcuts
})
Display helpers
import { formatHotkey } from '@qikbar/qikbar'
formatHotkey('mod+shift+p') // [['⌘', '⇧', 'P']] on Mac, [['Ctrl', 'Shift', 'P']] elsewhere
The shortcuts() extension adds a searchable Keyboard Shortcuts cheat sheet that lists every command with a shortcut.