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

change searchFilter isOpenByDefault autoserialization #3785

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

floriangantner
Copy link
Contributor

@floriangantner floriangantner commented Dec 27, 2024

References

Add references/links to any related issues or PRs. These may include:

Description

Change the autoserialization of the isOpenByDefault property of the searchfilter

Instructions for Reviewers

Review together with the linked PR in the REST-API / Backend: DSpace/DSpace#10169
Changing to some property which the REST-API can deliver it allows to initially show the facets on the sidebar opened or closed.

Before:
the facets are always initially not opened, although it is configured in the backend.
Screenshot 2024-12-27 at 12-11-10 Research Outputs

After:
Reload. page. The facets are initially openend when configured in the backend.
Screenshot 2024-12-27 at 12-05-52 Research Outputs

List of changes in this PR:

  • Change the autoserialize property. Instead of isOpenByDefault the typescript value of the model is retrieved from openByDefault
    • This is necessary because properties starting with is* are reserved (in Spring?) as some Getter and thus cannot be converted to the corresponding json key name.
  • No further frontend tests necessary, because the behaviour should be already been covered by other tests (see search-filter.reducer.spec.ts
    const filterConfig = { isOpenByDefault: false, name: filterName1 } as any;
    )

Include guidance for how to test or review your PR. This may include: steps to reproduce a bug, screenshots or description of a new feature, or reasons behind specific changes.

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: Discovery related to discovery search or browse system new feature
Projects
Status: 🙋 Needs Reviewers Assigned
Development

Successfully merging this pull request may close these issues.

search facets openByDefault by configuration
2 participants