@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.
```bash
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:
```ts
import { ScreebModule } from "@screeb/sdk-angular";
@NgModule({
imports: [
// ...
ScreebModule.forRoot({
autoInit: true,
websiteId: "",
userId: "",
userProperties: {
firstname: '',
lastname: '',
plan: '',
last_seen_at: new Date(),
authenticated: true
}
})
// ...
]
})
export class AppModule {}
```
Then, if you need to use Screeb SDK API, in any module:
```ts
// 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,
});
}
}
```
### Custom domains (AdBlocker bypass)
If you route Screeb traffic through your own domain (reverse proxy) to bypass AdBlockers, pass the
`endpoints` (and optionally `screebEndpoint` for the loader URL) through `options` in
`ScreebModule.forRoot`. Only the endpoints you provide are overridden; the rest fall back to
Screeb's defaults.
```ts
ScreebModule.forRoot({
autoInit: true,
websiteId: "",
options: {
screebEndpoint: "https://analytics.acme.com/sdk/tag.js",
endpoints: {
rpc: "https://analytics.acme.com/rpc",
static: "https://analytics.acme.com/static",
report: "https://analytics.acme.com/report",
hostedPage: "https://analytics.acme.com/hosted-page",
centipede: "wss://analytics.acme.com/centipede",
},
},
})
```
All endpoints must use `https://` (or `wss://` for `centipede`) and the domains must be allow-listed
in **Screeb Admin → Settings → Custom Domains**. See the
[Custom Collector URL guide](https://developers.screeb.app/sdk-js/custom-collector-url).
For a working example, see our [Screeb Angular SDK example app](https://github.com/ScreebApp/sdk/tree/master/examples/example-angular).
For a more advanced usage and a complete API documentation, see [documentation generated from source files](https://github.com/ScreebApp/sdk/tree/master/packages/sdk-angular/docs).
For further information, see [our developer documentation](https://developers.screeb.app/sdk-js/install).
## Support
For any issues, please contact our support team at support@screeb.com.
## 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](https://github.com/ScreebApp/sdk/blob/master/LICENSE).