React and Next.js

The @faststats/react package wraps the browser SDK in a single component and a set of hooks. It works with any React app and with the Next.js App Router.

InstallCopy Anchor Link

Copy Text
npm install @faststats/react

Add the Analytics ComponentCopy Anchor Link

Render the Analytics component once, near the root of your app. It starts tracking when it mounts and cleans up when it unmounts. You never have to create an instance by hand.

Copy Text
import { Analytics } from "@faststats/react";

export default function RootLayout({
	children,
}: {
	children: React.ReactNode;
}) {
	return (
		<html lang="en">
			<body>
				<Analytics siteKey={process.env.NEXT_PUBLIC_FASTSTATS_SITE_KEY!} />
				{children}
			</body>
		</html>
	);
}

The component accepts every option from the SDK. Here is a fuller example that turns on a few extra features.

Copy Text
import { Analytics } from "@faststats/react";
import { errorTracking } from "@faststats/react/error";
import { sessionReplay } from "@faststats/react/replay";
import { webVitals } from "@faststats/react/web-vitals";

<Analytics
	siteKey={process.env.NEXT_PUBLIC_FASTSTATS_SITE_KEY!}
	extensions={[errorTracking(), webVitals(), sessionReplay()]}
/>;

Options are read when the component mounts. Only changes to the consent prop are applied to the running client afterwards. See Configuration for the full list.

Track Custom EventsCopy Anchor Link

Use the hooks inside client components. They access the instance owned by the nearest mounted Analytics component.

Copy Text
"use client";

import { useTrack } from "@faststats/react";

export function BuyButton() {
	const track = useTrack();
	return (
		<button
			type="button"
			onClick={() => track("purchase", { plan: "pro", price: 29 })}
		>
			Buy now
		</button>
	);
}

useEvent builds a stable handler when the name and properties do not change.

Copy Text
const onSignup = useEvent("signup", { source: "hero" });
return (
	<button type="button" onClick={onSignup}>
		Sign up
	</button>
);

Identify Users and Update TraitsCopy Anchor Link

useIdentify links the visitor to your user after sign-in. useSetTraits updates traits on that user later without a full identify, for example after a plan upgrade.

Copy Text
"use client";

import { useSetTraits } from "@faststats/react";

export function UpgradeButton() {
	const setTraits = useSetTraits();
	return (
		<button
			type="button"
			onClick={async () => {
				await upgradeToPro();
				await setTraits({ plan: "pro" });
			}}
		>
			Upgrade
		</button>
	);
}

Pass { mode: "setOnce" } to only set traits the user does not have yet, such as where they first came from. Called before useIdentify, traits are kept in memory for the current page and sent right after the next identify on that page. useSetTraits needs @faststats/react 0.14.0 or later. See Identify for details.

Available HooksCopy Anchor Link

Read more in Events, Identify, and Consent and Cookieless.

Server Side RoutesCopy Anchor Link

The React package only runs in the browser. If you also want to capture errors thrown in Next.js route handlers or server functions, read the server section in Error Tracking.