SciCatProject / SciCatProject/frontend
Proposed design for Dataset Filters
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 29
- Forks
- 44
- Avg merge
- 20h 2m
- Merged PRs (30d)
- 20
Description
Issue Name
Proposed design for Dataset Filters
Summary
Currently the datasets list filter form does not contain all the relevant high level fields and has a different workflow to add filters on scientific metadata.
This issue is to open the floor for a discussion on how to improve the UI/UX when working with filters on datasets
Proposed new design
Where applicable, the filters should contain also the operator, and, in case of scientific metadata, the units.
The new form should look something like the following
The user should be able to change the operator and the unit where applicable. Unit is not shown in the image.
When the user wants to change the filters used, it should click on the "more filter", which should be rendered as a normal button.
This will open a modal similar to the following:
The selection modal has too columns: enabled (aka shown in the main filter form), and disabled (aka not used at the moment). The individual filter can be enabled or disabled by dragging and dropping it in the correct column.
If the user wants to add a filter on a scientific metadata entry, he/she can use the text field combined with a drop down which will show the available options once at least 3 letters are present. The search box should work on both the machine and human (display) name.
Once he/she pick the correct metadata, he/she click on add scientific metadata filter and a new filter will be added in the enabled column. Scientific metadata filters have the additional "trash bin" icon as they can be deleted from the list. Example is "Run Number" filter.
Users can also order their filter using the left icon. The form in the datasets list page will be modified accordingly.
Datasets' high level fields will be always available and a default configuration can be set in the main configuration. Each use can than configure their own form and the configuration will be consistent across sessions.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the datasets list filter form and the main configuration described in the issue, then trace how filters are currently added and persisted across sessions. Compare the existing workflow with the two proposed designs, including operator and unit selection, filter ordering, and scientific metadata search. Done would require an agreed design and a complete, consistent implementation of the redesigned filter configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100