Skip to content

Add search in help dialog#1953

Open
Saphereye wants to merge 8 commits intoClementTsang:mainfrom
Saphereye:searchable-help
Open

Add search in help dialog#1953
Saphereye wants to merge 8 commits intoClementTsang:mainfrom
Saphereye:searchable-help

Conversation

@Saphereye
Copy link
Copy Markdown
Contributor

@Saphereye Saphereye commented Jan 9, 2026

Description

This PR adds fuzzy search to the help dialog spawned by ? shortcut.

Screenshots

Default help menu

image

Help menu going into search mode when / is pressed

image

Help menu filtered based on input query =selec

image

Issue

Closes: #1790

Testing

  • Windows
  • macOS (specify version below)
  • Linux (specify distro below)
  • Other (specify below)

Distro: Arch

Checklist

Ensure all of these are met:

  • If this is a code change, areas your change affects have been linted using (cargo fmt)
  • If this is a code change, your changes pass cargo clippy --all -- -D warnings
  • If this is a code change, new tests were added if relevant
  • If this is a code change, your changes pass cargo test
  • The change has been tested to work (see above) and doesn't appear to break other things
  • Documentation has been updated if needed (README.md, help menu, docs, configs, etc.)
  • There are no merge conflicts
  • You have reviewed the changes first
  • The pull request passes the provided CI pipeline

Other

Currently, the search operates over all text in the help menu. That includes extra information such as the supported search types shown in the process search widget (which appears to be incorrect, for example, it claims read >= 1mb is supported, but it is not.)

I would like to know whether we can remove this extra information from the main help text or move it into a separate pane.

@Saphereye
init
00489ea 
fmt

clippy
@ClementTsang ClementTsang self-requested a review January 9, 2026 16:39
@ClementTsang ClementTsang self-assigned this Jan 16, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 19, 2026 •
edited
Loading

Codecov Report

❌ Patch coverage is 1.62162% with 182 lines in your changes missing coverage. Please review.
✅ Project coverage is 53.55%. Comparing base (72db123) to head (40a3e81).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/canvas/dialogs/help_dialog.rs 0.00% 120 Missing ⚠️
src/app.rs 0.00% 62 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1953      +/-   ##
==========================================
- Coverage   54.00%   53.55%   -0.46%     
==========================================
  Files         120      120              
  Lines       16565    16712     +147     
==========================================
+ Hits         8946     8950       +4     
- Misses       7619     7762     +143
Flag Coverage Δ
macos-14 46.23% <1.62%> (-0.44%) ⬇️
ubuntu-latest 51.95% <1.62%> (-0.46%) ⬇️
windows-2022 45.78% <1.62%> (-0.46%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ClementTsang
Copy link
Copy Markdown
Owner

ClementTsang commented Jan 31, 2026 •
edited
Loading

Sorry for the delay.

Some things I noticed when testing it:

  • Spaces don't work (as in, you literally cannot type space)
  • Some entries which have multiple listed keybindings will not show their entire entry
  • Searching headers doesn't work (not sure if intentional)
  • No cursor, ideally this should probably just copy the existing searching system for consistency

@ClementTsang
Copy link
Copy Markdown
Owner

ClementTsang commented Jan 31, 2026 •
edited
Loading

I can take a look at these if preferred.

@ClementTsang ClementTsang mentioned this pull request Apr 12, 2026
Merged
14 tasks
@Saphereye
Copy link
Copy Markdown
Contributor Author

Saphereye commented Apr 21, 2026

Hi @ClementTsang,
Really sorry for the late response ;-;

And thank you so much for fixing this branch and the other pr <3

I will update this pr with fixes for point 2, 3, 4. For number 3 I assumed users would mostly search for the functionality rather than it's class. I can change it to use the headings too.

@Saphereye
Copy link
Copy Markdown
Contributor Author

Saphereye commented Apr 21, 2026

I have moved the search widget as its own thing and reused it in both searches. The other issues should also be fixed. Please let me know if I should make anymore changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ClementTsang ClementTsang Awaiting requested review from ClementTsang

Assignees

@ClementTsang ClementTsang

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Allow for searching the help dialog

2 participants

@Saphereye @ClementTsang