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

GDA: Dev/citations component override #450

Merged
merged 10 commits into from
Jul 24, 2024
11 changes: 11 additions & 0 deletions docs/search-ui-react.citationsprops.citationcard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md) &gt; [CitationCard](./search-ui-react.citationsprops.citationcard.md)

## CitationsProps.CitationCard property

**Signature:**

```typescript
CitationCard?: (props: CitationProps) => JSX.Element | null;
```
11 changes: 11 additions & 0 deletions docs/search-ui-react.citationsprops.citationsheader.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md) &gt; [citationsHeader](./search-ui-react.citationsprops.citationsheader.md)

## CitationsProps.citationsHeader property

**Signature:**

```typescript
citationsHeader?: string | JSX.Element;
```
11 changes: 11 additions & 0 deletions docs/search-ui-react.citationsprops.cssclasses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md) &gt; [cssClasses](./search-ui-react.citationsprops.cssclasses.md)

## CitationsProps.cssClasses property

**Signature:**

```typescript
cssClasses: GenerativeDirectAnswerCssClasses;
```
11 changes: 11 additions & 0 deletions docs/search-ui-react.citationsprops.gdaresponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md) &gt; [gdaResponse](./search-ui-react.citationsprops.gdaresponse.md)

## CitationsProps.gdaResponse property

**Signature:**

```typescript
gdaResponse: GenerativeDirectAnswerResponse;
```
24 changes: 24 additions & 0 deletions docs/search-ui-react.citationsprops.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md)

## CitationsProps interface

Props for citations component.

**Signature:**

```typescript
interface CitationsProps
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [CitationCard?](./search-ui-react.citationsprops.citationcard.md) | | (props: [CitationProps](./search-ui-react.citationprops.md)<!-- -->) =&gt; JSX.Element \| null | _(Optional)_ |
| [citationsHeader?](./search-ui-react.citationsprops.citationsheader.md) | | string \| JSX.Element | _(Optional)_ |
| [cssClasses](./search-ui-react.citationsprops.cssclasses.md) | | [GenerativeDirectAnswerCssClasses](./search-ui-react.generativedirectanswercssclasses.md) | |
| [gdaResponse](./search-ui-react.citationsprops.gdaresponse.md) | | GenerativeDirectAnswerResponse | |
| [searchResults](./search-ui-react.citationsprops.searchresults.md) | | Result\[\] | |

11 changes: 11 additions & 0 deletions docs/search-ui-react.citationsprops.searchresults.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [CitationsProps](./search-ui-react.citationsprops.md) &gt; [searchResults](./search-ui-react.citationsprops.searchresults.md)

## CitationsProps.searchResults property

**Signature:**

```typescript
searchResults: 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, }: GenerativeDirectAnswerProps): JSX.Element | null;
declare function GenerativeDirectAnswer({ customCssClasses, answerHeader, citationsHeader, CitationCard, CitationsComponent, }: GenerativeDirectAnswerProps): JSX.Element | null;
```

## Parameters

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

**Returns:**

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [GenerativeDirectAnswerProps](./search-ui-react.generativedirectanswerprops.md) &gt; [CitationsComponent](./search-ui-react.generativedirectanswerprops.citationscomponent.md)

## GenerativeDirectAnswerProps.CitationsComponent property

The component for citations container

**Signature:**

```typescript
CitationsComponent?: (props: CitationsProps) => JSX.Element | null;
```
1 change: 1 addition & 0 deletions docs/search-ui-react.generativedirectanswerprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ interface GenerativeDirectAnswerProps
| --- | --- | --- | --- |
| [answerHeader?](./search-ui-react.generativedirectanswerprops.answerheader.md) | | string \| JSX.Element | _(Optional)_ The header for the answer section of the generative direct answer. |
| [CitationCard?](./search-ui-react.generativedirectanswerprops.citationcard.md) | | (props: [CitationProps](./search-ui-react.citationprops.md)<!-- -->) =&gt; JSX.Element \| null | _(Optional)_ The component for citation card |
| [CitationsComponent?](./search-ui-react.generativedirectanswerprops.citationscomponent.md) | | (props: [CitationsProps](./search-ui-react.citationsprops.md)<!-- -->) =&gt; JSX.Element \| null | _(Optional)_ The component for citations container |
| [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. |

3 changes: 2 additions & 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, })](./search-ui-react.generativedirectanswer.md) | Displays the AI generated answer of a generative direct answer. |
| [GenerativeDirectAnswer({ customCssClasses, answerHeader, citationsHeader, CitationCard, CitationsComponent, })](./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 Expand Up @@ -64,6 +64,7 @@
| [AutocompleteResultCssClasses](./search-ui-react.autocompleteresultcssclasses.md) | The CSS class interface for the Autocomplete Result. |
| [CardProps](./search-ui-react.cardprops.md) | The props provided to every [CardComponent](./search-ui-react.cardcomponent.md)<!-- -->. |
| [CitationProps](./search-ui-react.citationprops.md) | Props for citation card. |
| [CitationsProps](./search-ui-react.citationsprops.md) | Props for citations component. |
| [Coordinate](./search-ui-react.coordinate.md) | Coordinate use to represent the result's location on a map. |
| [CtaData](./search-ui-react.ctadata.md) | The shape of a StandardCard CTA field's data. |
| [DirectAnswerCssClasses](./search-ui-react.directanswercssclasses.md) | The CSS class interface for [DirectAnswer()](./search-ui-react.directanswer.md)<!-- -->. |
Expand Down
17 changes: 16 additions & 1 deletion etc/search-ui-react.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,20 @@ export interface CitationProps {
searchResult: Result;
}

// @public
export interface CitationsProps {
// (undocumented)
CitationCard?: (props: CitationProps) => JSX.Element | null;
// (undocumented)
citationsHeader?: string | JSX.Element;
// (undocumented)
cssClasses: GenerativeDirectAnswerCssClasses;
// (undocumented)
gdaResponse: GenerativeDirectAnswerResponse;
// (undocumented)
searchResults: Result[];
}

// @public
export const ComponentsContentPath = "node_modules/@yext/search-ui-react/lib/**/*.{js,jsx}";

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

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

// @public
export interface GenerativeDirectAnswerCssClasses {
Expand All @@ -347,6 +361,7 @@ export interface GenerativeDirectAnswerCssClasses {
export interface GenerativeDirectAnswerProps {
answerHeader?: string | JSX.Element;
CitationCard?: (props: CitationProps) => JSX.Element | null;
CitationsComponent?: (props: CitationsProps) => JSX.Element | null;
citationsHeader?: string | JSX.Element;
customCssClasses?: GenerativeDirectAnswerCssClasses;
}
Expand Down
Loading
Loading