@coveo/headless-react
    Preparing search index...

    Interface NavigatorContext

    The NavigatorContext interface represents the context of the browser client.

    interface NavigatorContext {
        capture?: boolean;
        clientId: string;
        forwardedFor?: string;
        location: string | null;
        referrer: string | null;
        userAgent: string | null;
    }
    Index

    Properties

    capture? clientId forwardedFor? location referrer userAgent

    Properties

    capture?: boolean

    Whether to capture analytics events.

    Must be left undefined or set to false if the clientId is an empty string, otherwise requests will fail.

    clientId: string

    The unique identifier of the browser client in a Coveo-powered page. See clientId.

    forwardedFor?: string

    TheX-Forwarded-For header. This header is used to identify the originating IP address of a client. See X-Forwarded-For

    Note: This property is only relevant for Server-Side Rendering (SSR) use cases.

    location: string | null

    The URL of the current page.

    referrer: string | null

    The URL of the page that referred the user to the current page. See Referer

    userAgent: string | null

    The user agent string of the browser that made the request. See User-Agent

    Settings

    Member Visibility
    In this article
    Properties