WIP: add support for j/k - vi-style navigation

[bmusin]

I want to add suport for h/l (vi-like), F9 (or something else)
to open/close left navigation panel.

What tags/ids of DOM elments should I manipulate to open/close side panel?

[sorin-davidoi]

What tags/ids of DOM elments should I manipulate to open/close side panel?

You should not manipulate the DOM directly. I would add another keydown event listener in the sidebar component for this functionality and use the showSidebar and hideSidebar functions instead.

[sorin-davidoi]

For the j/k shortcuts, you should look into how to define multiple keys in the aria-keyshortcuts attribute and update it in index.hbs (it appears in four places).

[bmusin]

@sorin-davidoi, sidebar() doesn't add callbacks for handling key events.
Only chapterNavigation().
Shouldn't it go into chapterNavigation()? It seemse logical to me, since it's not related to toggle button.
Also It isn't directly related to two big buttons on page sides.

[sorin-davidoi]

If it toggles the sidebar, I think it belongs to the sidebar component. There is no harm in adding a second event listener there.

[bmusin]

What about j/k and potentially h/l? Can I handle them in chapterNavigation?

[sorin-davidoi]

Yeah, those should be fine there 👍

[bmusin]

@sorin-davidoi, how should I implement going between chapters, e.g. go from 3.3 to 2.0 or 4.0?
Should I manually parse href?

[sorin-davidoi]

Could you extract this into a separate function (since it is the same logic as in the click handler)? We could then just call it from the switch and the click handler would be

sidebarToggleButton.addEventListener('click', toggleSidebar);

[bmusin]

Did.

[bmusin]

@sorin-davidoi, how should I implement going between chapters, e.g. go from 3.3 to 2.0 or 4.0?
Should I manually parse href?

Maybe chapters/subchapters links should have distinguishing tags, so that JS will go by first URL which has necessary tag?

Don't know how to do it, left TODOs, maybe someone else will complete.

[pickfire]

Maybe we should focus to <main> by default (maybe with tabindex="0"?) so that users can navigate ↑ and ↓ after navigating to another page with ← and →.

But it's a nice idea to have vi keys navigation. 👍

[sassman]

The vi navigation bindings for left / right (j/k) are super handy. What about focusing here only on that, since the code is already there are any objections of merging this?

IMO the sidebar navigation could be handled as a follow-up PR.

Any opinions?

[pickfire]

TODO?

[sassman]

seems that the author abandoned this PR, I created #1408 to follow up on this.