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

Move SearchFiltersPanel into kolibri-common #12669

Conversation

jredrejo
Copy link
Member

@jredrejo jredrejo commented Sep 18, 2024

Summary

  • Moves SearchFiltersPanel component into kolibri-common, together with all children components that support it
  • Document that because the SearchFiltersPanel uses injectSearch(), that wherever it is used, it requires useSearch() in the component ancestry (pending

Screenshot checking search, translations and info panel:

image

References

Closes: #12519

Reviewer guidance

Check all tasks described at #12519 are implemented
Check tests pass

Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@jredrejo jredrejo added the TODO: needs review Waiting for review label Sep 18, 2024
@github-actions github-actions bot added APP: Learn Re: Learn App (content, quizzes, lessons, etc.) DEV: frontend labels Sep 18, 2024
@jredrejo jredrejo marked this pull request as ready for review September 19, 2024 15:15
Copy link
Member

@rtibbles rtibbles left a comment

Choose a reason for hiding this comment

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

Moves SearchFiltersPanel component into kolibri-common, together with all children components that support it

This has moved all the components into the JS coreAPI, not into the kolibri-common package - this can be found in packages/kolibri-common.

Will need to reconcile the SidePanelModal in learn with the copy that was made into kolibri-common previously also.

@@ -66,15 +66,14 @@
import commonCoreStrings from 'kolibri.coreVue.mixins.commonCoreStrings';
Copy link
Member

Choose a reason for hiding this comment

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

Looks like there's already a copy of the SidePanelModal in kolibri-common, but it may have been altered. This may require some reconciliation to have it work as expected here and elsewhere.

Copy link
Member Author

Choose a reason for hiding this comment

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

With a small tweak iin one of the learn elements this SidePanelModal can be used here too without more changes. Done!

@jredrejo jredrejo force-pushed the move_SearchFiltersPanel_to_kolibri_common branch from ceec415 to 901e701 Compare September 23, 2024 18:37
Copy link
Member

@rtibbles rtibbles left a comment

Choose a reason for hiding this comment

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

Changes look good, only regression I saw was this styling change in the 'folder resources' panel and the 'view information' panel - basically, when the SidePanelModal is used in the TopicsContentPage, the alignment of the headers is now off, compared to the 'X' button.

Before
Screenshot from 2024-09-23 17-00-59

After
Screenshot from 2024-09-23 17-01-46

@jredrejo
Copy link
Member Author

Changes look good, only regression I saw was this styling change in the 'folder resources' panel and the 'view information' panel - basically, when the SidePanelModal is used in the TopicsContentPage, the alignment of the headers is now off, compared to the 'X' button.

Before Screenshot from 2024-09-23 17-00-59

After Screenshot from 2024-09-23 17-01-46

Fixed in all places where this component was used:
image

@rtibbles rtibbles self-assigned this Sep 24, 2024
@jredrejo jredrejo force-pushed the move_SearchFiltersPanel_to_kolibri_common branch from 489c671 to 411b864 Compare September 24, 2024 16:45
Copy link
Member

@rtibbles rtibbles left a comment

Choose a reason for hiding this comment

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

No regressions observed now!

@rtibbles rtibbles merged commit e3c4a8e into learningequality:develop Sep 24, 2024
34 checks passed
@jredrejo jredrejo deleted the move_SearchFiltersPanel_to_kolibri_common branch September 24, 2024 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APP: Learn Re: Learn App (content, quizzes, lessons, etc.) DEV: frontend TODO: needs review Waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add <SearchFiltersPanel> and children into kolibri-common
2 participants