Easy integration of Microsoft Clarity into your Laravel application.
MIT License
Easy integration of Microsoft Clarity into your Laravel application.
You can install the package via composer:
composer require abr4xas/clarity-laravel
You can publish the config file with:
php artisan vendor:publish --tag="clarity-config"
This is the contents of the published config file:
<?php
return [
'id' => env('CLARITY_ID', 'XXXXXX'),
'enabled' => env('CLARITY_ENABLED', true),
];
Optionally, you can publish the views using
php artisan vendor:publish --tag="clarity-views"
The enabled
attribute is optional, but can be used to control the tags integration from blade files that extend the base layout. It accepts true/false
.
This can still be controlled globally via the .env
file should you need to disable the integration global on different environments as well.
<!-- Should be placed in the head -->
<x-clarity::script :enabled="$enabled" />
To implement the Identify API, use identify
component.
Set CLARITY_IDENTIFICATION_ENABLED
value to true
on the env file.
user
attribute is required accepts the User Model instance or any object. The email
and name
attributes are used.enabled
attribute is optional.custom_session_id
attribute is optional.custom_page_id
attribute is optional.@auth
<x-clarity::identify :user="request()->user()"/>
@endauth
This will compile as:
window.clarity("identify", "[email protected]", null, null, "Username")
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.
This package is strongly inspired by Google Tag Manager for Laravel created by @awcodes.