ngx-zendesk-webwidget


Zendesk-Webwidget for Angular 2+

Zendesk-Webwidget for Angular 1.x see here

Installation

Via npm:

``bash
npm install @nitsanzo/ngx-zendesk-webwidget
`

Usage

Add to your tsconfig.json file, to paths ngx-zendesk-webwidget:
`json
"compilerOptions": {
"paths": {
"ngx-zendesk-webwidget": ["node_modules/@nitsanzo/ngx-zendesk-webwidget"]
}
`


The examples were made using the classic web widget

$3

`ts
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

import { NgxZendeskWebwidgetModule } from 'ngx-zendesk-webwidget';

@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
NgxZendeskWebwidgetModule.forRoot()
],
bootstrap: [AppComponent]
})
export class AppModule { }
`

#### SharedModule

`ts
@NgModule({
exports: [
CommonModule,
NgxZendeskWebwidgetModule
]
})
export class SharedModule { }
`

##### Configuration

`ts
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { NgxZendeskWebwidgetModule, NgxZendeskWebwidgetConfig } from 'ngx-zendesk-webwidget';

import { AppComponent } from './app';

export class ZendeskConfig extends NgxZendeskWebwidgetConfig {
accountUrl = 'yourdomain.zendesk.com';
callback(zE) {
// You can call every command you want in here
// zE('webWidget', 'hide');
// zE('webWidget', 'show');
}
}

@NgModule({
imports: [
BrowserModule,
HttpClientModule,
NgxZendeskWebwidgetModule.forRoot(ZendeskConfig)
],
bootstrap: [AppComponent]
})
export class AppModule { }
`

##### Configuration with Lazyload

`ts
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { NgxZendeskWebwidgetModule, NgxZendeskWebwidgetConfig } from 'ngx-zendesk-webwidget';

import { AppComponent } from './app';

export class ZendeskConfig extends NgxZendeskWebwidgetConfig {
override lazyLoad = true;
accountUrl = 'yourdomain.zendesk.com';
callback(zE) {
// You can call every command you want in here
// zE('webWidget', 'hide');
// zE('webWidget', 'show');
}
}

@NgModule({
imports: [
BrowserModule,
HttpClientModule,
NgxZendeskWebwidgetModule.forRoot(ZendeskConfig)
],
bootstrap: [ AppComponent ]
})
export class AppModule { }
`

#### 2. Init the NgxZendeskWebwidgetService

##### For your application

`ts
import { NgxZendeskWebwidgetService } from 'ngx-zendesk-webwidget';

@Component({
selector: 'app',
templateUrl: './app.html'
})
export class app {

constructor(private _NgxZendeskWebwidgetService: NgxZendeskWebwidgetService) { }

}
`

##### With Lazyload

`ts
import { NgxZendeskWebwidgetService } from 'ngx-zendesk-webwidget';

@Component({
selector: 'app',
templateUrl: './app.html'
})
export class app {

constructor(private _NgxZendeskWebwidgetService: NgxZendeskWebwidgetService) {
this._NgxZendeskWebwidgetService_.initZendesk();
}

}
`

#### 3. Example to usage

`ts
constructor(private _NgxZendeskWebwidgetService: NgxZendeskWebwidgetService) {
this._NgxZendeskWebwidgetService.zE('webWidget', 'identify', {
name: 'Fulano de Tal',
email: 'your_user_email@email.com'
});

this._NgxZendeskWebwidgetService.zE('webWidget', 'prefill', {
name: {
value: 'Fulano de Tal',
readOnly: true
},
email: {
value: 'your_user_email@email.com',
readOnly: true
}
});

this._NgxZendeskWebwidgetService.zE('webWidget', 'show');
}

logout() {
this._NgxZendeskWebwidgetService.zE('webWidget', 'hide');
}
`

API

$3

$3

- The new web widget is not as supported as the classic one, you can check the documentation here.

$3

- zE('webWidget:', '', ): All commands follow the same basic syntax. Please see Zendesk Documentation for more information.

#### NgxZendeskWebwidgetConfig

- lazyLoad: Boolean for activate Lazyload initialization of Zendesk Web Widget
- timeOut: Timeout in milliseconds of the timer before opening the widget, zendesk unfortunately needs to load more files after the initial promise has been resolved, such as translation files. (default: 30 seconds)
- injectionTag: You can identify which tag will be used as a reference for widget injection('head', 'body', 'script'). (Default: 'head')
- accountUrl: Url of your domain (example.zendesk.com)
- callback`: Callback, executed after Zendesk loaded

Issues

Please report bugs and issues here.

To do

- Tests with jest
- Error handler

License

MIT © Alison Vilela

Change log

$3

- Fix documentation

$3

- Support Angular 13
- Changed the library core
- Fix initZendesk parameters based on issue 47 and issue 43

$3

- Fix injectionTag in NgxZendeskWebwidgetConfig based on issue 30 by mps2209

$3

- Include injectionTag in NgxZendeskWebwidgetConfig based on issue 30

$3

- API services that used legacy zE methods (setLocale, identify, hide, show, activate, setHelpCenterSuggestions, setSettings) have been removed, you now need to use the new command syntax for greater flexibility (breaking changes)
- beforePageLoad(zE) changed to callback(zE) (breaking changes)

$3

- Fix bugs

$3

- Update Packages
- Change Class name to pascal case (breaking changes)
- Lazyload Implemented, based on Pull 23
- Configure Timeout on Webwidget initialization

$3

- Support Angular 8

$3

- Support Angular 6

$3

- Support Angular 5

$3

- Added custom settings

$3

- Change documentation

$3

- Added documentation
- Initial version