getClientBrowserParameters

Gathers client browser values commonly used for analytics

Example code

import * as React from 'react';
import {useEffect} from 'react';
import {getClientBrowserParameters} from '@shopify/hydrogen-react';

export default function App({Component, pageProps}) {
  useEffect(() => {
    getClientBrowserParameters();
  });

  return <Component {...pageProps} />;
}

import * as React from 'react';
import {useEffect} from 'react';
import {getClientBrowserParameters} from '@shopify/hydrogen-react';

export default function App({Component, pageProps}) {
  useEffect(() => {
    getClientBrowserParameters();
  });

  return <Component {...pageProps} />;
}

getClientBrowserParameters

If executed on server, this method will return empty string for each field.

GetClientBrowserParametersGeneratedType

Returns: ClientBrowserParameters

export function getClientBrowserParameters(): ClientBrowserParameters { if (errorIfServer('getClientBrowserParameters')) { return { uniqueToken: '', visitToken: '', url: '', path: '', search: '', referrer: '', title: '', userAgent: '', navigationType: '', navigationApi: '', }; } const [navigationType, navigationApi] = getNavigationType(); const cookies = getShopifyCookies(document.cookie); return { uniqueToken: cookies[SHOPIFY_Y], visitToken: cookies[SHOPIFY_S], url: location.href, path: location.pathname, search: location.search, referrer: document.referrer, title: document.title, userAgent: navigator.userAgent, navigationType, navigationApi, }; }

ClientBrowserParameters

navigationApi

Navigation api: `'PerformanceNavigationTiming' | 'performance.navigation'`. Use `getClientBrowserParameters()` to collect this value.

navigationType

Navigation type: `'navigate' | 'reload' | 'back_forward' | 'prerender' | 'unknown'`. Use `getClientBrowserParameters()` to collect this value.

path

Value of `window.location.pathname`. Use `getClientBrowserParameters()` to collect this value.

referrer

Value of `window.document.referrer`. Use `getClientBrowserParameters()` to collect this value.

search

Value of `window.location.search`. Use `getClientBrowserParameters()` to collect this value.

title

Value of `document.title`. Use `getClientBrowserParameters()` to collect this value.

uniqueToken

Shopify unique user token: Value of `_shopify_y` cookie. Use `getClientBrowserParameters()` to collect this value.

url

Value of `window.location.href`. Use `getClientBrowserParameters()` to collect this value.

userAgent

Value of `navigator.userAgent`. Use `getClientBrowserParameters()` to collect this value.

visitToken

Shopify session token: Value of `_shopify_s` cookie. Use `getClientBrowserParameters()` to collect this value.

Related

  • sendShopifyAnalytics
  • useShopifyCookies