televator-apps/vimari

Safari port of vimium

Vimari

Keyboard Shortcuts extension for Safari

Vimari is a Safari extension that provides vim style keyboard based navigation. This lets you control Safari from your keyboard instead of having to use your mouse to open links, scroll, etc. The code is heavily based on vimium, a Chrome extension that provides much more extensive features.

Vimari attempts to provide a lightweight port of vimium to Safari, taking the best components of vimium and adapting them to Safari.

Releases

Safari 12 and above

Safari 11 and below (DEPRECATED)

• v1.13
• v1.12
• v1.11
• v1.10
• v1.9

Installation

Safari 12 and above (macOS Mojave or above)

Mac App Store

1. Download Vimari for free from the Mac App Store
2. Launch Vimari.app
3. Click "Open in Safari Extensions Preferences", Safari's Extension Preferences should open
4. Make sure that the checkbox for the Vimari extension is ticked
5. Go back to Vimari.app and press the reload button to check the status of the app. If it says "Enabled" then it is ready.
6. You may need to relaunch Safari for the extension to work

Prebuilt binaries

1. Download the latest version of Vimari
2. Unzip it
3. Move it to your /Applications folder
4. Launch Vimari.app
5. Click "Open in Safari Extensions Preferences...", Safari's Extension Preferences should open
6. Make sure that the checkbox for the Vimari extension is ticked
7. Go back to Vimari.app and press the reload button to check the status of the app. If it says "Enabled" then it is ready.
8. You may need to relaunch Safari for the extension to work

Safari 11 (legacy Safari Extension method)

Download the Vimari 1.13 and double-click the file.

Usage

Settings

Modifier - Modifier key to hold down with your action key. If you leave it blank you don't need to hold down anything (default setting).

Excluded URLs - Comma separated list of website URLs you don't want to use vimari with. To exclude GitHub for example, provide the value github.com or http://github.com. It's smart and should handle all possible domain cases.

Link Hint Characters - Allowed characters to be used when generating link shortcuts.

Extra detection by cursor style - Detect clickable links by looking for HTML elements having cursor style set to "pointer".

Scroll Size - How much each scroll will move on the page.

Vimari v2.1+

Smooth Scroll - Scroll smoothly through the page.

Normal vs Insert mode - Isolate website keybindings from the Vimari keybindings. In normal mode you can use the Vimari keybindings while in insert mode you can use the websites own keybindings.

Transparent Bindings - Full keybinding isolation might not be your style, instead the transparent bindings setting (when enabled) allows you to use all non-Vimari-bound keys to interact with the web page as if you were in insert mode.

Multiple Bindings - You can bind multiple keybindings to a Vimari action. This is done by specifying an array of bindings in the configuration file, like so: "goToPageTop": ["g g", "shift+k"].

Keyboard Bindings

These bindings are the ones set by default, however you are able to change them in the settings.

In-page navigation

f       Toggle links
F       Toggle links (open link in new tab)
k       Scroll up
j       Scroll down
h       Scroll left
l       Scroll right
u       Scroll up half page
d       Scroll down half page
g g     Go to top of page
G       Go to bottom of page
g i     Go to first input

Page/Tab navigation

H       History back
L       History forward
r       Reload
w       Next tab
q       Previous tab
x       Close current tab
t       Open new tab

Vimari v2.1+

Vimari Modes

i       Enter insert mode
ESC     Enter normal mode
CTRL+[  Enter normal mode

Tips & Tricks

Vimari is built as a Safari Extension, this poses some limits on what is possible through the extension. However default Safari shortcuts can help you keep your hands at the keyboard. Some helpful ones are listed here:

• Focus URL Bar ⌘l - This is a feature not available in Vimari, it is also helpful where extensions are not loaded (for example on topsites://). By focusing the URL Bar you can go to a website where the extension is loaded.

• Reader mode ⇧⌘R - Currently Vimari does not support entering Reader mode (due to API limitations), also navigation inside reader mode (for example using j or k) is not supported.

• Re-open last closed tab ⇧⌘T - Allows you to reopen a recently closed tab.

License

Copyright (C) 2011 Guy Halford-Thompson. See LICENSE for details.

vimari's Issues

Enhancement: fade shortcuts on Link Hinting

Scenario: After I press Ctrl+F, a page that has lots of links will display a bunch of labels with letters such as: LK, SK, LL, SJ.

If I press S at first, only SK and SJ will have its 'S' fade out. As an enhancement, would be nicer if LK and LL would also fade in this sort of situations.

I just moved from Chrome + Vimium, and thanks for the Vimari extension.

Page reloading when using swipe gesture to go back in history

As in title, if you have Vimari enabled, and use two-fingers swipe to go back in history, webpage below current one shows, and then reloads with significant delay. Uninstalling Vimari solves the problem

OS X Yosemite 10.10.3, Safari version 8.0.6 (10600.6.3)

Vimari not working in tabs opened from reading list when not connected to internet

Vimari works ("works": ctrl+j scrolls down) in tabs opened from reading list when there is an internet connection, but does not work in reading list tabs opened when there is no internet connection.

Is this a Safari restriction?

How do I use the escape key for `Command prefix`?

Feature request: shift-F to open links in new tab

This is a key feature of Vimium:

• f switches to hint mode, opening results in the same tab
• F switches to hint mode, opening the results in a new tab

Space out link hint letters

The Vimium extension 'spaces out' link hints by not putting similar link hints next to each other. It also looks like they use more letters, which lets them have shorter 2 letter labels, where vimari has 3 letter labels.

Vimari not working at all in Safari Version 7.0.5

I'm running Safari Version 7.0.5 (9537.77.4) on OS X 10.9.4. After installing and activating Vimari v1.10, I cannot get it to work at all. It simply doesn't respond to any of the key bindings (ctrl+f, etc.).

I'm an avid user of Vimium in Chrome and was looking forward to getting the same functionality in Safari. Is anyone else successfully running Vimari in Safari 7.0.5?

Link hint letters don't go away in pop-up window

On the Macworld.com site, I get these accursed little "recommended for you" pop-up windows with links to other articles. When I click the close ("X") on this pop-up, the identifying link letters stay on the screen after the pop-up disappears. They scroll with the main window content so they're apparently not part of the pop-up.

Don't know if this is fixable, but it'd be nice. What would be even nicer would be a link hint letter for the close "X" so I could get rid of the pop-up easily.

Thanks!

New Icon

If anyone is interested in designing a new icon for vimari... as much as I am nostalgic about the current one, its not the most visually appealing.

Open to any ideas.

Hinting stops after writing facebook message

In a normal facebook tab after I write (and send) a message to someone ctrl + f stops hinting.

"Promo"/Usage video for vimari to put on YouTube

Does anyone have the skills to put together a short youtube video showing how to use vimari? Its a lot easier to show people how it works in a video rather than describing it on the home page.

Link hint shouldn't trigger in form field when having no modifier key

Currently link hinting is triggered in form fields if no modifier key is defined and 'f' is pressed.

Desired behaviour is probably: Vimari should ignore all trigger keys in form fields when no modifier key is defined.

Have to reload some pages for bindings to work

Hi,
I am having an issue where I have to reload some sites for the extension to be effective. This seems like it would have been addressed in commit 4258908, but the current release either does not include that commit or it is ineffective. I thought I'd build the extension on my own, but for that it seems like I need an Apple developer account.

Is there any chance that a new release will be made soon?

"Open a new tab" shortcut?

Hi

Would it be possible to get a shortcut for opening a new tab?

Thanks

Group link hints by their second letter as in vimium

Is it possible to change vimari so it behaves like vimium? After pressing the first letter, the link hints are much more spread out in vimium, because they are not grouped by their first letter, but their second instead.

Here is the Wikipedia language list in vimari:

And here it is in vimium:

Integration of Mousetrap key binding library

Just came across this library https://github.com/ccampbell/mousetrap

Would be awesome to integrate it into Vimari and I think it would open up a lot of possibilities.

`g g` top of page command doesn't trigger

The shift+g command works, but not g g

Doesn't work in Safari 7.1

I installed it and make sure it is enabled, but it didn't do anything when I press some key, like f, d, gg. My system is OS X 10.9.5

Can't press Youtube full screen button with vimari

The full screen button is clicked, but youtube shows a popup

No link hinting after Cmd-F

Hi!

After I search within a webpage (Cmd-F), vimari's link hint toggle stops working. To re-enable it, I have to switch away from the browser's tab and come back. Then it works again.

Scrolling

I'm curious if allowing scrolling using vim like keystrokes (j for down, k for up, maybe d for page up, and u for page up) is something that you think would be worthwhile.

Link hints have incorrect style / are illegible

Using vimari 1.9, and Safari 7.0 (9537.71) (with flash disabled).

Steps to reproduce

1. Go to espn.com, and active link hints
2. The link hints are illegible in many spots.

Excepted result

The link hints should have a yellow background.

Link hints mode disregards certain visible and clickable elements

Activate link hints on this HTML snippet:

<a href="example.org"><span></span>Link text</a>

In getVisibleClickableElements(), only the first client rect of each clickable element is tested for visibility. The first client rect in the above example has zero width, so the element is falsely categorized as not visible.

Here is another example from twitter where a link is not given a hint.

how to search?

Doesn't work.. at all.

I've been trying to use this for 4 months now. Doesn't seem to work at all.

Navigating "next" and "prev" links?

A feature I sorely miss in Vimium and others:

]]      Follow the link labeled 'next' or '>'. Helpful for browsing paginated sites.
[[      Follow the link labeled 'previous' or '<'. Helpful for browsing paginated sites.

Any chance of some equivalent in Vimari?

support smoother scroll?

Scrolling is broken in safari 8

Hey, scrolling is broken in safari 8. The rest seems to work fine!

Does not work on El Capitan

This plugin does not work at all on OS X 10.11 and cannot even be installed. It just does not show up in the extensions list and thus won-t be loaded.

Remove need for ctrl button?

Hello there, as a recent convertee back from Chrome, I'm really not used to pressing control to get up the find links part of the code, is it possible to have pressing ctrl optional, or should I just create my own fork and keep that to myself?

Turn off Vimari for Certain Websites

It would be wonderful if you could turn off Vimari on certain domain names, e.g. Gmail, so you could use the built in keyboard shortcuts there instead of having the Vimari extension override them.

Safari freezing for 1-2 minutes on pages with many links

It took a while to figure out what the issue was (I thought it was Safari itself at first), but I have narrowed it down to Vimari.

This happens most often when I browse forum topics with many threads (possibly because there are hundreds of links on the page at once).

I am using Safari 8.0.5

Vimium blocking 'escape' shortcut in google spreadsheet

It seems Vimium is block the 'escape' shortcut to exit a cell formula in google sheets. I was having this issue and didn't know why, then narrowed it down to Vimium by turning off my extensions one at a time.

Example: Enter some text in any cell > return to the cell and press F2 to edit the contents of the cell > hit escape from here should result in the application exiting the cell edit mode.

move tabs

It would be nice to be able to
move a tab to the left
move a tab to the right

Can't get it to work in one of my machines

I can't get Vimari to work on one of my machines, works fine in others running the same Software versions.

Is there anything I should look for to try finding the culprit?

Auto update is not working

For some reason I can't get the auto update feature to work. Update manifest is located at http://guyht.github.com/vimari/manifest.plist

Vimari doesn't handle pages that steal focus on load (e.g. google.com)

Some pages steal focus upon load. For instance, google.com will autofocus the search bar. Vimari doesn't handle this behavior very well.

Vimium includes an advanced option called "Don't let pages steal focus on load." Rolling this feature into Vimari would solve the issue.

forward slash to search

Thanks for your extension. One awesome feature would be the ability to press forward slash to search text on a page much like Vimium (and Vim for that matter).

Cheers,

Mark

Google steals focus

Need to stop google and other sites stealing focus on page load.

This can be achieved by moving the vimari event listener to be the first in the queue and then stop the event propagation.

How to restore closed tab by using this extension?

Like the vimium or vimfx in Chrome or Firefox use shift+x to restore closed tab,which is really useful.However,I cannot find this function in vimari.
Is there a limitation in Safari?

X for reopen the latest closed tab

In Vimium this is a feature very delightful
Safari itself don't support this function.(the history is listed in order of time opened).
It would be helpful to reopen the tabs that accidentally 'x'ed.

Link Hint Characters hidden. Instead of hidden, why not just text field...

First, excellent update Woody and Guy. Control is still there if needed but the option for removal is quite easy for the many requesters... great job pleasing all sides!

About my issue, I know I can build Vimari with extension builder and quickly make the link hint characters not hidden by changing the settings for item #8 to text field instead of the default hidden but I am curious to know why link hint characters aren't by default open to users to adjust in case some conflict with other keystroke extensions? I don't think much harm can be done by having them editable and I also think, if your up to it, having a restore default link hint characters button would make it fool proof. Yay? Nay? As always, many thanks for the extension and sharing your work with us!

Links hints don't line up when zoomed in

When zoomed in with the browser, link hints don't line up with their respective links. This only appears to be the case when scrolled down the page a little.

'no command prefix' - prevent javascript autofocus on Google

Is there a way to prevent the javascript autofocus from loading on Google.

I'd like to use vimari without having to use press a 'command prefix' similar to how Vimium functions in Chrome. Unfortunately, sites like Google forces the cursor into the search box, which means commands issued for vimari ends up on the search box (actually the first keypress works, then all subsequent key presses end up in the search box).

A search engine like 'DuckDuckDuck' doesn't have this problem.

Any chance this could be enabled in vimari?

Thanks!

Does not work together w/ Gmail

Hi, I have added https://gmail.com, https://mail.google.com, https://mail.google.com/mail/ to "Excluded URLs", disabled vimari, enabled vimari but still, e.g., selecting a message and hitting l for labelling does not work. Any suggestions?

Safari 8: Requires page reload for tabs opened in background

Action: open a tab behind the current tab using shift+f or command clicking
Expected: vimari is functional in new tab
Actual: vimari does not function in the new tab until you reload the page

vimari stops working after opening link in new tab and using 'q' or 'w' to shift tabs

I am running vimari 1.10 with safari 7.0.2. I noticed that vimari stops responding after using shift + f to open a link in a new tab and then using 'q' or 'w' to shift focus to the tab.

Multiple shortcuts

In Vimium I can use CTRL E / j and CTRL Y / k to scroll up and down. I actually use both of them.
How can I specify multiple shortcuts? Shall I separate them with commas ,?

Google search box takes focus without modifier key

I noticed that the google search box continually grabs focus on the search results page. So if you are using vimari without a modifier key, any key press gets translated into the search box instead of as a vimari command. Any ideas on why this is occurring?

I realize that adding a modifier key circumvents this issue, though I find it much easier to use vimari without the modifier.

Tab closes without onbeforeunload prompting

If page has onbeforeunload action page closes silently without prompting user.
Example:

1. Write long message for issue
2. Lose focus from input area
3. Press x
4. Message lost!