Functions

widgetNavigationClick

Version:


Type	Function
Import path	`@sitecore-cloudsdk/search/server`

Sends a navigation click event.

Signature

export async function widgetNavigationClick(
  widgetNavigationClickEventParams: WidgetNavigationClickEventParams
): Promise<void>

Parameters

Name	Type	Description
`widgetNavigationClickEventParams`	`WidgetNavigationClickEventParams`	Data for navigation click events.

Return value

Returns a promise.

Examples

Example 78. Running the widgetNavigationClick 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 widgetNavigationClick function:

import type { NextRequest } from "next/server";
import { NextResponse } from "next/server";
import { CloudSDK } from "@sitecore-cloudsdk/core/server";
import { widgetNavigationClick } from "@sitecore-cloudsdk/search/server";
import type { WidgetNavigationClickEventParams } from "@sitecore-cloudsdk/search/server";

export default async function middleware(request: NextRequest) {
  const response = NextResponse.next();

  // Initialize the SDK and the package...

  // Send event:
  const eventData: WidgetNavigationClickEventParams = {
    widgetId: "rfkid_2",
    pathname: "/rec",
    itemPosition: 1
  };

  const widgetNavigationClickResponse = await widgetNavigationClick(request, eventData);
  console.log("Sent widget navigation click event.", widgetNavigationClickResponse);

  return response;
};

:::

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