{"id":50893867,"url":"https://github.com/mitsuru17/ngx-umami","last_synced_at":"2026-06-18T02:00:57.281Z","repository":{"id":333228603,"uuid":"1136608645","full_name":"mitsuru17/ngx-umami","owner":"mitsuru17","description":"ngx-umami is a lightweight, modern library designed to seamlessly integrate Umami Analytics into Angular apps. Built for Angular v16+, it prioritizes simplicity and strong typing while utilizing standalone APIs and functional injection to keep your architecture clean and dependency-free.","archived":false,"fork":false,"pushed_at":"2026-05-29T07:19:48.000Z","size":162,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-06-02T00:07:23.648Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mitsuru17.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-18T02:03:09.000Z","updated_at":"2026-05-29T07:19:52.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mitsuru17/ngx-umami","commit_stats":null,"previous_names":["mitsuru17/ngx-umami"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mitsuru17/ngx-umami","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mitsuru17%2Fngx-umami","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mitsuru17%2Fngx-umami/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mitsuru17%2Fngx-umami/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mitsuru17%2Fngx-umami/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mitsuru17","download_url":"https://codeload.github.com/mitsuru17/ngx-umami/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mitsuru17%2Fngx-umami/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34472826,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-18T02:00:06.871Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-15T23:00:25.064Z","updated_at":"2026-06-18T02:00:57.224Z","avatar_url":"https://github.com/mitsuru17.png","language":"TypeScript","funding_links":[],"categories":["Development Utilities"],"sub_categories":["Analytics"],"readme":"# ngx-umami\n\nAngular library for [Umami Analytics](https://umami.is/) - privacy-focused, lightweight analytics tracking for Angular applications.\n\n## Features\n\n- Easy integration with Angular 17+\n- SSR compatible (Angular Universal)\n- Automatic page view tracking with Angular Router\n- Custom event tracking\n- User session identification\n- Template directive for declarative tracking\n- Respects Do Not Track browser setting\n- Domain restrictions support\n- Full TypeScript support\n\n## Installation\n\n```bash\nnpm install ngx-umami\n```\n\n## Quick Start\n\n### 1. Configure the provider\n\n```typescript\n// app.config.ts\nimport { ApplicationConfig } from '@angular/core';\nimport { provideUmami } from 'ngx-umami';\n\nexport const appConfig: ApplicationConfig = {\n  providers: [\n    provideUmami({\n      websiteId: 'your-website-id',\n      src: 'https://analytics.example.com/script.js'\n    })\n  ]\n};\n```\n\n### 2. Track events in your components\n\n```typescript\nimport { Component } from '@angular/core';\nimport { injectUmami } from 'ngx-umami';\n\n@Component({\n  selector: 'app-example',\n  template: `\u003cbutton (click)=\"onSignup()\"\u003eSign Up\u003c/button\u003e`\n})\nexport class ExampleComponent {\n  private umami = injectUmami();\n\n  onSignup() {\n    this.umami.trackEvent('signup_click', { plan: 'premium' });\n  }\n}\n```\n\n## Configuration Options\n\n```typescript\nprovideUmami({\n  // Required\n  websiteId: 'your-website-id',\n  src: 'https://analytics.example.com/script.js',\n\n  // Optional\n  enabled: true,              // Enable/disable tracking (default: true)\n  autoTrack: true,            // Auto track page views (default: true)\n  doNotTrack: false,          // Honor browser DNT setting (default: false)\n  domains: ['example.com'],   // Restrict to specific domains\n  tag: 'production',          // Tag for filtering in dashboard\n  excludeSearch: false,       // Exclude URL search params\n  excludeHash: false,         // Exclude URL hash\n  hostUrl: 'https://...'      // Custom host URL for proxy setups\n});\n```\n\n### Factory Configuration\n\nUse `provideUmamiWithFactory` when configuration depends on other services:\n\n```typescript\nimport { provideUmamiWithFactory } from 'ngx-umami';\nimport { ConfigService } from './config.service';\n\nexport const appConfig: ApplicationConfig = {\n  providers: [\n    provideUmamiWithFactory(\n      (configService: ConfigService) =\u003e ({\n        websiteId: configService.umamiWebsiteId,\n        src: configService.umamiSrc,\n        enabled: configService.isProduction\n      }),\n      [ConfigService]\n    )\n  ]\n};\n```\n\n## Router Tracking\n\nEnable automatic page view tracking on route changes:\n\n```typescript\nimport { provideRouter } from '@angular/router';\nimport { provideUmami, withRouterTracking } from 'ngx-umami';\n\nexport const appConfig: ApplicationConfig = {\n  providers: [\n    provideRouter(routes),\n    provideUmami({\n      websiteId: 'your-website-id',\n      src: 'https://analytics.example.com/script.js',\n      autoTrack: false // Disable auto tracking since router handles it\n    }),\n    withRouterTracking()\n  ]\n};\n```\n\n## API Reference\n\n### UmamiService\n\n#### `trackPageView(payload?)`\n\nTrack a page view manually.\n\n```typescript\n// Track current page\numami.trackPageView();\n\n// Track with custom data\numami.trackPageView({\n  url: '/custom-page',\n  title: 'Custom Page',\n  referrer: 'https://google.com'\n});\n```\n\n#### `trackEvent(eventName, eventData?)`\n\nTrack a custom event.\n\n```typescript\n// Simple event\numami.trackEvent('button_click');\n\n// Event with data (max 50 properties)\numami.trackEvent('purchase', {\n  product: 'Premium Plan',\n  price: 99.99,\n  currency: 'USD'\n});\n```\n\n#### `identify(sessionIdOrData, sessionData?)`\n\nIdentify a user session.\n\n```typescript\n// With ID only\numami.identify('user-123');\n\n// With ID and data\numami.identify('user-123', { plan: 'premium', role: 'admin' });\n\n// With data only\numami.identify({ plan: 'premium', role: 'admin' });\n```\n\n#### `isAvailable()`\n\nCheck if tracking is available.\n\n```typescript\nif (umami.isAvailable()) {\n  umami.trackEvent('ready');\n}\n```\n\n#### `disable()`\n\nDisable tracking programmatically.\n\n```typescript\numami.disable();\n```\n\n### UmamiTrackDirective\n\nDeclarative event tracking in templates:\n\n```html\n\u003c!-- Simple click tracking --\u003e\n\u003cbutton umamiTrack=\"signup_click\"\u003eSign Up\u003c/button\u003e\n\n\u003c!-- With event data --\u003e\n\u003cbutton\n  umamiTrack=\"purchase\"\n  [umamiTrackData]=\"{ product: 'Premium', price: 99 }\"\u003e\n  Buy Now\n\u003c/button\u003e\n\n\u003c!-- Track on different events --\u003e\n\u003cinput\n  umamiTrack=\"search_focus\"\n  umamiTrackOn=\"focus\"\n  placeholder=\"Search...\"\u003e\n```\n\nSupported events: `click`, `focus`, `blur`, `mouseenter`, `mouseleave`, `submit`\n\nImport the directive:\n\n```typescript\nimport { UmamiTrackDirective } from 'ngx-umami';\n\n@Component({\n  imports: [UmamiTrackDirective],\n  // ...\n})\n```\n\n## SSR Support\n\nngx-umami is fully compatible with Angular SSR. The library automatically detects server-side rendering and disables tracking to prevent errors.\n\n## License\n\nngx-umami is licensed under the MIT License.\n\nYou are free to use, modify, and distribute this software in both open-source\nand commercial projects, with proper attribution.\n\n## Disclaimer\n\nngx-umami is an independent community-driven project.\n\nIt is not affiliated with, endorsed by, or maintained by the Umami team or\nits contributors.\n\n\"Umami\" is a trademark of its respective owners.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmitsuru17%2Fngx-umami","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmitsuru17%2Fngx-umami","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmitsuru17%2Fngx-umami/lists"}