1. Functions

widgetSuggestionClick

Version:
TypeFunction
Import path@sitecore-cloudsdk/search/browser

Sends a suggestion click event.

Signature

export async function widgetSuggestionClick(
  widgetSuggestionClickEventParams: WidgetSuggestionClickEventParams
): Promise<EPResponse | null>

Parameters

NameTypeDescription
widgetSuggestionClickEventParamsWidgetSuggestionClickEventParamsData for suggestion click events.

Return value

Returns a promise.

Examples

Example 72. Running the widgetSuggestionClick function

Note

To run this function, you have to first initialize the Cloud SDK.

See more examples and other data you can include in the event.

Here's an example of how to use the widgetSuggestionClick function:

import { widgetSuggestionClick } from "@sitecore-cloudsdk/search/browser";
import type { WidgetSuggestionClickEventParams } from "@sitecore-cloudsdk/search/browser";

const eventData: WidgetSuggestionClickEventParams = {
  request: {
    keyword: "green"
  },
  pathname: "/page",
  widgetId: "rfkid_6"
};

widgetSuggestionClick(eventData);

:::

If you have suggestions for improving this article, let us know!