oath-viewability

Oath viewability detection plugin

Screwdriver Pipeline

https://screwdriver.ouroath.com/pipelines/1008183/events

Install

npm install --save oath-viewability

Usage

ECMA6+ style

import oathViewabilityLoader from 'oath-viewability'

const someDOMElement = document.getElementById('my-element')
oathViewabilityLoader.then((oathViewability) => {
    const elementViewability = new oathViewability(someDOMElement)
    elementViewability.then((detector) => {
        detector.getPercent() // {0-100}
        detector.getVisible() // {0|1}
    })    
})

Common JS Style

Embed the script from ./node_modules/oath-viewability/dist/clj.js

(function(window) {
    var someDOMElement = document.getElementById('my-element');
    
    window.oath.viewability.then(function(oathViewability) {
        var elementViewability = new oathViewability(someDOMElement)
        elementViewability.then(function(detector) {
            detector.getPercent(); // {0-100}
            detector.getVisible(); // {0|1}
        })  
    });
})(window);

Local usage

You can use npm start if you want to check demopage on http://localhost:8080/demo/