Automated update to repo's documentation from github action

yext · Jul 22, 2022 · 20f6f66 · 20f6f66
1 parent 8ff9fb4
commit 20f6f66
Show file tree

Hide file tree

Showing 11 changed files with 26 additions and 24 deletions.
diff --git a/docs/search-ui-react.alternativeverticalsprops.md b/docs/search-ui-react.alternativeverticalsprops.md
@@ -9,7 +9,7 @@ Props for [AlternativeVerticals()](./search-ui-react.alternativeverticals.md)<!-
 <b>Signature:</b>
 
 ```typescript
-export interface AlternativeVerticalsProps 
+export interface AlternativeVerticalsProps<T = Record<string, unknown>> 
 ```
 
 ## Properties
@@ -19,5 +19,5 @@ export interface AlternativeVerticalsProps
 |  [currentVerticalLabel](./search-ui-react.alternativeverticalsprops.currentverticallabel.md) | string | The label for the current vertical. |
 |  [customCssClasses?](./search-ui-react.alternativeverticalsprops.customcssclasses.md) | [AlternativeVerticalsCssClasses](./search-ui-react.alternativeverticalscssclasses.md) | <i>(Optional)</i> CSS classes for customizing the component styling. |
 |  [displayAllOnNoResults?](./search-ui-react.alternativeverticalsprops.displayallonnoresults.md) | boolean | <i>(Optional)</i> Whether or not all results should be displayed when there are none returned from the search. Defaults to true. |
-|  [verticalConfigMap](./search-ui-react.alternativeverticalsprops.verticalconfigmap.md) | [VerticalLabelMap](./search-ui-react.verticallabelmap.md) | A map of verticalKeys to the display label for that vertical. |
+|  [verticalConfigMap](./search-ui-react.alternativeverticalsprops.verticalconfigmap.md) | [VerticalLabelMap](./search-ui-react.verticallabelmap.md)<!-- -->&lt;T&gt; | A map of verticalKeys to the display label for that vertical. |
 
diff --git a/docs/search-ui-react.alternativeverticalsprops.verticalconfigmap.md b/docs/search-ui-react.alternativeverticalsprops.verticalconfigmap.md
@@ -9,5 +9,5 @@ A map of verticalKeys to the display label for that vertical.
 <b>Signature:</b>
 
 ```typescript
-verticalConfigMap: VerticalLabelMap;
+verticalConfigMap: VerticalLabelMap<T>;
 ```
diff --git a/docs/search-ui-react.cardcomponent.md b/docs/search-ui-react.cardcomponent.md
@@ -9,7 +9,7 @@ A functional component that can be used to render a result card.
 <b>Signature:</b>
 
 ```typescript
-export declare type CardComponent<T = Record<string, unknown>> = (props: CardProps<T>) => JSX.Element;
+export declare type CardComponent<T = DefaultResultType> = (props: CardProps<T>) => JSX.Element;
 ```
 <b>References:</b> [CardProps](./search-ui-react.cardprops.md)
 
diff --git a/docs/search-ui-react.cardprops.md b/docs/search-ui-react.cardprops.md
@@ -9,7 +9,7 @@ The props provided to every [CardComponent](./search-ui-react.cardcomponent.md)<
 <b>Signature:</b>
 
 ```typescript
-export interface CardProps<T = Record<string, unknown>> 
+export interface CardProps<T = DefaultResultType> 
 ```
 
 ## Properties

diff --git a/docs/search-ui-react.universalresultsprops.md b/docs/search-ui-react.universalresultsprops.md
@@ -9,7 +9,7 @@ Props for [UniversalResults()](./search-ui-react.universalresults.md)<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-export interface UniversalResultsProps 
+export interface UniversalResultsProps<T = Record<string, unknown>> 
 ```
 
 ## Properties

diff --git a/docs/search-ui-react.verticalconfigmap.md b/docs/search-ui-react.verticalconfigmap.md
@@ -9,5 +9,5 @@ A map of verticalKey to a VerticalConfig.
 <b>Signature:</b>
 
 ```typescript
-export interface VerticalConfigMap 
+export interface VerticalConfigMap<T = Record<string, any>> 
 ```
diff --git a/docs/search-ui-react.verticallabelmap.md b/docs/search-ui-react.verticallabelmap.md
@@ -9,5 +9,5 @@ A map of vertical keys to labels.
 <b>Signature:</b>
 
 ```typescript
-export interface VerticalLabelMap 
+export interface VerticalLabelMap<T = Record<string, unknown>> 
 ```
diff --git a/docs/search-ui-react.verticalresults.md b/docs/search-ui-react.verticalresults.md
@@ -9,14 +9,14 @@ A component that renders search results for a vertical page.
 <b>Signature:</b>
 
 ```typescript
-export declare function VerticalResults(props: VerticalResultsProps): JSX.Element | null;
+export declare function VerticalResults<T>(props: VerticalResultsProps<T>): JSX.Element | null;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  props | [VerticalResultsProps](./search-ui-react.verticalresultsprops.md) | [VerticalResultsProps](./search-ui-react.verticalresultsprops.md) |
+|  props | [VerticalResultsProps](./search-ui-react.verticalresultsprops.md)<!-- -->&lt;T&gt; | [VerticalResultsProps](./search-ui-react.verticalresultsprops.md) |
 
 <b>Returns:</b>
 

diff --git a/docs/search-ui-react.verticalresultsprops.cardcomponent.md b/docs/search-ui-react.verticalresultsprops.cardcomponent.md
@@ -9,5 +9,5 @@ A functional component that can be used to render a result card.
 <b>Signature:</b>
 
 ```typescript
-CardComponent: CardComponent;
+CardComponent: CardComponent<T>;
 ```
diff --git a/docs/search-ui-react.verticalresultsprops.md b/docs/search-ui-react.verticalresultsprops.md
@@ -9,14 +9,14 @@ Props for the VerticalResults component.
 <b>Signature:</b>
 
 ```typescript
-export interface VerticalResultsProps 
+export interface VerticalResultsProps<T = DefaultResultType> 
 ```
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [CardComponent](./search-ui-react.verticalresultsprops.cardcomponent.md) | [CardComponent](./search-ui-react.cardcomponent.md) | A functional component that can be used to render a result card. |
+|  [CardComponent](./search-ui-react.verticalresultsprops.cardcomponent.md) | [CardComponent](./search-ui-react.cardcomponent.md)<!-- -->&lt;T&gt; | A functional component that can be used to render a result card. |
 |  [customCssClasses?](./search-ui-react.verticalresultsprops.customcssclasses.md) | [VerticalResultsCssClasses](./search-ui-react.verticalresultscssclasses.md) | <i>(Optional)</i> CSS classes for customizing the component styling. |
 |  [displayAllOnNoResults?](./search-ui-react.verticalresultsprops.displayallonnoresults.md) | boolean | <i>(Optional)</i> Whether or not all results should be displayed when there are none returned from the search. Defaults to true. |
 
diff --git a/etc/search-ui-react.api.md b/etc/search-ui-react.api.md
@@ -43,11 +43,11 @@ export interface AlternativeVerticalsCssClasses {
 }
 
 // @public
-export interface AlternativeVerticalsProps {
+export interface AlternativeVerticalsProps<T = Record<string, unknown>> {
     currentVerticalLabel: string;
     customCssClasses?: AlternativeVerticalsCssClasses;
     displayAllOnNoResults?: boolean;
-    verticalConfigMap: VerticalLabelMap;
+    verticalConfigMap: VerticalLabelMap<T>;
 }
 
 // @public
@@ -110,14 +110,16 @@ export interface AutocompleteResultCssClasses {
 // @public
 export type CardAnalyticsType = CardCtaEventType | FeedbackType;
 
+// Warning: (ae-forgotten-export) The symbol "DefaultResultType" needs to be exported by the entry point index.d.ts
+//
 // @public
-export type CardComponent<T = Record<string, unknown>> = (props: CardProps<T>) => JSX.Element;
+export type CardComponent<T = DefaultResultType> = (props: CardProps<T>) => JSX.Element;
 
 // @public
 export type CardCtaEventType = 'CTA_CLICK' | 'TITLE_CLICK';
 
 // @public
-export interface CardProps<T = Record<string, unknown>> {
+export interface CardProps<T = DefaultResultType> {
     result: Result<T>;
 }
 
@@ -673,7 +675,7 @@ export interface UniversalResultsCssClasses extends SectionHeaderCssClasses {
 }
 
 // @public
-export interface UniversalResultsProps {
+export interface UniversalResultsProps<T = Record<string, unknown>> {
     customCssClasses?: UniversalResultsCssClasses;
     showAppliedFilters?: boolean;
     verticalConfigMap: VerticalConfigMap;
@@ -704,13 +706,13 @@ export interface VerticalConfig<T = Record<string, unknown>> {
 }
 
 // @public
-export interface VerticalConfigMap {
+export interface VerticalConfigMap<T = Record<string, any>> {
     [verticalKey: string]: VerticalConfig;
 }
 
 // @public
-export interface VerticalLabelMap {
-    [verticalKey: string]: Pick<VerticalConfig, 'label'>;
+export interface VerticalLabelMap<T = Record<string, unknown>> {
+    [verticalKey: string]: Pick<VerticalConfig<T>, 'label'>;
 }
 
 // @public
@@ -720,7 +722,7 @@ export interface VerticalLink {
 }
 
 // @public
-export function VerticalResults(props: VerticalResultsProps): JSX.Element | null;
+export function VerticalResults<T>(props: VerticalResultsProps<T>): JSX.Element | null;
 
 // @public
 export interface VerticalResultsCssClasses {
@@ -731,8 +733,8 @@ export interface VerticalResultsCssClasses {
 }
 
 // @public
-export interface VerticalResultsProps {
-    CardComponent: CardComponent;
+export interface VerticalResultsProps<T = DefaultResultType> {
+    CardComponent: CardComponent<T>;
     customCssClasses?: VerticalResultsCssClasses;
     displayAllOnNoResults?: boolean;
 }