gather-integration

Gather Integration - LSJ V2.0

A JavaScript/TypeScript library for integrating Gather customer engagement widgets into web applications. This package provides popup forms, embedded interfaces, and targeting capabilities based on user behavior such as scroll position, mouse movement, session time, and visibility changes.

Features

• Popup & Embedded Interfaces – Display targeted popups and embedded forms based on configurable triggers
• Behavioral Targeting – Trigger interfaces based on scroll speed, mouse exit intent, session timeout, and tab visibility
• UTM & Referrer Tracking – Automatically capture and store UTM parameters, referrer data, and landing URLs via cookies
• Vue.js Integration – Load Vue-powered widget applications dynamically
• Partner Target Events – Process and respond to partner-defined target events

Usage

import GatherJS from 'gather-integration';

GatherJS({
  $: jQuery,
  interfacesJson: interfaces,
  accountJson: account,
  targetEventsJson: targetEvents,
  vueJS: 'path/to/vue.js',
  vueCSS: 'path/to/styles.css',
  widgetsDomain: 'https://widgets.example.com',
  consent: true
});

Development

# Install dependencies
yarn install

# Run tests
yarn test

# Build the library
yarn build

# Watch for changes
yarn watch

# Lint the code
yarn lint

Releasing

• Run yarn run release
• Push the changes with git push --follow-tags origin master
• Create a GitHub release with the tag that was pushed