microsoft / gatsby-plugin-clarity

Clarity Gatsby Plugin

Clarity Gatsby Plugin is created to help users add their clarity project to their Gatsby project seamlessly.

Clarity

Clarity is an open-source behavioral analytics library written in typescript, with two key goals: privacy & performance.

It helps you understand how users view and use your website across all modern devices and browsers. Understanding how users navigate, interact and browse your website can provide new insights about your users. Empathizing with your users and seeing where features fail or succeed can help improve your product, grow revenue and improve user retention.

It's the same code that powers Microsoft's hosted behavioral analytics solution: https://clarity.microsoft.com. If you would like to see a demo of how it works, checkout live demo.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Usage

• Navigate to the root of your gatsby project and run
  install gatsby-plugin-clarity

• Navigate to gatsby-config.js and add the following to your plugins array

    {
      resolve: `gatsby-plugin-clarity`,
      options: {
        // String value for your clarity project id
        // Project id is found in your clarity dashboard url
        // https://clarity.microsoft.com/projects/view/{clarity_project_id}/
        clarity_project_id: YOUR_PROJECT_ID,
        // Boolean value for enabling clarity while developing
        // true will enable clarity tracking code on both development and production environments
        // false will enable clarity tracking code on production environment only
        enable_on_dev_env: true
      },
    }

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

gatsby-plugin-clarity's Issues

Support gatsby v5

Gatsby v5 has been release and this repo stops support at v4 (and the version on npm only supports v3)

This error message displays when running gatsby build using gatsby v5.2.0:

Plugin gatsby-plugin-clarity is not compatible with your gatsby version 5.2.0 - It requires gatsby@^3.0.0-next.0

npm not up-to-date with repo

The version in this repo is 1.1.0, npm version is 2 years old and 1.0.0

See gatsby-plugin-clarity/package.json:

{
...
  "version": "1.1.0",
...
  "peerDependencies": {
    "gatsby": "^3.0.0-next.0 || ^4.0.0",
...

but on npm:

Version:
1.0.0

Respect do not track settings of end user.

It should provide an option as what the Gatsby-plugin-google-gtag does today, something option like:

respectDNT: true/false