Skip to content

[main] Add paginated vocabulary search with 'Show previous/next results' controls in hierarchical browse #4508

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

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

Conversation

ZahraaChreim-Atmire
Copy link

@ZahraaChreim-Atmire ZahraaChreim-Atmire commented Jun 25, 2025

References

Description

Added paging state management to the vocabulary treeview service, updating after each query based on whether previous or next pages exist; this state is exposed to the component to conditionally render navigation buttons in the hierarchical vocabulary browse.

Instructions for Reviewers

List of changes in this PR:

  • First, added currentPage, totalPages, showNextPageSubject, and showPreviousPageSubject to the vocabulary-treeview.service to manage and expose pagination state.
  • Second, created a new method searchByQueryAndPage(query, selectedItems, page) to support page-specific vocabulary search requests. The existing searchByQuery method was updated to call this with page 1 by default.
  • Third, updated searchByQueryAndPage to extract pagination info from the search response and update the showNextPageSubject and showPreviousPageSubject based on whether more pages are available.
  • Fourth, exposed showNextPage$ and showPreviousPage$ in the component, derived from showNextPageSubject, and showPreviousPageSubject, to reactively control the display of pagination buttons.
  • Fifth, added conditional rendering of “Show next results” and “Show previous results” buttons in the template, along with loadNextPage and `loadPreviousPage to trigger paging behavior.

To test this PR:

  1. Create a custom vocabulary XML file containing more than 20 nodes. Example: nodes with label="label1" through label="label100" and corresponding values like "value test 1" to "value test 100".
  2. Deploy the vocabulary to your backend instance.
  3. Navigate to the hierarchical browse interface in the UI (e.g., /browse/srsc).
  4. Enter the query label.

Expected behavior after applying this PR:

  • Only the first 20 matching entries are displayed initially.
  • A “Show next results” button appears below the filtered tree.
  • Clicking it displays the next 20 results and replaces the tree content.
  • When on subsequent pages, a “Show previous results” button also appears to navigate back.
  • On the final page, only the “Show previous results” button should be visible (no “Show next”).
  • On the first page, only the “Show next results” button should be visible.

First page:
image

Intermediate page:
image

Last page:
image

  • 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.

@tdonohue tdonohue changed the title Main: Add paginated vocabulary search with 'Show previous/next results' controls in hierarchical browse [main] Add paginated vocabulary search with 'Show previous/next results' controls in hierarchical browse Jun 25, 2025
@tdonohue tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace 10.0 Release Jun 25, 2025
@tdonohue tdonohue added bug component: Discovery related to discovery search or browse system 1 APPROVAL pull request only requires a single approval to merge port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release labels Jun 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 APPROVAL pull request only requires a single approval to merge bug component: Discovery related to discovery search or browse system port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release
Projects
Status: 🙋 Needs Reviewers Assigned
Development

Successfully merging this pull request may close these issues.

Hierarchical browse returns only first 20 results when searching/filtering
2 participants