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

Collection Page Facets Filters #566

Open
wants to merge 27 commits into
base: develop
Choose a base branch
from

Conversation

g-saracca
Copy link
Contributor

@g-saracca g-saracca commented Dec 12, 2024

What this PR does / why we need it:

Adds the facet filtes in the Collection Page.
See original issue

Which issue(s) this PR closes:

Special notes for your reviewer:

Depends on IQSS/dataverse-client-javascript#230 PR.
dataverse-client-javascript package version should be updated to the alpha one once the mentioned above is merged.

Suggestions on how to test this:

Step 1: Run the Development Environment

  1. Execute npm i.
  2. Navigate with cd packages/design-system && npm i && 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

  1. Create some collections and datasets in the root collection. Add one or multiple files in one of those created datasets.
  2. Navigate to http://localhost:8000/spa/collections and in another tab to http://localhost:8000 and apply same filters in the SPA version and JSF version (search; filter by collection, datasets or files; select and remove facets). Check that they show the same items and facets list.
    *Note that for now, for the selected facets button labels, we are only showing the facet value, so when in the JSF version you will see "Author Name: John" in the SPA you will just see "John".

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

Yes.
Screen Shot 2024-12-12 at 15 23 01
Screen Shot 2024-12-12 at 15 27 42

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

No

Additional documentation:

No

@coveralls
Copy link

coveralls commented Dec 12, 2024

Coverage Status

coverage: 97.5% (-0.1%) from 97.634%
when pulling d170bc8 on feat/562-add-collection-facets
into 66d2a60 on develop.

@g-saracca g-saracca changed the title Feat/562 add collection facets Collection Page Facets Filters Dec 12, 2024
@g-saracca g-saracca added GREI Re-arch GREI re-architecture-related SPA.Q4.1 Collection Page: All Filtering Options Size: 3 A percentage of a sprint. 2.1 hours. Original size: 3 labels Dec 12, 2024
@g-saracca g-saracca marked this pull request as ready for review December 12, 2024 18:51
@g-saracca g-saracca self-assigned this Dec 12, 2024
@g-saracca g-saracca removed their assignment Dec 12, 2024
@ekraffmiller ekraffmiller self-assigned this Dec 13, 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.

this looks great! Just a minor comment about the query parameters.

src/sections/Route.enum.ts Show resolved Hide resolved
@g-saracca
Copy link
Contributor Author

@ekraffmiller thanks, ready for review again!

@g-saracca g-saracca removed their assignment Dec 16, 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.

looks good, approved!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GREI Re-arch GREI re-architecture-related Original size: 3 Size: 3 A percentage of a sprint. 2.1 hours. SPA.Q4.1 Collection Page: All Filtering Options
Projects
Status: Ready for QA ⏩
Development

Successfully merging this pull request may close these issues.

Collection Page: add Collection Facets
3 participants