From 20f6f66fb042b6950e87ebe03633e183f059a8d7 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 22 Jul 2022 19:14:53 +0000 Subject: [PATCH] Automated update to repo's documentation from github action --- ...arch-ui-react.alternativeverticalsprops.md | 4 ++-- ...rnativeverticalsprops.verticalconfigmap.md | 2 +- docs/search-ui-react.cardcomponent.md | 2 +- docs/search-ui-react.cardprops.md | 2 +- docs/search-ui-react.universalresultsprops.md | 2 +- docs/search-ui-react.verticalconfigmap.md | 2 +- docs/search-ui-react.verticallabelmap.md | 2 +- docs/search-ui-react.verticalresults.md | 4 ++-- ...eact.verticalresultsprops.cardcomponent.md | 2 +- docs/search-ui-react.verticalresultsprops.md | 4 ++-- etc/search-ui-react.api.md | 24 ++++++++++--------- 11 files changed, 26 insertions(+), 24 deletions(-) diff --git a/docs/search-ui-react.alternativeverticalsprops.md b/docs/search-ui-react.alternativeverticalsprops.md index 559e573c1..a37a3197e 100644 --- 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)Signature: ```typescript -export interface AlternativeVerticalsProps +export interface AlternativeVerticalsProps> ``` ## 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) | (Optional) CSS classes for customizing the component styling. | | [displayAllOnNoResults?](./search-ui-react.alternativeverticalsprops.displayallonnoresults.md) | boolean | (Optional) 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)<T> | 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 index de0bb0a6b..6b925a6a9 100644 --- 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. Signature: ```typescript -verticalConfigMap: VerticalLabelMap; +verticalConfigMap: VerticalLabelMap; ``` diff --git a/docs/search-ui-react.cardcomponent.md b/docs/search-ui-react.cardcomponent.md index b5e5bb061..9a7a114a8 100644 --- 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. Signature: ```typescript -export declare type CardComponent> = (props: CardProps) => JSX.Element; +export declare type CardComponent = (props: CardProps) => JSX.Element; ``` References: [CardProps](./search-ui-react.cardprops.md) diff --git a/docs/search-ui-react.cardprops.md b/docs/search-ui-react.cardprops.md index 907ca1d8e..ea773bed7 100644 --- 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)< Signature: ```typescript -export interface CardProps> +export interface CardProps ``` ## Properties diff --git a/docs/search-ui-react.universalresultsprops.md b/docs/search-ui-react.universalresultsprops.md index 69fb6dc06..8a43a1efe 100644 --- 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). Signature: ```typescript -export interface UniversalResultsProps +export interface UniversalResultsProps> ``` ## Properties diff --git a/docs/search-ui-react.verticalconfigmap.md b/docs/search-ui-react.verticalconfigmap.md index 985ba8c8e..103fc11de 100644 --- 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. Signature: ```typescript -export interface VerticalConfigMap +export interface VerticalConfigMap> ``` diff --git a/docs/search-ui-react.verticallabelmap.md b/docs/search-ui-react.verticallabelmap.md index d9667c4d3..542794d01 100644 --- 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. Signature: ```typescript -export interface VerticalLabelMap +export interface VerticalLabelMap> ``` diff --git a/docs/search-ui-react.verticalresults.md b/docs/search-ui-react.verticalresults.md index 550c6c9de..8f2d5e1a3 100644 --- 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. Signature: ```typescript -export declare function VerticalResults(props: VerticalResultsProps): JSX.Element | null; +export declare function VerticalResults(props: VerticalResultsProps): 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)<T> | [VerticalResultsProps](./search-ui-react.verticalresultsprops.md) | Returns: diff --git a/docs/search-ui-react.verticalresultsprops.cardcomponent.md b/docs/search-ui-react.verticalresultsprops.cardcomponent.md index 2a0d78738..61e5fd146 100644 --- 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. Signature: ```typescript -CardComponent: CardComponent; +CardComponent: CardComponent; ``` diff --git a/docs/search-ui-react.verticalresultsprops.md b/docs/search-ui-react.verticalresultsprops.md index 5fa0a4cff..183f8f4c5 100644 --- a/docs/search-ui-react.verticalresultsprops.md +++ b/docs/search-ui-react.verticalresultsprops.md @@ -9,14 +9,14 @@ Props for the VerticalResults component. Signature: ```typescript -export interface VerticalResultsProps +export interface VerticalResultsProps ``` ## 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)<T> | 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) | (Optional) CSS classes for customizing the component styling. | | [displayAllOnNoResults?](./search-ui-react.verticalresultsprops.displayallonnoresults.md) | boolean | (Optional) 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 index 2344fa3f7..ed182ad01 100644 --- 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> { currentVerticalLabel: string; customCssClasses?: AlternativeVerticalsCssClasses; displayAllOnNoResults?: boolean; - verticalConfigMap: VerticalLabelMap; + verticalConfigMap: VerticalLabelMap; } // @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> = (props: CardProps) => JSX.Element; +export type CardComponent = (props: CardProps) => JSX.Element; // @public export type CardCtaEventType = 'CTA_CLICK' | 'TITLE_CLICK'; // @public -export interface CardProps> { +export interface CardProps { result: Result; } @@ -673,7 +675,7 @@ export interface UniversalResultsCssClasses extends SectionHeaderCssClasses { } // @public -export interface UniversalResultsProps { +export interface UniversalResultsProps> { customCssClasses?: UniversalResultsCssClasses; showAppliedFilters?: boolean; verticalConfigMap: VerticalConfigMap; @@ -704,13 +706,13 @@ export interface VerticalConfig> { } // @public -export interface VerticalConfigMap { +export interface VerticalConfigMap> { [verticalKey: string]: VerticalConfig; } // @public -export interface VerticalLabelMap { - [verticalKey: string]: Pick; +export interface VerticalLabelMap> { + [verticalKey: string]: Pick, 'label'>; } // @public @@ -720,7 +722,7 @@ export interface VerticalLink { } // @public -export function VerticalResults(props: VerticalResultsProps): JSX.Element | null; +export function VerticalResults(props: VerticalResultsProps): JSX.Element | null; // @public export interface VerticalResultsCssClasses { @@ -731,8 +733,8 @@ export interface VerticalResultsCssClasses { } // @public -export interface VerticalResultsProps { - CardComponent: CardComponent; +export interface VerticalResultsProps { + CardComponent: CardComponent; customCssClasses?: VerticalResultsCssClasses; displayAllOnNoResults?: boolean; }