Many vim-like shortcuts for navigating and manipulating blocks #63

tntmarket · 2020-05-18T12:03:03Z

This introduces a variety of vim like keyboard shortcuts for navigating blocks/pages, opening links, editing and selecting blocks.

It mainly revolves around remembering a "Currently selected block", which is analogous to the cursor in vim.

Demo: https://www.youtube.com/watch?v=ZxtT05CjOyo

I believe this addresses #47, #54, and #18, although in a somewhat intrusive way

Work In Progress

Still need to:

pull master, resolve conflicts
organize the commits (they're kind-of a mess)
organize the code (could share more code existing modules)
write documentation/instructions where applicable
add tests where applicable
figure out how to turn off the feature by default (it's kind-of intrusive)
revert the temporary commit

Stvad · 2020-05-18T16:46:47Z

wow, this looks amazing! will look at it closer tonight-ish

Stvad · 2020-05-18T17:15:29Z

some want's from just trying it out for a bit

u in normal mode should do "undo"
character hints >> number hints (though this has problem with conflicting with things/etc, so it's not that straightforward)
enter should probably map to "go to insert mode" too
would be nice if l were to toggle between the page and sidebar (vs having 2 separate shortcuts)
shift-o to create block above
in queries/mentions - Want hints to be able to expand various levels of "breadcrumbs" (and probably for going to the actual page as-well)
hints for complex pages are a bit confusing (not sure how to make them better)
would be awesome if moving blocks were to work in normal mode (though if I understand it correctly it's more of a Roam thing?)

More general Roam toolkit related:

make delete block work in "normal mode" and map it to dd
vim normal mode SRS shortcuts 😍
normal mode shortcut to copy block reference/block embed (y/Y)

Surfingkeys:

still want hints from Surfingkeys at times - would be nice to create a config for it that disables overlapping commands, but keeps nav hints working/etc

tntmarket · 2020-05-18T21:13:55Z

Added a commit for undo/redo, and shift+o to prepend a line

The hints can be remapped from numbers to keys, maybe we can set the default hint keys to something else closer to home row. Maybe there should option to toggle the hints on/off, or have hints be nested in their own mode.

I was considering extending h/l to navigate to the left sidebar as well. I personally like it when spatial shortcuts "dead end" at the edge of the window, cause I don't have to worry about "overshooting". But I think a "toggle panel" or "cycle through panels" would be good too.

Stvad · 2020-05-18T21:23:35Z

Hmm, undo/redo/shift-o don't seem to work for me for some reason 🤔

tntmarket · 2020-05-18T23:57:37Z

So one strange thing I noticed is that whenever I introduce a new key binding, I have to

go to the settings popup
click into the newly introduce text input for the new shortcut
wait for the green checkmark to appear

In order for the shortcut to start working (this is while I'm doing yarn run watch)

Stvad · 2020-05-19T01:30:53Z

So one strange thing I noticed is that whenever I introduce a new key binding, I have to
1. go to the settings popup

2. click into the newly introduce text input for the new shortcut

3. wait for the green checkmark to appear
In order for the shortcut to start working (this is while I'm doing yarn run watch)

ouch, that seems like a bug in settings, can you create an issue for that?

Stvad · 2020-05-19T01:32:00Z

also as a general remark - this PR is kind of large. if you can think of meaningful way to split it up in several ones to make review easier - would be appreciated. If not it's ok, but it's going to take me a bit to go through it

Stvad · 2020-05-19T01:38:17Z

One weird thing: In the morning I remapped "Select Panel Left" to Shift+L and it worked at that time, but it doesn't anymore after some of the updates

Stvad · 2020-05-19T01:50:57Z

btw just fui - key sequences should also work - https://github.com/greena13/react-hotkeys#key-combinations-vs-sequences (you just have to specify them with the space within them)
so we can stay closer to VIM in a variety of mappings

Stvad · 2020-05-19T01:57:44Z

src/ts/features/block-navigation-mode/vim.ts

+    },
+})
+
+export const imap = (settings: BlockNavigationModeSetting): Shortcut =>


I feel like it should be straightforward to write a function to generate all the functions below based on a given predicate/list of modes

tntmarket · 2020-05-19T03:01:37Z

also as a general remark - this PR is kind of large. if you can think of meaningful way to split it up in several ones to make review easier - would be appreciated. If not it's ok, but it's going to take me a bit to go through it

For sure, apologies for that. I'll go through the commits and reorganize them :p

tntmarket · 2020-05-19T03:04:50Z

So one strange thing I noticed is that whenever I introduce a new key binding, I have to
1. go to the settings popup

2. click into the newly introduce text input for the new shortcut

3. wait for the green checkmark to appear
In order for the shortcut to start working (this is while I'm doing yarn run watch)
ouch, that seems like a bug in settings, can you create an issue for that?

Created #64

Stvad · 2020-05-19T03:20:21Z

src/ts/features/block-navigation-mode/vim.ts

+import {Selectors} from '../../roam/roam-selectors'
+import {delay} from '../../utils/async'
+
+export type Mode = 'INSERT' | 'VISUAL' | 'NORMAL'


should these be Enums? (it's not an assertion but a question :) )

src/ts/features/block-navigation-mode/index.ts

Stvad · 2020-05-19T04:26:21Z

toggle fold does not work in references, unless you hover the mouse on top of the block

Stvad · 2020-05-19T04:31:59Z

Btw, I often have blocks with more then 4 things that can be referenced, what's up with the limit to 4?:)

Stvad · 2020-05-19T04:34:29Z

If I click on the todo checkbox - hints within the block disappear. and I need to move focus elsewhere and back before they appear. I suppose it's pertinent to the discussion on whether they should be show all the time or on-demand

tntmarket · 2020-05-19T04:42:33Z

Btw, I often have blocks with more then 4 things that can be referenced, what's up with the limit to 4?:)

Oh yeah, 4 is too low, I'm thinking something like 10 might be a reasonable upper bound. But then again, the whole hint UX deserves some more consideration

tntmarket · 2020-05-19T04:47:54Z

FYI, heads up that visual mode and insert mode are unreliable for me, sometimes the selection gets stuck, and keys stop working. I'll look more into this.

In the React Hotkey debug logs, I sometimes get into a state where pressing "J" is interpreted as "J+whateverWasLastPressed", even if I'm only pressing "J". Unfocusing/focusing the window usually fixes the problem.

I think this has to do with some race condition related to focusing/unfocusing blocks.

Stvad · 2020-05-19T04:52:18Z

btw added unmapAllExcept(['f', '/', 'C', '?'], /roamresearch\.com/i); to Surfingkeys config to get just the hints (will probably add more whitelisting later)

Stvad · 2020-05-19T06:58:59Z

Tab/shift-tab should work in normal mode (probably generally true for anything that you'd expect to work with "native" selection)

Stvad · 2020-05-19T07:00:17Z

Also there should probably be mapping for "jump to last block that is not in linked references"

houshuang · 2020-05-19T07:52:10Z

Just to say that this is absolutely mindblowing... I've been dreaming of something like this! I hate how all the blocks change when you move up/down with a keyboard (especially images etc). I probably even use fewer Markdown links because of that...

This will quickly become something I could not live without.

Would be very useful with an overview of keyboard shortcuts :) I looked at the source code and tried stuff - worked very well! Love how smooth it feels...

Would love line numbers (even more fancy is relative line numbers) on the left, and being able to do 10k etc to jump up to a specific line.

Also hope I can remap Esc to jk keychord as I have in my Vim setup :)

Fantastic work! 🎉🔥

classicrob · 2020-05-20T00:35:00Z

This is absolutely amazing, incredible work. I'm sure as I'll play around with this I'll have more feedback, but for now the only major thing that is missing for me is unwinding context on a block in a query or a linked reference, or while zoomed in on a block.

tntmarket · 2020-06-25T06:42:51Z

Also added tntmarket#5, in case anyone wants to try a horizontal sidebar css theme, and wants h/l to work

Stvad · 2020-06-26T03:46:35Z

@tntmarket regarding yarn.lock I removed it mainly because I use npm and GitHub was screaming at me because there were old things in yarn.lock. It's probably ok to add it back.
any good method to keep npm and yarn lock files in sync automagically?

the-nurk · 2020-06-26T15:56:17Z

I can't contribute, but please don't let this die. vim+roam would be heaven

Stvad · 2020-06-26T17:17:54Z

@nicksettoon I don't think this is in any danger of dying :) @tntmarket and myself are working on bringing this to master. I use it and love it. Absolutely looking forward to pushing it out to the other users!

the-nurk · 2020-06-26T17:34:25Z

@nicksettoon I don't think this is in any danger of dying :) @tntmarket and myself are working on bringing this to master. I use it and love it. Absolutely looking forward to pushing it out to the other users!

My Hero

…her than introducing a seperate method for that

tntmarket · 2020-06-26T20:16:39Z

@tntmarket regarding yarn.lock I removed it mainly because I use npm and GitHub was screaming at me because there were old things in yarn.lock. It's probably ok to add it back.
any good method to keep npm and yarn lock files in sync automagically?

Oh actually nvm, I'll use npm. For some reason I thought npm used yarn.lock as it's lockfile lol

…ason :(

Stvad · 2020-06-27T03:02:20Z

btw - I'm curious on why make the PRs internal and not to the master here?

tntmarket · 2020-06-27T04:17:55Z

Oh, I thought it'd make the diffs look more clean, so the later ones wouldn't include changes from the earlier ones

…-hotkeys and provide a more convenient interface that does what you'd expect

- Basic navigation, insert, and visual mode commands - Abstractions on top of Roam that make it more convenient to implement Vim Mode. I didn't integrate this with core/roam yet, since I wanted to get feedback on whether they were the right abstractions first

…deration)

Stvad · 2020-06-30T03:12:12Z

outside of scope of this, but just fyi created #95

tntmarket · 2020-07-06T05:48:29Z

Since we're getting close to releasing this, I created #104 to update the documentation

tntmarket · 2020-07-07T02:33:29Z

Gonna close this, as the functionality has been merged via other PRs and now. Looking forward to the app store release!

This was referenced May 18, 2020

Investigate moving features to roam-toolkit tntmarket/vimmyroam#2

Open

Prototype spatial navigation tntmarket/vimmyroam#5

Open

Investigate building on top of Surfing Keys tntmarket/vimmyroam#1

Open

Stvad reviewed May 19, 2020

View reviewed changes

Stvad mentioned this pull request May 19, 2020

Batch editing for Search & Replace #59

Open

tntmarket marked this pull request as draft May 19, 2020 03:06

Stvad reviewed May 19, 2020

View reviewed changes

src/ts/features/block-navigation-mode/index.ts Outdated Show resolved Hide resolved

Stvad added the enhancement New feature or request label May 20, 2020

tntmarket force-pushed the block_navigation_mode branch from 2fd8409 to 3cfc609 Compare June 25, 2020 05:47

Actually, don't need the key codes for shifted keys

44f79e1

tntmarket force-pushed the block_navigation_mode branch from 3cfc609 to c842d18 Compare June 25, 2020 06:18

tntmarket mentioned this pull request Jun 25, 2020

Vim mode navigation for horizontal sidebar css themes such as Zenith (work in progress) tntmarket/roam-toolkit#5

Closed

Stvad mentioned this pull request Jun 26, 2020

Consider including roam-navigator #91

Closed

tntmarket added 2 commits June 26, 2020 12:00

Remove unnecessary newline

b35fe5e

Make getActiveEditElement return null when no element is editing, rat…

8578dfe

…her than introducing a seperate method for that

tntmarket added 2 commits June 26, 2020 13:28

Just update npm lockfile. npm dedupe breaks npm install for some re…

309d6c1

…ason :(

Reorganize mutation-observer methods to have less cluttered signatures

e82289f

tntmarket added 4 commits June 27, 2020 15:38

Use .? instead of null check

c16253a

Update hotkey infrastructure to work around various issues with react…

7bce72a

…-hotkeys and provide a more convenient interface that does what you'd expect

Allow for opening links using hints (experimental, the UX needs consi…

1c52dba

…deration)

tntmarket force-pushed the block_navigation_mode branch from c842d18 to 1c52dba Compare June 27, 2020 22:46

Stvad mentioned this pull request Jul 3, 2020

Using alt as the modifier for Block manipulation does not suppress characters #98

Open

tntmarket closed this Jul 7, 2020

tntmarket deleted the block_navigation_mode branch July 8, 2020 07:01

tntmarket mentioned this pull request Jul 8, 2020

Bug/feature request: Vim mode Toggle fold does not work on link references #118

Closed

burke mentioned this pull request Oct 29, 2020

Fold/unfold stuff #18

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Many vim-like shortcuts for navigating and manipulating blocks #63

Many vim-like shortcuts for navigating and manipulating blocks #63

tntmarket commented May 18, 2020 •

edited

Loading

Stvad commented May 18, 2020

Stvad commented May 18, 2020

tntmarket commented May 18, 2020 •

edited

Loading

Stvad commented May 18, 2020

tntmarket commented May 18, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

Stvad May 19, 2020

tntmarket commented May 19, 2020

tntmarket commented May 19, 2020

Stvad May 19, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

tntmarket commented May 19, 2020

tntmarket commented May 19, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

houshuang commented May 19, 2020

classicrob commented May 20, 2020 •

edited

Loading

tntmarket commented Jun 25, 2020 •

edited

Loading

Stvad commented Jun 26, 2020

the-nurk commented Jun 26, 2020

Stvad commented Jun 26, 2020

the-nurk commented Jun 26, 2020 •

edited

Loading

tntmarket commented Jun 26, 2020

Stvad commented Jun 27, 2020

tntmarket commented Jun 27, 2020

Stvad commented Jun 30, 2020

tntmarket commented Jul 6, 2020

tntmarket commented Jul 7, 2020

Many vim-like shortcuts for navigating and manipulating blocks #63

Many vim-like shortcuts for navigating and manipulating blocks #63

Conversation

tntmarket commented May 18, 2020 • edited Loading

Work In Progress

Stvad commented May 18, 2020

Stvad commented May 18, 2020

tntmarket commented May 18, 2020 • edited Loading

Stvad commented May 18, 2020

tntmarket commented May 18, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

Stvad May 19, 2020

Choose a reason for hiding this comment

tntmarket commented May 19, 2020

tntmarket commented May 19, 2020

Stvad May 19, 2020

Choose a reason for hiding this comment

Stvad commented May 19, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

tntmarket commented May 19, 2020

tntmarket commented May 19, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

Stvad commented May 19, 2020

houshuang commented May 19, 2020

classicrob commented May 20, 2020 • edited Loading

tntmarket commented Jun 25, 2020 • edited Loading

Stvad commented Jun 26, 2020

the-nurk commented Jun 26, 2020

Stvad commented Jun 26, 2020

the-nurk commented Jun 26, 2020 • edited Loading

tntmarket commented Jun 26, 2020

Stvad commented Jun 27, 2020

tntmarket commented Jun 27, 2020

Stvad commented Jun 30, 2020

tntmarket commented Jul 6, 2020

tntmarket commented Jul 7, 2020

tntmarket commented May 18, 2020 •

edited

Loading

tntmarket commented May 18, 2020 •

edited

Loading

classicrob commented May 20, 2020 •

edited

Loading

tntmarket commented Jun 25, 2020 •

edited

Loading

the-nurk commented Jun 26, 2020 •

edited

Loading