Astro Matomo

!npm
!npm
!GitHub package.json version
!GitHub Workflow Status

Installation

``bash
pnpm add astro-matomo

npm install astro-matomo

yarn add astro-matomo
`

Options

| Options | Type | Description |
| ------------------ | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enabled | boolean | Controls if the matomo script should be loaded |
| host | string | Url to your matomo installation |
| siteId | number | Matomo site id. |
| heartBeatTimer? | number | If set the heart beat timer will be enabled |
| disableCookies? | boolean | If set cookies will be disabled |
| preconnect? | boolean | Will create a preconnect link pointing to the matomo host |
| setCookieDomain? | string | Share the tracking cookie across multiple domains |
| trackerUrl? | string | Defaults to matomo.php |
| srcUrl? | string | Defaults to matomo.js |
| customSrcUrl? | string | Optional. A full URL to the Matomo tracking script. If set, it overrides srcUrl. |
| debug? | boolean | Activate debug mode |
| partytown? | boolean | Adds Partytown support. Matomo added as: |
| crossOrigin? | string | Set crossorigin attribute |
| viewTransition? | boolean or { contentElement: string } | If true Matomo works in "SPA Mode" and will track every page visit after astro:page-load. When you pass a selector to contentElement Matomo is able to track new media files, forms and content |

Example usage

`js
// astro.config.mjs

import { defineConfig } from 'astro/config';
import matomo from 'astro-matomo';

// https://astro.build/config
export default defineConfig({
site: "https://example.lol",
integrations: [
matomo({
enabled: import.meta.env.PROD, // Only load in production
host: "https://analytics.example.lol/",
setCookieDomain: "*.example.lol",
trackerUrl: "js/", // defaults to matomo.php
srcUrl: "js/", // defaults to matomo.js
siteId: 666,
heartBeatTimer: 5,
disableCookies: true,
debug: false,
viewTransition: {
contentElement: "main"
}
}),
]
});

`

Development

Go to demo directory:

`bash
cd demo
`

Go to the demo project and install the dev package:

`bash
pnpm install

npm install
`

Start the dev server:

`bash
pnpm run dev

npm run dev
``