screeb-sdk-angular

@screeb/sdk-angular

Screeb's browser sdk, optimized for Angular.

Continuous Product Discovery, Without the Time Sink.

Screeb is the only Continuous Product Discovery platform that lets you analyse users' behaviour, ask in-app questions, recruit people for interviews and analyse data in a blink with AI.

Installation

This library is published in the NPM registry and can be installed using any compatible package manager.

npm install @screeb/sdk-angular --save

# For Yarn, use the command below.
yarn add @screeb/sdk-angular

Usage

Basic usage:

In your app bootstrap and/or app module:

import { ScreebModule } from "@screeb/sdk-angular";

@NgModule({
  imports: [
    // ...
    ScreebModule.forRoot({
      autoInit: true,
      websiteId: "<your-website-id>",
      userId: "<your-user-id>",
      userProperties: {
        firstname: '<user-firstname>',
        lastname: '<user-lastname>',
        plan: '<user-plan>',
        last_seen_at: new Date(),
        authenticated: true
      }
    })
    // ...
  ]
})
export class AppModule {}

Then, if you need to use Screeb SDK API, in any module:

// App
import { Component, OnInit } from '@angular/core';
import { ScreebModule } from "@screeb/sdk-angular";

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

  ngOnInit() {
    this.screeb.eventTrack("screeb-sdk-angular-example started", {
      test: 123,
    });
  }
}

For a working example, see our Screeb Angular SDK example app.

For a more advanced usage and a complete API documentation, see documentation generated from source files.

For further information, see our developper documentation.

Support

For any issues, please contact our support team at [email protected].

Contributing

All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.

License

Released under MIT License.