Skip to content

docs(clarity): document env var name and call out common mistake#774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
harlan-zw wants to merge 1 commit into from
Closed

docs(clarity): document env var name and call out common mistake #774

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/content/scripts/clarity.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,3 +54,25 @@ consent.set({
```

See [Clarity cookie consent](https://learn.microsoft.com/en-us/clarity/setup-and-installation/cookie-consent) for details.

## With Environment Variables

You can supply your Clarity project id with an environment variable. The env var name follows the registry key (`clarity`), not the marketing name:

```ts [nuxt.config.ts]
export default defineNuxtConfig({
scripts: {
registry: {
clarity: { trigger: 'onNuxtReady' },
},
},
})
```

```text [.env]
NUXT_PUBLIC_SCRIPTS_CLARITY_ID=<YOUR_PROJECT_ID>
```

::warning
The env var key must match the registry key. For Clarity that is `NUXT_PUBLIC_SCRIPTS_CLARITY_ID`, not `NUXT_PUBLIC_SCRIPTS_MICROSOFT_CLARITY_ID`.
::
Loading