SDK

Last updated 6 months ago

Beacon comes with a powerful SDK that can be used in your web page. The SDK is based on pure JavaScript and can be used to deeply integrate your web page with beacon window.

Beacon SDK is available once the beacon window is embedded correctly.

Get Started

To use the SDK, you must first create a reference to the beacon-app element on your page. This can be done using the standard reference functions, viz. getElementById(), getElementsByTagName(), etc. Given below, is a recommended way of referencing the element.

var beacon = document.getElementsByTagName('beacon-app')[0];

Once the beacon-app element is referenced, you can access the standard properties, along with custom properties that the SDK comes with.

A single page can have more than one beacon windows. Hence, the SDK does support handling multiple beacon instances.

Additional options in the SDK will be added as per the roadmap.

Video Tutorial

‚Äč