Astro-simpleanalytics-plugin NPM

Astro Simple Analytics Plugin

Simple Analytics is a clean, simple, and privacy friendly analytics tool. Actionable data in a beautiful dashboard. It does not use cookies and you can bypass ad blockers. Make sure to signup to get most value out of this plugin.

Astro is a website build tool for the modern web — powerful developer experience meets lightweight output.

This is a Simple Analytics plugin for Astro.

Astro Simple Analytics Plugin

🚀 Installation

First, install the astro-simpleanalytics-plugin package using your package manager. Run this in the terminal:

# using PNPM
pnpm install astro-simpleanalytics-plugin
# Using Yarn
yarn add astro-simpleanalytics-plugin
# Using NPM
npm install astro-simpleanalytics-plugin

✨ Usage

You then need to import astro-simpleanalytics-plugin and then use the <SimpleAnalytics /> component and add the desired properties to it. This will render out the tags in the location you place the <SimpleAnalytics /> component in. We suggest using your layout from the ./layouts folder (e.g. ./layouts/Layout.astro and/or other equivalent layouts), just before the closing </body> tag.

  // Layout.astro
  ---
+ import { SimpleAnalytics } from 'astro-simpleanalytics-plugin';
  ---

  <!doctype html>
  <html>
    <head>...</head>
    <body>
      ...
+     <SimpleAnalytics />
    </body>
  </html>

Simple Analytics should be ready to go with zero config.

📃 Complete parameter configuration reference

These are all the available parameter options for this plugin where you choose to embed it, alongside the default values for each parameter:

<SimpleAnalytics
  debug={false}                  {/* (false | true) */}
  allEnvironments={false}        {/* (false | true) */}
  partytown={false}              {/* (false | true) */}
  light={false}                  {/* (false | true) */}
  collectDNT={false}             {/* (false | true) */}
  strictUTMs={false}             {/* (false | true) */}
  allowParams={undefined}        {/* (undefined | string) */}
  customHostname={undefined}     {/* (undefined | string) */}
  customDomain={undefined}       {/* (undefined | string) */}
  ignorePages={undefined}        {/* (undefined | string) */}
  nonUniqueHostnames={undefined} {/* (undefined | string) */}
  ignoreMetrics={undefined}      {/* (undefined | string) */}
  crossorigin="anonymous"        {/* (undefined | "anonymous" | "use-credentials") */}
/>

Read more about the available features in the dedicated features document.

🐞 Troubleshooting

If your Simple Analytics fails to render or load properly, or fails to send data into your dashboard, make sure you:

activate debugging mode;
deactivate your Ad Blocker or read about your options for circumventing ad blocking;
read about setting your CSP (Content Security Policy) correctly;
if nothing works, send us an issue or seek support from Simple Analytics directly.

💡 Examples

Check out the embedded ./demo project (derived from the Astro 3.0 create-astro starter scaffolding, using the blog template).
Browse projects with Astro Simple Analytics Plugin on GitHub for more examples!

🙏 Contributing

Bug reports and pull requests are always welcome on our GitHub.

If you'd like to contribute with code, please read our contribution guidelines in the CONTRIBUTING.md guide and see our roadmap.

Thank you!

📝 Other details

This package is available as open source under the terms of the ISC License.

See CHANGELOG.md for a history of changes to this integration.

This package has initially been used for building Resurse.dev - an online resource repository for people starting out in digital careers from Development to Design, from Marketing to Security, created for free by Viorel and his YouTube community. It was made by Viorel Mocanu after a challenge from Adriaan van Rossum.