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.

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

Add a button that filters out a tool section in the tool panel #18034

Merged

Conversation

ahmedhamidawan
Copy link
Member

@ahmedhamidawan ahmedhamidawan commented Apr 19, 2024

Adds a button that only shows the desired tool section in the panel (by emitting a section:Section Name filter:
filter_tool_section_button

Users can filter on tool ids or sections if they specify id:tool_id or section:Section name in the search bar.

Fixes #17741

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

This allows users to filter on tool ids or sections if they specify `id:tool_id` or `section:Section name`. Fixes galaxyproject#17741
@ahmedhamidawan ahmedhamidawan marked this pull request as ready for review April 22, 2024 15:18
@github-actions github-actions bot added this to the 24.1 milestone Apr 22, 2024
@martenson
Copy link
Member

Searching by tool_id and id remains unchanged here, right?

@ahmedhamidawan
Copy link
Member Author

Searching by tool_id and id remains unchanged here, right?

Yes, this just adds the section filter as well

@martenson
Copy link
Member

I think this does what it advertises, maybe a little confusing is that section:Fetch Alignments/Sequences id:MAF_Reverse_Complement_1 will find nothing even though the tool exists and is in that section.

However to me this PR does not seem enough to close #17741. Notably the user has to know the syntax of section:name which is not advertised or suggested.

Note that similar functionality for showing all tools within a section has already existed in the advanced search.

ping @jennaj -- do you have an idea what you'd like to see here?

@martenson
Copy link
Member

One thing I thought of is to implement an easier way to expand to a full section from partial results. I.e. from the result state below offer a way to hide everything but the full mothur section.

Screenshot 2024-04-22 at 5 12 24 PM

@dannon dannon marked this pull request as draft April 23, 2024 16:07
@ahmedhamidawan ahmedhamidawan changed the title Add multiple (optional) filters to client tool search Add a button that filters out a tool section in the tool panel Apr 27, 2024
@ahmedhamidawan ahmedhamidawan marked this pull request as ready for review April 27, 2024 03:11
@martenson
Copy link
Member

martenson commented May 1, 2024

I suggest we do not show the buttons when the tool panel is in "browsing" mode. It feels like a clutter since it basically duplicates expanding a section and takes a lot of real estate.

I think the situations where we want to have access to this functionality are:

  • when we are filtering (this PR already addresses this)
    Screenshot 2024-05-01 at 9 13 49 AM

  • when the search exactly matches a section name, but no tool within
    Screenshot 2024-05-01 at 9 20 07 AM

@martenson
Copy link
Member

I pushed a small style change.

The tooltips do not seem to respect the settings here, (since to the right is an iframe??) and rendering falls back to the left, which blocks the section name.

@ahmedhamidawan
Copy link
Member Author

Thank you @martenson !

I suggest we do not show the buttons when the tool panel is in "browsing" mode. It feels like a clutter since it basically duplicates expanding a section and takes a lot of real estate.

Yes, good point, I agree that the icons should only appear when browsing; i.e.: when there is a filter active.
The only annoying thing about the tooltips is that they interfere with the section description tooltips in the EDAM views.
But I agree, right tooltips weren't really working.

@dannon
Copy link
Member

dannon commented May 2, 2024

This looks good, but +1 to tweaking it slightly as @martenson suggests to only show the filter toggles based on context.

Copy link
Member

@martenson martenson left a comment

Choose a reason for hiding this comment

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

I pushed a small bugfix and a style change. Thank you @ahmedhamidawan !

@dannon dannon merged commit 509961f into galaxyproject:dev May 3, 2024
29 of 30 checks passed
@ahmedhamidawan ahmedhamidawan deleted the add_section_filter_tool_search branch May 3, 2024 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
3 participants