Osirion.Blazor.Analytics 2.1.1

Osirion.Blazor.Analytics

Analytics integration for Blazor applications, supporting multiple providers with SSR compatibility.

Features

• Multiple Providers: Microsoft Clarity and Matomo support out of the box
• Provider Pattern: Easily extend with your own analytics providers
• SSR Compatible: Works with Server-Side Rendering and Static SSG
• Configuration-Driven: Simple setup through dependency injection
• Privacy-Focused: Opt-in tracking with consent options

Installation

dotnet add package Osirion.Blazor.Analytics

Usage

Quick Start

// In Program.cs
using Osirion.Blazor.Analytics.Extensions;

builder.Services.AddOsirionAnalytics(analytics => {
    analytics
        .AddClarity(options => {
            options.SiteId = "your-clarity-site-id";
        })
        .AddMatomo(options => {
            options.SiteId = "1";
            options.TrackerUrl = "//analytics.example.com/";
        });
});

@using Osirion.Blazor.Analytics.Components


<ClarityTracker />
<MatomoTracker />

With Configuration

// In appsettings.json
{
  "Osirion": {
    "Analytics": {
      "Clarity": {
        "SiteId": "your-clarity-site-id",
        "Enabled": true
      },
      "Matomo": {
        "SiteId": "1",
        "TrackerUrl": "//analytics.example.com/",
        "TrackLinks": true,
        "RequireConsent": false
      }
    }
  }
}

// In Program.cs
builder.Services.AddOsirion(builder.Configuration);

Manual Tracking

@inject IAnalyticsService Analytics

// Track a page view
await Analytics.TrackPageViewAsync("/custom-path");

// Track an event
await Analytics.TrackEventAsync("category", "action", "label", value);

Creating Custom Providers

public class CustomProvider : IAnalyticsProvider
{
    public string ProviderId => "custom";
    public bool IsEnabled => true;
    public bool ShouldRender => true;

    public Task TrackEventAsync(string category, string action, string? label = null, object? value = null, CancellationToken cancellationToken = default)
    {
        // Custom implementation
        return Task.CompletedTask;
    }

    public Task TrackPageViewAsync(string? path = null, CancellationToken cancellationToken = default)
    {
        // Custom implementation
        return Task.CompletedTask;
    }

    public string GetScript()
    {
        return "<script>/* Custom tracking script */</script>";
    }
}

// Register the provider
builder.Services.AddOsirionAnalytics(analytics => {
    analytics.AddProvider<CustomProvider>();
});

Documentation

For more detailed documentation, see Analytics Documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.