Fathom Analytics tracking for your Astro site.
npm install astro-fathomUse this package to add Fathom's tracking script to your Astro site.
Astro Fathom exposes all the advanced tracking options as component properties and stubs in a console logger when analytics are disabled for easy debugging.
> Fathom is a simple, light-weight, privacy-first alternative to Google Analytics. So, stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don’t need. Our website stats show up on a single, blazingly fast dashboard so you can make business decisions quickly.
From the Fathom website.
npm install astro-fathom
or
pnpm install astro-fathom
or if you really have to,
yarn add astro-fathom
This package includes a .
``astro
---
import { Fathom } from "astro-fathom"
---
Just looking for a basic script installation? That's it, you're all set!
The Fathom script will be included in all production builds. When running with
, window.fathom will be shimmed with a logger that outputs all tracking events to the browser's console instead.$3
It's common to keep analytics events separate for different deployment environments - for example
test, staging, and production. We recommend using the environment variable listed below to configure the correct site, keeping your analytics configuration in the same place as your other environment configuration variables.$3
> Support for custom domains via the
trackingUrl option was removed in version 2.0. See Fathom's docs for more details.See the Fathom docs for more information on these advanced tracking options.
| Name | Type | Default | Description |
| ----------------- | --------------------------------- | ----------------------------- | -------------------------------------------------- |
|
enabled | Boolean | import.meta.env.PROD | When disabled, events are logged to the console |
| site | String | import.meta.env.FATHOM_SITE | Your Fathom site id (required) |
| honorDnt | Boolean | false | Honor Do Not Track? |
| auto | Boolean | true | Automatically track page views? |
| canonical | Boolean | true | Use the canonical URL, instead of the current URL? |
| excludedDomains | String[] | [] | Excludes tracking for these domains |
| includedDomains | String[] | [] | Include tracking for these domains |
| spa | "auto", "history" or "hash" | "auto" | Tracking mode |
| loadType | "defer" or "async" | "defer" | Tracking mode |#### Example
`astro
---
import { Fathom } from "astro-fathom"
---
``If you have any questions, feedback, or suggestions head over to the discussions page.
If you find a bug please open an issue. Community pull requests to fix the issue are always appreciated!