FAQ

How to get started?

Just press ? to check default shortcuts, and try them.

How to disable Surfingkeys only on current site?

Press Alt-s to disable Surfingkeys on current site, press Alt-s again to turn it on.

Note: Press yj to dump all settings into system clipboard, then paste it in your text editor, search blacklist.

How to disable PDF viewer from Surfingkeys?

Press ;s.

How to add domain-specific settings?

To add below example in your settings will turn on smartPageBoundary on Google:

if ( document.origin === "https://www.google.com" ) {
    settings.smartPageBoundary = true;
}

Conflict with other proxy extensions like SwitchyOmega?

Press se to look up your proxy mode, it should be clear, in which mode, Surfingkeys will not take control of proxy settings, this is the default mode.

If it's not, press spc to set it to clear.

Unable to scroll in any way on some pages?

There are some different reasons.

1. The page content does not get focus. If focus was on toolbar or addressbar or some input box on the page, then Surfingkeys will not scroll.
2. The page content gets focus, and you could use other keys in normal mode like ? / se. Try cs to change scroll target, or try w to switch frame.
3. A bug, please create an issue, and identify the URL you are having problem with scroll.

How to go to nth tab?

Prefix a number before T, for example, 12T to go to the 12th tab.

How to unmap many keys for some sites?

There are some sites (e.g. Gmail, Twitter, etc.) have their own keybindings, and you feel happy with them, but you would also like some specific shortcuts from Surfingkeys to be available on those sites. You could use unmapAllExcept, for example,

// only keep E, R and T from Surfingkeys for gmail.com and twitter.com
api.unmapAllExcept(['E','R','T'], /gmail.com|twitter.com/);

Totally not working on some sites?

Please see Surfingkeys across all pages

How to bring focus back to page content from address bar without mouse?

Please see Bring focus back to page content from address bar

How to use jk for escape in the ACE editor

Add this to your settings:

api.aceVimMap('jk', '<Esc>', 'insert');