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

Feat/484 Collection page results of all types #509

Merged
merged 44 commits into from
Oct 3, 2024

Conversation

g-saracca
Copy link
Contributor

What this PR does / why we need it:

  • Integrates the new getCollectionItems use case to display collections, datasets and files in the collection page.
  • Creates the search box UI and functionality fully integrated with the use case.
  • Creates the checkboxes UI to filter by collection, datasets and files fully integrated with the use case.

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Step 1: Run the Development Environment

  1. Execute npm i.
  2. Navigate with cd packages/design-system && npm run build.
  3. Return with cd ../../.
  4. Ensure you have a .env file similar to .env.example, with the variable VITE_DATAVERSE_BACKEND_URL=http://localhost:8000.
  5. Navigate with cd dev-env.
  6. Start the environment using ./run-env.sh unstable.
  7. To verify the environment, visit http://localhost:8000 and check your local Dataverse installation.

Step 2: Test the feature
First of all create collections, datasets and files within some of those datasets.

  • Filter results by type with the checkboxes, validate that only those type of items are being displayed and that the URL is synced with the types.
  • Make a search, validate that the results are shown and the URL is synced with all the types and the query param. (*Note: to be sure that an api endpoint call is made with the search value, open the network tab and filter by 'search?', check that the payload has te correct search value)
  • Navigate to a collection and see that the results are according to that collection.
  • If there are more items than the ones displayed, scroll to the bottom to load more items.
  • Go back and forward with the browser navigation buttons and validate the results are show correctly.
  • Go to the home page and search a value from there and validate that the results according to it are shown.

Does this PR introduce a user interface change? If mockups are available, please link/include them here: Yes.

desktop_recording.mov
mobile_recording.mov

Is there a release notes update needed for this change?:

No

Additional documentation:

No

@g-saracca g-saracca added integration Tasks involving the connection and interaction of UI features with the Dataverse API SPA: Collection Page GREI Re-arch GREI re-architecture-related FY25 Sprint 6 FY25 Sprint 6 SPA.Q3.2 Collection page basic filtering options and search FY25 Sprint 7 FY25 Sprint 7 (2024-09-25 - 2024-10-09) Original size: 80 labels Sep 26, 2024
@coveralls
Copy link

coveralls commented Sep 26, 2024

Coverage Status

coverage: 97.511% (+0.1%) from 97.404%
when pulling 658a26e on feat/484-collection-page-results-of-all-types
into 99a04c2 on develop.

@ekraffmiller ekraffmiller self-assigned this Sep 27, 2024
Copy link
Contributor

@ekraffmiller ekraffmiller left a comment

Choose a reason for hiding this comment

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

It looks great! I just have some minor comments.

@g-saracca g-saracca assigned g-saracca and unassigned g-saracca Oct 1, 2024
@g-saracca
Copy link
Contributor Author

@ekraffmiller all requested changes are done except for the ones from unresolved conversations.

Copy link
Contributor

@ekraffmiller ekraffmiller left a comment

Choose a reason for hiding this comment

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

Looks great, thank you! Approving

@ekraffmiller ekraffmiller removed their assignment Oct 1, 2024
@ChengShi-1 ChengShi-1 assigned ChengShi-1 and unassigned ChengShi-1 Oct 1, 2024
@g-saracca g-saracca assigned g-saracca and unassigned g-saracca Oct 2, 2024
@ChengShi-1 ChengShi-1 merged commit ff8ed38 into develop Oct 3, 2024
10 of 14 checks passed
@ChengShi-1 ChengShi-1 deleted the feat/484-collection-page-results-of-all-types branch October 3, 2024 13:51
@ChengShi-1 ChengShi-1 removed their assignment Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FY25 Sprint 6 FY25 Sprint 6 FY25 Sprint 7 FY25 Sprint 7 (2024-09-25 - 2024-10-09) GREI Re-arch GREI re-architecture-related integration Tasks involving the connection and interaction of UI features with the Dataverse API Original size: 80 Size: 10 A percentage of a sprint. 7 hours. SPA: Collection Page SPA.Q3.2 Collection page basic filtering options and search UI Tasks related to the user interface (UI) or frontend development
Projects
Status: Done 🧹
Development

Successfully merging this pull request may close these issues.

Collection page results of all types + search ui + filters ui
4 participants