intercom

Utils for integrating Intercom into web applications.

Use

To use Intercom in a React application, use the provided useIntercom hook in some app root component to load and initialize Intercom. Provide settings containing user identification if/when inside a sign-in barrier.

import { useIntercom } from '@wisersolutions/intercom'

export const AppRoot = ({ intercomId: appId, ...props }) => {
  useIntercom(appId)
  // or
  // useIntercom(appId, { user_id: '12345', email: '[email protected]', name: 'John Doe', created_at: 1575205778963 })
  
  // … (render the app)
}

To integrate Intercom into an app that's not using React, import just the loader code and load it.

import { loadIntercom, startIntercom } from '@wisersolutions/intercom/lib/intercom'

loadIntercom(appId).then(() => startIntercom(appId, { /* settings or user identity if needed */ }))

Development

Install

Install dependencies using:

npm install

Develop

After you modify sources, run the following (or set up your IDE to do it for you):

• format the code using npm run format
• lint it using npm run lint

and fix the errors, if there are any.

Publish

Publishing is done in two steps:

1. Create a new version tag and push it to the repository:

   npm version <patch|minor|major>
   git push --follow-tags

2. Build and publish the new version as a npm package:

   npm publish --access public