Codey

Appearance

Installation ​

This NPM package provides an easier way to integrate with Hello Customer.

Installation when using Vue or Angular ​

This is the recommended approach for single page applications within Xerius. The installation is done by running following command:

bash
npm i @xerius/codey-hello-customer

The setup can be done by using following snippet in the main file (ex. main.ts):

javascript
import { setupHelloCustomerModalSurvey } from "@xerius/codey-hello-customer";

// tenant and touchPointId can be found in the Hello Customer portal
setupHelloCustomerModalSurvey({
  tenantId: "",
  touchPointId: "",
  language: "NL",
  isPreview: true,
});

TIP

The process to retrieve the tenantId and touchPointId is described on the wiki page here

The Codey styling for the hello customer modal should be included as well. The path to the CSS file can be found on location:

bash
@xerius/codey-hello-customer/dist/hello-customer.min.css

Installation when using no framework ​

This is recommended when your application does not have access to NPM or a bundling setup. The installation is done by including following scripts:

bash
<script type="text/javascript" src="https://unpkg.com/@hello-customer/website-touchpoint"></script>
<script type="text/javascript" src="https://cdn.xerius.be/hello-customer/x.x.x/hello-customer.umd.js"></script>
<link rel="stylesheet" href="https://cdn.xerius.be/hello-customer/x.x.x/hello-customer.min.css"/>

The configuration of the module can be done by including following code:

TIP

The process to retrieve the tenantId and touchPointId is described on the wiki page here

javascript
// configure that the script approach is to be used
window.hellocustomer.setIsScript(true);

// tenant and touchPointId can be found in the Hello Customer portal
window.hellocustomer.setupHelloCustomerModalSurvey({
  tenantId: "",
  touchPointId: "",
  language: "NL",
  isPreview: true,
});