galaxy icon indicating copy to clipboard operation
galaxy copied to clipboard

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

Open ahmedhamidawan opened this issue 1 year ago • 8 comments

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 https://github.com/galaxyproject/galaxy/issues/17741

How to test the changes?

(Select all options that apply)

  • [x] 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

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

ahmedhamidawan avatar Apr 19 '24 22:04 ahmedhamidawan

Searching by tool_id and id remains unchanged here, right?

martenson avatar Apr 22 '24 23:04 martenson

Searching by tool_id and id remains unchanged here, right?

Yes, this just adds the section filter as well

ahmedhamidawan avatar Apr 22 '24 23:04 ahmedhamidawan

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 https://github.com/galaxyproject/galaxy/issues/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 avatar Apr 23 '24 00:04 martenson

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

martenson avatar Apr 23 '24 00:04 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.

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 avatar May 01 '24 16:05 martenson

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.

martenson avatar May 01 '24 17:05 martenson

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.

ahmedhamidawan avatar May 01 '24 17:05 ahmedhamidawan

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

dannon avatar May 02 '24 13:05 dannon