[major1201]

Added a new feature which allows you to quickly search a file by its filename or title when you press Cmd/Ctrl-k

[Chocorean]

Great contribution! I would advise to add a gui test, such as the search test

View changes since this review

[major1201]

Thank you for reminding me, I've added a few ui test cases which included in tests/gui/quickjump.goml.

[Chocorean]

The last thing I can think of is I have managed to spawn both the S bar and the Ctrl+K bar by playing with the browser ; they can be both displayed at the same time and it looks odd, but you have to really look for it to make it happen. Not sure this is an issue!

Otherwise I think it's good for official review, if you are satisfied you may ping guillaume I believe

[major1201]

Currently it is not allowed to switch between search mode and quick-jump mode when either is activated.
I would like to make it free to switch anytime you want, let's discuss that in detail:

• When search mode is on, once you press ctrl-k, the search input can be switched the quickjump mode, that should be easy to make it work
• When quickjump mode is on, once you press 's', I don't know whether you want to search an expression which starts with 's' or you want to switch to search mode

So I'm hesitated to keep it as is (not allowed to switch between different modes) or allow switching to quickjump mode from search mode only.

[Chocorean]

Well technically you can switch from one bar to the other by doing Esc then shortcut

Another way could be to merge these two bars, but file lookup would be triggered by a prefix, like >
Ctrl+K would be kept and would automatically preppend the search value with said prefix

I feel like introducing a shortcut to switch bars it counter intuitive, if one already could not remember the proper shortcut, now they are expected to remember a third to fix their mistake rather than knowing it from the first place

Wdyt?

[GuillaumeGomez]

I like the feature idea, but not so much the idea of adding another shortcut. Why not a button instead?

[major1201]

Thanks @Chocorean @GuillaumeGomez you guys inspired me, I just inserted the chapter and files results into the search results. Once you press s the filename and title matches first and then the search results. So there's gonna be no new keyboard shortcut comes out and no more keyboard collisions would happen which looks much more elegant.

What do you think of that?

I still keep two commits now. I'll squash into one once it looks good to you

[Chocorean]

For reference:

Actual:

Proposed:

I find the proposed a bit empty ; maybe showing the beginning of the article would help fill the blank?

Also, something I think is not super relevant is to search the whole path:

I would expect the search to limit its area to what's after the output directory of the book

[major1201]

That make sense, optimized to add excerpt of that file

[Chocorean]

Great, that is much better now!

Last comment from me is I would limit the number of search results somehow:

Maybe max 10 chapters and 10 search results to keep the default 20 search results, idk if there is an option for that

[major1201]

Great advice, added a new option limit-chapter-results in output.html.search to limit the max results which defaults to 20.

[output.html.search]
limit-results = 30       # maximum number of search results
limit-chapter-results = 20 # maximum number of chapter/file-name matches shown before search results

[major1201]

@GuillaumeGomez Hi, gently ping in case this PR is ignored

[GuillaumeGomez]

Some extra thoughts about this: the files are listed in the sidebar, so not sure to see the added value here. What do you think @rust-lang/mdbook ?