Vimium C Documentation

Vimium C is an open-source, keyboard-driven browser extension that allows for full browser navigation without a mouse.

Key Capabilities:

• Link/Button Navigation: Press F to discover and highlight clickable elements; type the hint characters to activate them.
• Search & History: Press O to open a search box for browsing history, bookmarks, and open tabs. It also supports real-time math expressions and custom search engines.
• Scrolling: Use J/K/H/L (similar to Vim) to scroll content.
• In-page Search: Press / to open the in-page search overlay. Supports regex with \r, word matching with \w, and other modifiers like \R, \W, \i, and \I.
• Text Selection: Press V to enter Free Selection mode, using J/K/H/L to expand selection ranges.
• Tab Management:
  • Shift+J/Shift+K: Switch to next/previous tab.
  • g0/g$: Switch to first/last tab.
  • ^ (Shift+6): Switch to the previously visited tab.
  • X: Close current tab; Shift+X to restore.
  • yt: Copy tab URL.
• Bookmarks/Markers: Use M + [letter] to create a marker and ` + [letter] to switch to/open that marker's page.
• Advanced Command Usage: Most commands support numeric prefixes (e.g., 5 followed by Shift+X restores 5 tabs). Many commands also support parameters for fine-grained control.

Vimium C provides several advanced ways to manage key mappings and behavior:

• Contextual Mapping: Map the same key to different commands depending on the website or the current element in focus.
• Disabling Shortcuts on Specific Sites: In the extension settings, you can define rules to disable specific shortcuts on certain websites using regular expressions.
  • Use a list of URLs to disable only those shortcuts on those sites.
  • Prefix a list with ^ to disable those shortcuts on all sites except the ones listed.
• Global Shortcuts: Since standard JavaScript-based shortcuts can be intercepted or blocked by browser internal pages, Vimium C provides 8 Global Shortcuts that can be bound to any command to ensure they work everywhere. Note that Global Shortcuts do not support website-specific exclusion rules.
• Address Bar Search: Use the built-in search engine v in the browser address bar.
  • Type v + [space] to enter search mode (similar to the O command).
  • Type v + [space] + :t + [space] + [keyword] to search specifically within open tabs.

You can remap or unmap default key bindings in the 'Custom key mappings' section of the Vimium C options page. Enter one command per line.

Mapping Commands

• map <key> command: Maps a key to a Vimium C command. Overrides web page behavior.
• mapKey <key> <another_key>: Treats <key> as <another_key>. Does not affect the browser or web pages.
• unmap <key>: Removes a mapping and restores default behavior.
• unmapAll: Wipes all default bindings to start from scratch.
• unmap! <key>: Unmaps a key even if you are unsure if it was previously mapped (prevents errors).

Advanced Mapping Syntax

• Modes:
  • map <key:i> command: Triggers the command in insert mode only.
  • map! <single_key>: Maps a key in both normal and insert modes (only for single keys, not long sequences).
  • mapKey <key:o> <another_key>: Makes <key> work as <another_key> only in Vomnibar mode.
• Modifiers: Use <c-*>, <a-*>, <s-*>, or <m-*> for Ctrl, Alt, Shift, and Meta (Command on macOS).
• Complex Keys: For keys longer than 1 character, wrap them in < and > and use the s- prefix (e.g., <s-left>, <a-s-k>). When using multiple modifiers, sort prefixes by letter order (e.g., <a-s-k>).

Special Keys

• Arrow keys: <left>, <right>, <up>, <down>
• Function keys: <f1> through <f12>
• Non-printable: <space>, <tab>, <enter>, <delete>, <backspace>, <insert>, <home>, <end>

Comments

Start a line with ", #, or a space followed by # to add comments.

# Examples
map r reload
map <c-d> scrollPageDown
unmap r
unmap <c-d>
unmap g0