npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nws18-wru-widget

v0.21.0

Published

WRU widget for recommendations for News18

Downloads

5

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

ayub-cbayub-cbkrishna-cbkrishna-cb

Keywords

Readme

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).