README

轻松将 Microsoft Clarity 集成到您的 Laravel 应用程序中。

安装

您可以通过 composer 安装此包。

composer require abr4xas/clarity-laravel

您可以使用以下命令发布配置文件：

php artisan vendor:publish --tag="clarity-config"

这是发布配置文件的内容

<?php

return [
    'id' => env('CLARITY_ID', 'XXXXXX'),
    'enabled' => env('CLARITY_ENABLED', true),
];

可选地，您可以使用以下命令发布视图：

php artisan vendor:publish --tag="clarity-views"

用法

一般跟踪

• 创建账户：您需要首先在 Microsoft Clarity 上创建一个账户。您可以在他们的网站上注册并按照步骤创建账户。然后，获取您的跟踪代码即可。
• 简单地将 blade 组件添加到您的基布局文件中。

enabled 属性是可选的，但可以用来控制从 blade 文件扩展的基布局的标签集成。它接受 true/false。如果需要在不同环境中全局禁用集成，这仍然可以通过 .env 文件全局控制。

<!-- Should be placed in the head -->
<x-clarity::script :enabled="$enabled" />

识别 API

要实现 Identify API，请使用 identify 组件。在 env 文件中将 CLARITY_IDENTIFICATION_ENABLED 的值设置为 true。

属性

• user 属性是必需的，接受用户模型实例或任何对象。使用 email 和 name 属性。
• enabled 属性是可选的。
• custom_session_id 属性是可选的。
• custom_page_id 属性是可选的。

@auth
    <x-clarity::identify :user="request()->user()"/>
@endauth

这将编译为：

window.clarity("identify", "user@example.com", null, null, "Username")

测试

composer test

变更日志

请参阅 CHANGELOG 以获取有关最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 以获取详细信息。

安全漏洞

请查阅 我们的安全策略 了解如何报告安全漏洞。

致谢

• Angel
• 所有贡献者

许可协议

MIT 许可协议 (MIT)。请参阅 许可文件 以获取更多信息。

此包深受由 @awcodes 创建的 Google Tag Manager for Laravel 启发。