Home

Awesome

Ngx-Clarity

Build Test Lint

A useful Angular library that automatically injects the script tag required to use Microsoft Clarity.

Installation

npm:

npm install --save ngx-clarity

Yarn:

yarn add ngx-clarity

Compatibility

VersionAngular Version
1.x.x>=13 <15
2.x.x>=15 <18

Features

Usage

Import provideClarity from ngx-clarity and pass the required configuration when using it as a provider during application bootstrap.

import { provideClarity } from 'ngx-clarity';

@NgModule({
  providers: [
    provideClarity({
      enabled: true,
      projectId: 'my-project-id',
    }),
  ],
})
export class AppModule {}

// Or if you are using standalone bootstrap

bootstrapApplication(AppComponent, {
  providers: [
    provideClarity({
      enabled: true,
      projectId: 'my-project-id',
    }),
  ],
});

The supported configuration parameters are:

PropertyRequirementDescription
enabledRequiredWhether or not this module is enabled. Useful for disabling the analytics script in development environments.
projectIdRequiredYour Microsoft Clarity project Id. This is found in the Microsoft Clarity console.

License

MIT