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.

Sign up for GitHub

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

[ENG-6102] Added context phrase to institutions filter modal on search pages #2514

Open
wants to merge 2 commits into
base: feature/b-and-i-25-01
Choose a base branch
from
Open

[ENG-6102] Added context phrase to institutions filter modal on search pages #2514

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2ce23f
Added context phrase to institutions filter modal on search pages
bodintsov Feb 21, 2025
1bf39be
fixed naming, removed useless code
bodintsov Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions app/models/related-property-path.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ interface PropertyPath {
resourceType: Array<{ '@id': string }>;
displayLabel: LanguageText[];
shortFormLabel: LanguageText[];
description?: LanguageText[];
link_text?: LanguageText[];
link?: LanguageText[];
}

export enum SuggestedFilterOperators {
Expand Down
11 changes: 11 additions & 0 deletions lib/osf-components/addon/components/search-page/filter-facet/component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ export default class FilterFacet extends Component<FilterFacetArgs> {
@tracked filterString = '';
@tracked hasMoreValueOptions = false;
@tracked nextPageCursor = '';
@tracked hasDescription = false;
@tracked description = '';
@tracked link_text = '';
Copy link
Contributor

Choose a reason for hiding this comment

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

Very minor suggetion: javascript names are typically camelCase

Copy link
Author

Choose a reason for hiding this comment

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

changed

@tracked link = '';

get shouldShowTopValues() {
const { args: { property: { propertyPathKey } } } = this;
Expand All @@ -56,6 +60,13 @@ export default class FilterFacet extends Component<FilterFacetArgs> {
@action
toggleFacet() {
if (this.shouldShowTopValues) {
const propertyPath = this.args.property.propertyPath || [];
this.hasDescription = propertyPath.length > 0 &&
Array.isArray(propertyPath[0]?.description) &&
propertyPath[0].description.length > 0;
this.description = propertyPath[0]?.description?.[0]?.['@value'] || '';
this.link_text = propertyPath[0]?.link_text?.[0]?.['@value'] || '';
this.link = propertyPath[0]?.link?.[0]?.['@value'] || '';
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe these can be simplified a little bit by doing

Suggested change
this.description = propertyPath[0]?.description?.[0]?.['@value'] || '';
this.link_text = propertyPath[0]?.link_text?.[0]?.['@value'] || '';
this.link = propertyPath[0]?.link?.[0]?.['@value'] || '';
import { getSingleOsfmapValue } from 'ember-osf-web/packages/osfmap/jsonld';
...
this.description = getSingleOsfmapValue(propertyPath, ['description']) || '';
this.link_text = getSingleOsfmapValue(propertyPath, ['link_text') || '';
this.link = getSingleOsfmapValue(propertyPath, ['link']) || '';

if (this.filterableValues.length === 0 && !taskFor(this.fetchFacetValues).lastComplete) {
taskFor(this.fetchFacetValues).perform();
}
Expand Down
16 changes: 15 additions & 1 deletion lib/osf-components/addon/components/search-page/filter-facet/template.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,16 @@
</Button>
</li>
{{/if}}
{{#if (and this.hasDescription (not this.collapsed))}}
<Button
data-analytics-name='See more filterable values {{@property.displayLabel}}'
data-test-see-more-filterable-values={{@property.displayLabel}}
@layout='fake-link'
{{on 'click' this.openSeeMoreModal}}
>
{{t 'search.filter-facet.see-more'}}
</Button>
{{/if}}
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure if this belongs here. Seems like something extra that was copy-pasted

</ul>
{{/if}}
<OsfDialog
Expand All @@ -76,7 +86,11 @@
{{@property.displayLabel}}
</dialog.heading>
<dialog.main local-class='see-more-dialog'>
{{t 'search.filter-facet.see-more-modal-text'}}
{{#if (and this.hasDescription)}}
{{ this.description }} <a href={{this.link}}> {{ this.link_text }} </a>
{{else }}
{{t 'search.filter-facet.see-more-modal-text'}}
{{/if}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Question: Does the PropertyPath.description field from the SHARE API return the entire phrase "Please select a filter to apply to your search. Only OSF Institutions member affiliations are discoverable."?

Do we want the SHARE API only return "Only OSF Institutions member affiliations..." in the PropertyPath.description field and the FE just shows "Please select a filter to apply to your search." no matter what?

Copy link
Author

@bodintsov bodintsov Feb 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Yeah, I designed SHARE API to return description to return Please select an institution to apply to your search. Only OSF Institutions member affiliations are discoverable., linkText to return text that represents a link and link itselt.

On the ticket description, the context phrase is different from the current phrase on the Frontend (Please select a filter to apply to your search), so I added the part Please select an institution to apply to your search to the description from SHARE API. I can change the phrases that SHARE API returns if needed.

<PowerSelect
data-test-property-value-select
@options={{this.modalValueOptions}}
Expand Down
Loading