Filter for Checks Side Panel

[katherinejensen00]

User Story As a user, I want to be able to filter the check results I see so that I only see the ones I am interested in working on at the time and don't get distracted by or lost in irrelevant results.

Description Implement filtering as described in the "Filtering for checks to run" section of Figma design

Partially depends on Checks Set Up component

Implementation idea

• [ ] Create UI for and implement filtering by project
• [ ] Create UI for and implement filtering by scope of text (note we are putting visible text off into a separate case)
• [ ] Create UI for and implement filtering by more filters (e.g. denied checks)
• [ ] Create UI for and implement filtering by sort by (e.g. scripture reference, error message)
• [ ] Using check set up component, implement filtering to only display results for checks selected in the checks set up component

[katherinejensen00]

@paranext/paranext-ux What does filtering using the checks set up component (we can rename that, but basically the checkbox list of checks) look like? Is that component only used to set the checks that are running? Is it also used separately to select the checks whose results one wants to view in the sidebar?

[merchako]

Our understanding is that checks will generally be always running. So when UX says "Run checks" we're really just

• using filters in the language of Paratext 9 and
• keeping the results up so they can be used like a task list.

If the user changes the Check types selected after a check has been "run", I believe you'll have to refresh all results. (I can certainly see why you'd ask this, @katherinejensen00 . It may have been an oversight on our part.)

[ianhewubs]

What does filtering using the checks set up component [...] look like? Is that component only used to set the checks that are running? Is it also used separately to select the checks whose results one wants to view in the sidebar

The checks to be run are specified at the top of the sidebar in the Check type menu. Only checks that are checked in the Check type menu will display results. It probably doesn't matter to the user whether the sidebar is filtering which results display (if PT10 runs all checks all the time), or if the sidebar is a way of specifying which checks should be running right now.

Additional thoughts:

1. At some point we'll want to be able to flip between run the checks the user specifies vs. "run whichever checks the project plan says should be passing right now".
2. If performance doesn't adequately support displaying results all the time and the UI simply filtering in/out which results show, we could resort to a "Run checks" button.
3. A future version might want to provide a history of "recently run checks" so a user can go back to a list of results without needing to recall the location and choices they had previously chosen. (But it's possible the back button on the BCV navigation will provide this in a roundabout sense).

[Sebastian-ubs]

@ianhewubs The "Additional thoughts" 1+3 convey concepts for future additions that seem differently enough from what was presented so that I think it would be helpful to have some mockups + flows for this vision. I have created

• https://github.com/paranext/ux/issues/180