n-live-chat

Customer Services live chat component for FT.com

Usage

Installation

npm install -S @financial-times/n-live-chat

JSX Component

import LiveChat from '@financial-times/n-live-chat';

<LiveChat style='popup' salesforceConfig={configObject} />
<LiveChat style='inline' salesforceConfig={configObject} />

Migration from Handlebars

With other ongoing work to move away from n-ui / Handlebars - this component from v3 no longer has any handlebars partials. If you require the handlebars template, please use the v2 release.

However, you may be able to register a custom Handlebars helper if you're feeling more adventurous. Without any testing (caveat emptor) it could be something akin to:

const React = require('react')
const ReactDOMServer = require('react-dom/server')
module.exports = function({ hash }) {
  const component = require(hash.component)
  const props = { ...this, ...hash }
  return ReactDOMServer.renderToString(
    React.createElement(component, props)
  )
}

<div>{{{#jsx component="@financial-times/n-component-here" someprop="goeshere" }}}</div>

Salesforce configuration

const configObject = {
  deploymentId: "string",
  organisationId: "string",
  buttonReference: "string",
  host: "string"
};

Styles

@import "@financial-times/n-live-chat/main";

Popup component

@include nLiveChatPopup();

Inline component

@include nLiveChatInline();

Client-side initialisation

import { LiveChatPopup, LiveChatInline } from '@financial-times/n-live-chat';
// basic setup for popup component with no tracking
new LiveChatPopup().init();

// basic setup for inline component with no tracking
new LiveChatInline().init();

// specify one or more callbacks
// e.g. for custom tracking events
const callbacks = {
  online: () => {
    /* agent online, chat available */
  },
  offline: () => {
    /* agents offline, chat unavailable */
  },
  open: () => {
    /* user clicked button to open chat */
  },
  // popup mode:
  dismiss: () => {
    /* user clicked button to dismiss popup */
  }
};

const options = {
  // wait 10 seconds before initialising component
  // (defaults to 1 second)
  displayDelay: 10000
};

new LiveChatPopup().init(callbacks, options);

chatterBox Feature Flag

n-live-chat will connect to the latest Customer Care Live Chat app , when this feature flag is on. The apps consuming n-live-chat can enable this feature by passing in the flag state for chatterboxChat as an option to the init function call.

const options = {
  chatterBox: flags.get(chatterboxChat)
};

new LiveChatPopup().init(null, options);

Demos

make install .env demo

• Inline component demo(for the purpose of demo this uses the staging environment url)
• Popup component demo (for the purpose of demo this uses the prod environment url)