ngx-zendesk-webwidget
TypeScript icon, indicating that this package has built-in type declarations

3.0.2 • Public • Published

ngx-zendesk-webwidget

Maintainability Build Status contributions welcome

Zendesk-Webwidget for Angular 2+

Zendesk-Webwidget for Angular 1.x see here

Installation

Via npm:

npm install ngx-zendesk-webwidget --save

Usage

The examples were made using the classic web widget

1. Import the NgxZendeskWebwidgetModule

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

@NgModule({
    exports: [
      CommonModule,
      NgxZendeskWebwidgetModule
    ]
})
export class SharedModule { }
Configuration
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
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
import { NgxZendeskWebwidgetService } from 'ngx-zendesk-webwidget';

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

  constructor(private _NgxZendeskWebwidgetService: NgxZendeskWebwidgetService) { }

}
With Lazyload
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

  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

NgxZendeskWebwidgetService

Web Widget (Messenger)

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

Web widget (Classic)

  • zE('webWidget:<action>', '<event|property>', <parameters>): 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

v3.0.1

  • Fix documentation

v3.0.0

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

v2.1.1

  • Fix injectionTag in NgxZendeskWebwidgetConfig based on issue 30 by mps2209

v2.1.0

  • Include injectionTag in NgxZendeskWebwidgetConfig based on issue 30

V2.0.0

  • 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)

V1.0.1

  • Fix bugs

v1.0.0

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

v0.1.5

  • Support Angular 8

v0.1.4

  • Support Angular 6

v0.1.3

  • Support Angular 5

v0.1.2

  • Added custom settings

v0.1.1

  • Change documentation

v0.1.0

  • Added documentation
  • Initial version

Readme

Keywords

Package Sidebar

Install

npm i ngx-zendesk-webwidget

Weekly Downloads

3,660

Version

3.0.2

License

MIT

Unpacked Size

50.7 kB

Total Files

16

Last publish

Collaborators

  • alisonvilela