README

ng-fullstory

This is an Fullstory wrapper for Angular 5+ that supports AoT and SSR.

BETA VERSION

master is now hosting the 1.0.0 beta version of ng-fullstory. If you need to make changes to the latest stable version, please PR against 0.x.x. If you need to use the last 0.x version, please run npm install --save --save-exact ng-fullstory@0.2.

If you find issues with this version, please file an issue as soon as possible so we can take a look at it. We appreciate your cooperation!

ALPHA VERSION

If you want to try the latest features, check out the 1.0.0-alpha branch! Features include automatic script loading and fullstory directives! If you find an issue, please report it!

Installation

This package is on NPM, so just run

$ npm install ng-fullstory@latest --save

Configuration

Import FullstoryModule to app.module.ts.

import { FullstoryModule } from 'ng-fullstory';

@NgModule({
  imports: [
    ...
    FullstoryModule.forRoot({
      fsOrg: <your_fs_org>, // from your Fullstory config
    })
    ...
  ]
})
export class AppModule { }

Use in your components/directives/whatever you want!

// App
import { Component, OnInit } from '@angular/core';
import { Fullstory } from 'ng-fullstory';

@Component({
  selector: 'app',
  template: `...`
})
export class AppComponent implements OnInit, OnDestroy {
  constructor(
    public fullstory: Fullstory
  ){}

  ngOnInit() {
    this.fullstory.login({
      user_id: <user id>,
      name: <user display name>,
      email: <user email>
    });
  }
  
  ngOnDestroy() {
      this.fullstory.logout();
    }
}

Development

To run live testing: ng test

To run tests: npm test

To run distribution: npm run build:dist

To publish npm run build:dist && npm publish dist

Credits

Maintained by Scott Wyatt

Usage no npm install needed!