Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

highlight search query in 'Open Quickly' results #1790

Merged
merged 17 commits into from
Jul 7, 2024
Merged

highlight search query in 'Open Quickly' results #1790

merged 17 commits into from
Jul 7, 2024

Conversation

plbstl
Copy link
Contributor

@plbstl plbstl commented Jul 2, 2024 •
edited
Loading

Description

This PR highlights the searched text in each result, when searching for files in Open Quickly

Related Issues

Checklist

  • I read and understood the contributing guide as well as the code of conduct
  • The issues this PR addresses are related to each other
  • My changes generate no new warnings
  • My code builds and runs on my machine
  • My changes are all related to the related issue above
  • I documented my code

Screenshots

Before:

open-quickly-codeedit

open-quickly-codeedit-2

After:

open quickly-affter pr changes

open quickly-affter pr changes 2

open.quickly-affter.pr.changes.3.mov

After requested changes:

after-visuals.for.remove.flickering.commit.mov

@plbstl plbstl force-pushed the highlight-open-quickly-results branch from 58dfff4 to 4314f7d Compare July 3, 2024 01:17
FastestMolasses
FastestMolasses previously requested changes Jul 3, 2024
View reviewed changes
Copy link
Member

@FastestMolasses FastestMolasses left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making the change, just 2 more small things

CodeEdit/Features/Search/Views/QuickSearchResultLabel.swift Outdated Show resolved Hide resolved
CodeEdit/Features/Search/Views/QuickSearchResultLabel.swift Outdated Show resolved Hide resolved
@tom-ludwig
Copy link
Member

Thank you for your work!
While your approach works well with simple queries like the ones you demonstrated, it becomes misleading with fuzzy queries. Please note that our fuzzy search also returns the matched ranges, which should be highlighted.

Here is an example:
Expected Result: ActivityViewer.swift
Actual Result:
Screenshot 2024-07-03 at 10 21 29 AM

plbstl added 13 commits July 3, 2024 13:33
@plbstl
remove extra lines
eff67e9
@plbstl
highlight all matched characters in Open Quickly results
0e28b38 
- Created `OpenQuicklySearchResult` struct to store fuzzy search results (file urls and matched characters). This replaces the `openQuicklyFiles` variable which only stored the file urls.
- Updated `QuickSearchResultLabel` to receive the matched characters to be highlighted instead of computing it within the struct. Also created `nsLabelName` property to help display `QuickActionsView` results.
- Updated `QuickActionsViewModel` to compute its highlighted characters within the struct.
@plbstl
refactor: rename state to quickOpenViewModel in QuickOpenView
00f651c
@plbstl
refactor: rename published properties in QuickOpenViewModel
63507bf
@plbstl
refactor: remove unused var showingSearchResults in QuickOpenViewModel
cf76316
@plbstl
refactor: rename OpenQuicklySearchResult to SearchResult
29e6d88
@plbstl
refactor: rename QuickOpenViewModel to OpenQuicklyViewModel
c1dd928
@plbstl
refactor: rename QuickOpenView to OpenQuicklyView
a267072
@plbstl
refactor: rename QuickOpenPreviewView to OpenQuicklyPreviewView
5490c56
@plbstl
refactor: rename QuickOpenItem to OpenQuicklyListItemView
9a28fa2
@plbstl
refactor: rename QuickOpen group to OpenQuickly
4d66417
@plbstl
refactor: rename fetchOpenQuickly to fetchResults in OpenQuicklyV…
758fa7a 
…iewModel
@plbstl
update SearchResult.id in OpenQuicklyViewModel
a88a416
@plbstl
Copy link
Contributor Author

plbstl commented Jul 3, 2024 •
edited
Loading

Visuals for 125d76a (#1790)

Before:

before-visuals.for.remove.flickering.commit.mov

After:

after-visuals.for.remove.flickering.commit.mov

thecoolwinter
thecoolwinter requested changes Jul 4, 2024
View reviewed changes
Copy link
Collaborator

@thecoolwinter thecoolwinter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I suggested one quick change that makes selected rows' highlighted text color white for more contrast. Can approve asap after that.

Before:
Screenshot 2024-07-03 at 7 33 14 PM

After:
Screenshot 2024-07-03 at 7 32 42 PM
Dark mode stays the same:
Screenshot 2024-07-03 at 7 33 25 PM

CodeEdit/Features/Search/Views/QuickSearchResultLabel.swift Outdated Show resolved Hide resolved
CodeEdit/Features/Search/Views/QuickSearchResultLabel.swift Outdated Show resolved Hide resolved
@thecoolwinter thecoolwinter mentioned this pull request Jul 4, 2024
Merged
6 tasks
@plbstl
Copy link
Contributor Author

plbstl commented Jul 4, 2024

There is one more issue. I need help with it. Instead of over explaining, I'll just drop visuals.

I'm thinking NSTableViewWrapper.updateNSView is where to start looking. The view is reloaded, and then a selection is made.

It can also have its own PR to separate concerns, since its technically not in the scope of this PR.

CodeEdit:

codeedit-example.mov

Xcode:

xcode-example.mov

@thecoolwinter
Copy link
Collaborator

@plbstl it may have something to do with this if statement reloading the view:

CodeEdit/CodeEdit/Features/CodeEditUI/Views/SearchPanelView.swift

Line 100 in 373d477

if options.isEmpty {

But I think this PR is large enough to fix that in a different one and merge this now.

@plbstl
Copy link
Contributor Author

plbstl commented Jul 4, 2024 •
edited
Loading

@plbstl it may have something to do with this if statement reloading the view:

CodeEdit/CodeEdit/Features/CodeEditUI/Views/SearchPanelView.swift

Line 100 in 373d477

if options.isEmpty {

But I think this PR is large enough to fix that in a different one and merge this now.

Ah I see, nice. I'll check it out later. I'm on mobile right now.

@plbstl plbstl mentioned this pull request Jul 5, 2024
Closed
@thecoolwinter thecoolwinter merged commit a220b38 into CodeEditApp:main Jul 7, 2024
2 checks passed
@austincondiff austincondiff added the enhancement New feature or request label Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tom-ludwig tom-ludwig tom-ludwig approved these changes

@thecoolwinter thecoolwinter thecoolwinter approved these changes

@MarcoCarnevali MarcoCarnevali Awaiting requested review from MarcoCarnevali

@EstebanBorai EstebanBorai Awaiting requested review from EstebanBorai

@FastestMolasses FastestMolasses Awaiting requested review from FastestMolasses

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

🐞 Open Quickly does not highlight search query
5 participants
@plbstl @tom-ludwig @thecoolwinter @FastestMolasses @austincondiff