Nws18-wru-widget NPM

nws18-wru-widget (0.21.0)

1. Steps to install the widget in your app:

Go to your project directory in terminal.
Run the following command :

npm i nws18-wru-widget

2. Steps to use the widget:

Before using the widget, there is a mandatory step that has to be followed each time the user opens an article on News18 website i.e. invoke storyViewEvent function from the package which makes an API call to WRU's backend along with the article and the user information so that it can be used for predictive analysis and we can provide the user related articles based on their engagement on your platform. Make sure that invoking the storyViewEvent function must happen as soon as the article page is opened.
Import the storyViewEvent function using the following piece of code :

import { storyViewEvent } from 'nws18-wru-widget';

Call the storyViewEvent function with all the arguments mentioned below.

JavaScript:

storyViewEvent({
  articleId: 'xxx-article-id-xxx', // required
  eid: 'xxx-eid-xxx', // optional
  ref: 'xxx-ref-xxx', // optional
  ip: 'xxx-ip-xxx', // optional
  platform: 'xxx-platform-xxx', // required // mobile or web
});

Go to the file where the widget is required.
Import the widget using the following piece of code :

import { renderWruWidget } from 'nws18-wru-widget';

Call the renderWruWidget function with all the arguments mentioned below.

JavaScript:

renderWruWidget({
  widgetId: 'nws18-wru-widget-recommended-for-you-js', // required
  articleId: 'xxx-article-id-xxx', // required
  gaTrackingId: 'xxx-ga-tracking-id-xxx', // required
  deviceType: 'xxx-device-type-xxx', // required // mobile or desktop
});

HTML:

<body>
  <div id="nws18-wru-widget-recommended-for-you-js"></div>
</body>

3. Description:

articleId: The article Id for which you need recommendation.
platform: It's user's platform type who is browsing the content.
widgetId: It's the div element id where the widget is to be appended.
gaTrackingId: The google analytics tracking Id.
deviceType: It's user's device type who is browsing the content.

Note: The widget will append only once for the specified div element id (in this example, "nws18-wru-widget-recommended-for-you-js") in a single page. If two or more widgets are required in a single page, different unique id has to be provided for each widget (for example, "nws18-wru-widget-recommended-for-you-js", "nws18-wru-widget-recommended-for-you-js--1" and so on).