Hotjar (deprecated)

hotjar() from consentlayer/providers/hotjar loads Hotjar once analytics consent is granted. It is deprecated: Hotjar accounts are moving to Contentsquare, so switch to contentsquare() once yours has.

import { hotjar } from 'consentlayer/providers/hotjar'

hotjar({ siteId: process.env.NEXT_PUBLIC_HOTJAR_SITE_ID, version: process.env.NEXT_PUBLIC_HOTJAR_VERSION })

Options

Option	Type	Default	Description
siteId	number | string | undefined	Required	The Hotjar site ID, as a number or a string of digits.
version	number | string | undefined	Required	The snippet version, hjsv, as a number or a string of digits.
reloadOnRevoke	boolean	false	Reloads the page when analytics consent is withdrawn.
events	string[] | false	All events	The event names track() sends to it; false sends none. See Routing events.

An unset, empty or whitespace-only siteId or version turns the provider off. Surrounding whitespace is trimmed. Any other value that is not a positive integer, written as a number or in digits, such as '1e3' or '12.0', throws [consentlayer] Invalid Hotjar siteId or version: expected positive integers, ….

How it works

Events are sent as hj('event', name). identify calls hj('identify', userId, traits), adding the email to the attributes when both a user ID and an email are known.

Withdrawing consent

Hotjar’s script cannot be stopped once loaded. Withdrawing analytics consent expires every cookie whose name starts with _hj and removes every localStorage and sessionStorage key matching ^_?hj, but the script keeps running until the page reloads. Set reloadOnRevoke: true to reload immediately.