Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

react-microsoft-clarity

MarcoPerson137.4kMIT2.0.0TypeScript support: included

A simple small component to implement Microsoft Clarity into your React Application

Clarity, Microsoft, React

readme

react-microsoft-clarity

Small component to implement Microsoft Clarity into your React Application

Installation

npm install react-microsoft-clarity --save

Use / Example

import { clarity } from 'react-microsoft-clarity';

// Start seeing data on the Clarity dashboard with your id
clarity.init(id);

// Identify the user
clarity.identify('USER_ID', { userProperty: 'value' });

// Cookie consent
clarity.consent();

// Stop tracking user behavior analytics
clarity.stop();

// Restart tracking user behavior analytics
clarity.start();

// Setup a custom tag
clarity.setTag('key', 'value');

// Setup a smart event
clarity.setEvent("eventName");

// Upgrade session
clarity.upgrade('upgradeReason');

// Check if Clarity has been initialized before calling its methods
if (clarity.hasStarted()) {
  clarity.identify('USER_ID', { userProperty: 'value' });
}
  • id: Stands for 'Clarity ID' - Your site's ID. This is the ID which tells Clarity which site settings it should load and where it should save the data collected.

You can learn more from Clarity Docs