Skip to content

Commit

Permalink
removed the additional props
Browse files Browse the repository at this point in the history
  • Loading branch information
anguyen-yext2 committed Jun 27, 2024
1 parent 1eb42ba commit b847f79
Show file tree
Hide file tree
Showing 13 changed files with 16 additions and 135 deletions.
11 changes: 0 additions & 11 deletions docs/search-ui-react.citationprops.getcitationlink.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/search-ui-react.citationprops.getcitationsnippet.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/search-ui-react.citationprops.getcitationtitle.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/search-ui-react.citationprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,5 @@ interface CitationProps
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [cssClasses](./search-ui-react.citationprops.cssclasses.md) | | [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) | |
| [getCitationLink?](./search-ui-react.citationprops.getcitationlink.md) | | (searchResult: Result) => unknown | _(Optional)_ |
| [getCitationSnippet?](./search-ui-react.citationprops.getcitationsnippet.md) | | (searchResult: Result) => unknown | _(Optional)_ |
| [getCitationTitle?](./search-ui-react.citationprops.getcitationtitle.md) | | (searchResult: Result) => unknown | _(Optional)_ |
| [searchResult](./search-ui-react.citationprops.searchresult.md) | | Result | |

4 changes: 2 additions & 2 deletions docs/search-ui-react.generativedirectanswer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Displays the AI generated answer of a generative direct answer.
**Signature:**

```typescript
declare function GenerativeDirectAnswer({ customCssClasses, answerHeader, citationsHeader, CitationCard, getCitationLink, getCitationTitle, getCitationSnippet }: GenerativeDirectAnswerProps): JSX.Element | null;
declare function GenerativeDirectAnswer({ customCssClasses, answerHeader, citationsHeader, CitationCard, }: GenerativeDirectAnswerProps): JSX.Element | null;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| { customCssClasses, answerHeader, citationsHeader, CitationCard, getCitationLink, getCitationTitle, getCitationSnippet } | [GenerativeDirectAnswerProps](./search-ui-react.generativedirectanswerprops.md) | |
| { customCssClasses, answerHeader, citationsHeader, CitationCard, } | [GenerativeDirectAnswerProps](./search-ui-react.generativedirectanswerprops.md) | |

**Returns:**

Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

3 changes: 0 additions & 3 deletions docs/search-ui-react.generativedirectanswerprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,4 @@ interface GenerativeDirectAnswerProps
| [CitationCard?](./search-ui-react.generativedirectanswerprops.citationcard.md) | | (props: [CitationProps](./search-ui-react.citationprops.md)<!-- -->) =&gt; JSX.Element \| null | _(Optional)_ The component for citation card |
| [citationsHeader?](./search-ui-react.generativedirectanswerprops.citationsheader.md) | | string \| JSX.Element | _(Optional)_ The header for the citations section of the generative direct answer. |
| [customCssClasses?](./search-ui-react.generativedirectanswerprops.customcssclasses.md) | | [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. |
| [getCitationLink?](./search-ui-react.generativedirectanswerprops.getcitationlink.md) | | (result: Result) =&gt; unknown | _(Optional)_ A function which is called to get the page URL that clicking on a citation card routes to. |
| [getCitationSnippet?](./search-ui-react.generativedirectanswerprops.getcitationsnippet.md) | | (result: Result) =&gt; unknown | _(Optional)_ A function which is called to get the snippet of citation card. |
| [getCitationTitle?](./search-ui-react.generativedirectanswerprops.getcitationtitle.md) | | (result: Result) =&gt; unknown | _(Optional)_ A function which is called to get the title of citation card. |

2 changes: 1 addition & 1 deletion docs/search-ui-react.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| [Facets(props)](./search-ui-react.facets.md) | A component that displays all facets applicable to the current vertical search. |
| [FilterDivider({ className })](./search-ui-react.filterdivider.md) | A divider component used to separate NumericalFacets, HierarchicalFacets, StandardFacets, and StaticFilters. |
| [FilterSearch({ searchFields, label, placeholder, searchOnSelect, onSelect, onDropdownInputChange, afterDropdownInputFocus, sectioned, customCssClasses })](./search-ui-react.filtersearch.md) | A component which allows a user to search for filters associated with specific entities and fields. |
| [GenerativeDirectAnswer({ customCssClasses, answerHeader, citationsHeader, CitationCard, getCitationLink, getCitationTitle, getCitationSnippet })](./search-ui-react.generativedirectanswer.md) | Displays the AI generated answer of a generative direct answer. |
| [GenerativeDirectAnswer({ customCssClasses, answerHeader, citationsHeader, CitationCard, })](./search-ui-react.generativedirectanswer.md) | Displays the AI generated answer of a generative direct answer. |
| [Geolocation\_2({ geolocationOptions, radius, label, GeolocationIcon, handleClick, customCssClasses, })](./search-ui-react.geolocation_2.md) | A React Component which collects location information to create a location filter and perform a new search. |
| [getSearchIntents(searchActions)](./search-ui-react.getsearchintents.md) | Get search intents of the current query stored in headless using autocomplete request. |
| [getUserLocation(geolocationOptions)](./search-ui-react.getuserlocation.md) | Retrieves user's location using navigator.geolocation API. |
Expand Down
11 changes: 1 addition & 10 deletions etc/search-ui-react.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,12 +141,6 @@ export interface CitationProps {
// (undocumented)
cssClasses: GenerativeDirectAnswerCssClasses;
// (undocumented)
getCitationLink?: (searchResult: Result) => unknown;
// (undocumented)
getCitationSnippet?: (searchResult: Result) => unknown;
// (undocumented)
getCitationTitle?: (searchResult: Result) => unknown;
// (undocumented)
searchResult: Result;
}

Expand Down Expand Up @@ -327,7 +321,7 @@ export interface FilterSearchProps {
export type FocusedItemData = Record<string, unknown>;

// @public
export function GenerativeDirectAnswer({ customCssClasses, answerHeader, citationsHeader, CitationCard, getCitationLink, getCitationTitle, getCitationSnippet }: GenerativeDirectAnswerProps): JSX.Element | null;
export function GenerativeDirectAnswer({ customCssClasses, answerHeader, citationsHeader, CitationCard, }: GenerativeDirectAnswerProps): JSX.Element | null;

// @public
export interface GenerativeDirectAnswerCssClasses {
Expand Down Expand Up @@ -355,9 +349,6 @@ export interface GenerativeDirectAnswerProps {
CitationCard?: (props: CitationProps) => JSX.Element | null;
citationsHeader?: string | JSX.Element;
customCssClasses?: GenerativeDirectAnswerCssClasses;
getCitationLink?: (result: Result) => unknown;
getCitationSnippet?: (result: Result) => unknown;
getCitationTitle?: (result: Result) => unknown;
}

// @public
Expand Down
46 changes: 9 additions & 37 deletions src/components/GenerativeDirectAnswer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,6 @@ export interface GenerativeDirectAnswerProps {
citationsHeader?: string | JSX.Element,
/** The component for citation card */
CitationCard?: (props: CitationProps) => JSX.Element | null,
/** A function which is called to get the page URL that clicking on a citation card routes to. */
getCitationLink?: (result: Result) => unknown,
/** A function which is called to get the title of citation card. */
getCitationTitle?: (result: Result) => unknown,
/** A function which is called to get the snippet of citation card. */
getCitationSnippet?: (result: Result) => unknown
}

/**
Expand All @@ -72,9 +66,6 @@ export function GenerativeDirectAnswer({
answerHeader,
citationsHeader,
CitationCard,
getCitationLink,
getCitationTitle,
getCitationSnippet
}: GenerativeDirectAnswerProps): JSX.Element | null {
const cssClasses = useComposedCssClasses(builtInCssClasses, customCssClasses);

Expand Down Expand Up @@ -115,9 +106,6 @@ export function GenerativeDirectAnswer({
citationsHeader={citationsHeader}
searchResults={searchResults}
CitationCard={CitationCard}
getCitationLink={getCitationLink}
getCitationTitle={getCitationTitle}
getCitationSnippet={getCitationSnippet}
/>
</div>
);
Expand Down Expand Up @@ -151,10 +139,7 @@ interface CitationsProps {
cssClasses: GenerativeDirectAnswerCssClasses,
searchResults: Result[],
citationsHeader?: string | JSX.Element,
CitationCard?: (props: CitationProps) => JSX.Element | null,
getCitationLink?: (result: Result) => unknown,
getCitationTitle?: (result: Result) => unknown,
getCitationSnippet?: (result: Result) => unknown
CitationCard?: (props: CitationProps) => JSX.Element | null
}

/**
Expand All @@ -166,10 +151,7 @@ function Citations(props: CitationsProps) {
cssClasses,
searchResults,
citationsHeader = `Sources (${gdaResponse.citations.length})`,
CitationCard = Citation,
getCitationLink,
getCitationTitle,
getCitationSnippet
CitationCard = Citation
} = props;
if (!gdaResponse.citations.length) {
return null;
Expand All @@ -184,9 +166,6 @@ function Citations(props: CitationsProps) {
key={citation}
searchResult={result}
cssClasses={cssClasses}
getCitationLink={getCitationLink}
getCitationTitle={getCitationTitle}
getCitationSnippet={getCitationSnippet}
/>
)
}
Expand All @@ -209,25 +188,18 @@ function Citations(props: CitationsProps) {
*/
export interface CitationProps {
searchResult: Result,
cssClasses: GenerativeDirectAnswerCssClasses,
getCitationLink?: (searchResult: Result) => unknown,
getCitationTitle?: (searchResult: Result) => unknown,
getCitationSnippet?: (searchResult: Result) => unknown
cssClasses: GenerativeDirectAnswerCssClasses
}

function Citation(props: CitationProps) {
const {
searchResult,
cssClasses,
getCitationLink,
getCitationTitle = (searchResult: Result) => searchResult.rawData.name,
getCitationSnippet = (searchResult: Result) => searchResult.rawData.description
} = props;
const citationLink: unknown = getCitationLink?.(searchResult);
const citationTitle: unknown = getCitationTitle?.(searchResult);
const citationSnippet: unknown = getCitationSnippet?.(searchResult);
return <a className={cssClasses.citation} href={typeof citationLink === 'string' ? citationLink : undefined}>
<div className={cssClasses.citationTitle}>{citationTitle}</div>
<div className={cssClasses.citationSnippet}>{citationSnippet}</div>
</a>;
return (
<a className={cssClasses.citation} href={typeof searchResult.rawData.link === 'string' ? searchResult.rawData.link : undefined}>
<div className={cssClasses.citationTitle}>{searchResult.rawData.name}</div>
<div className={cssClasses.citationSnippet}>{searchResult.rawData.description}</div>
</a>
);
}
10 changes: 3 additions & 7 deletions test-site/src/pages/UniversalPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,11 @@ function CustomCitationCard(props: CitationProps): JSX.Element | null {
const {
searchResult,
cssClasses,
getCitationLink
} = props;
const citationLink: string | undefined = getCitationLink?.(searchResult);
const citationLink = typeof searchResult.rawData.link === 'string' ? searchResult.rawData.link : undefined;
return <a className={cssClasses.citation} href={citationLink}>
{typeof searchResult.rawData.id === 'string' && <div className={cssClasses.citationTitle}>{searchResult.rawData.id}</div>}
{typeof searchResult.rawData.type === 'string' && <div className={cssClasses.citationSnippet}>{searchResult.rawData.type}</div>}
{typeof searchResult.rawData.s_snippet === 'string' && <div className={cssClasses.citationSnippet}>{searchResult.rawData.s_snippet}</div>}
</a>;
}

Expand All @@ -89,10 +88,7 @@ export default function UniversalPage(): JSX.Element {
<SpellCheck />
<GenerativeDirectAnswer
answerHeader='A custom answer header'
getCitationLink={searchResult => searchResult.rawData.link}
getCitationTitle={searchResult => `${searchResult.rawData.id} - ${searchResult.rawData.name}`}
getCitationSnippet={searchResult => searchResult.rawData.s_snippet}
// CitationCard={CustomCitationCard}
CitationCard={CustomCitationCard}
/>
<DirectAnswer />
<ResultsCount />
Expand Down

0 comments on commit b847f79

Please sign in to comment.