vissense / vissense-percentage-time-test

A VisSense.js plugin for testing percentages over time.

VisSense.js: Percentage Time Test

A VisSense.js plugin for testing percentages over time.

Examples

Invoke a callback if an element has been visible at least 50% for 1 second:

var element = $('#myElement'); 
var visibility = VisSense(element[0]);

visibility.onPercentageTimeTestPassed(function() {
    console.log('element passed test for 50% visibility over 1 second.');
}, {
  percentageLimit: 0.5,
  timeLimit: 1000,
  interval: 100
});

// this is an alias for the above call as it is an IAB standard
visibility.on50_1TestPassed(function() {
    console.log('element passed test for 50% visibility over 1 second.');
});

Invoke a callback if an element has been visible at least 60% for 5 seconds:

var video = $('#video'); 
var visibility = VisSense(video[0]);
visibility.onPercentageTimeTestPassed(function() {
    console.log('element passed test for 60% visibility over 5 seconds.');
}, {
  percentageLimit: 0.6,
  timeLimit: 5000,
  interval: 200
});

Contribute

• Issue Tracker: https://github.com/vissense/vissense-percentage-time-test/issues
• Source Code: https://github.com/vissense/vissense-percentage-time-test

License

The project is licensed under the MIT license. See LICENSE for details.