@daffodil/analytics

@daffodil/analytics

Overview

The Daffodil Analytics Module is a lightweight Angular package that helps integrate analytics providers into your Angular applications, supporting multiple analytics services. It simplifies event tracking and provides configuration options, such as defining analyzable actions. Notably, this module focuses on handling state-related events and operates specifically on Actions from @ngrx/store, rather than browser events. Additionally, the package includes testing utilities tailored for analytics event tracking in Angular applications.

Features

• "Opt-in" action tracking

Usage

In this example, MyAnalyticsService implements the DaffAnalyticsTrackerClass interface, providing a track method. Inside the track method, you can define your custom logic for tracking analytics events based on the provided action. The service returns an observable, indicating the success of the tracking operation. Replace the logic inside the track method with your actual analytics tracking implementation.

Define a tracking service

import { Injectable } from '@angular/core';
import { DaffAnalyticsTrackerClass } from '@daffodil/analytics';
import { Action } from '@ngrx/store';
import { Observable, of } from 'rxjs';

@Injectable({
  providedIn: 'root',
})
export class MyAnalyticsService implements DaffAnalyticsTrackerClass {

  track(action: Action): Observable<unknown> {
    // Your custom logic for tracking analytics events based on the provided action
    // Return an observable, for example, indicating whether the tracking was successful
    return of(true);
  }
}

Import DaffAnalyticsModule in Your Application

import { DaffAnalyticsModule } from '@daffodil/analytics';

// Import your custom analytics service(s)
import { MyAnalyticsService } from './path/to/my-analytics.service';

@NgModule({
  imports: [
    // Initialize Daffodil Analytics Module with custom analytics service(s)
    DaffAnalyticsModule.forRoot([MyAnalyticsService]),
    // ... other modules
  ],
  // ... other module metadata
})
export class YourAppModule { }

Changelog

0.71.0 (2024-06-05)

⚠ BREAKING CHANGES

• design: Previously, the DaffModalService required a DaffModal as an arg to close (the return type of open). This API was probably larger than it should have been, so I trimmed it down. Most consumers won't notice a return type change, but if you do, we can reconsider this change.

Features

• category: add injectable fragments and transform support to magento driver (#2828) (0968515)
• core: add observe util (#2808) (1874709)
• daffio,dgeni: docsgen guides and move under docs namespace (#2824) (47b7345)
• design: allow modal to be closed with ESC key (#2812) (e121d40)
• design: clean up accordion component and update docs (#2800) (66e9639)
• router: add daffRouterComposeGuards (#2809) (075859b)