Skip to content

Feature: elements with marks #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
solcre wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Feature: elements with marks #92

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1906e50
feat(standardEventHandler): add reference to the element that is bein…
matiasfuster Aug 4, 2016
1e5cbdd
feat(checkElements): support percentage marks on elements
matiasfuster Aug 4, 2016
400999c
style(calculateMarks): improve parameter name as it refers to the ele…
matiasfuster Aug 4, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 39 additions & 24 deletions jquery.scrolldepth.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
pixelDepth: true,
nonInteraction: true,
gaGlobal: false,
gtmOverride: false
gtmOverride: false,
elementsWithMarks : false
};

var $window = $(window),
Expand Down Expand Up @@ -92,19 +93,17 @@
* Functions
*/

function sendEvent(action, label, scrollDistance, timing) {

function sendEvent(action, label, scrollDistance, timing, elem) {
if (standardEventHandler) {

standardEventHandler({'event': 'ScrollDistance', 'eventCategory': 'Scroll Depth', 'eventAction': action, 'eventLabel': label, 'eventValue': 1, 'eventNonInteraction': options.nonInteraction});

if (options.pixelDepth && arguments.length > 2 && scrollDistance > lastPixelDepth) {
standardEventHandler({'element' : elem, 'event': 'ScrollDistance', 'eventCategory': 'Scroll Depth', 'eventAction': action, 'eventLabel': label, 'eventValue': 1, 'eventNonInteraction': options.nonInteraction});
if (options.pixelDepth && arguments.length > 2 && scrollDistance >= lastPixelDepth) {
lastPixelDepth = scrollDistance;
standardEventHandler({'event': 'ScrollDistance', 'eventCategory': 'Scroll Depth', 'eventAction': 'Pixel Depth', 'eventLabel': rounded(scrollDistance), 'eventValue': 1, 'eventNonInteraction': options.nonInteraction});
standardEventHandler({'element' : elem, 'event': 'ScrollDistance', 'eventCategory': 'Scroll Depth', 'eventAction': 'Pixel Depth', 'eventLabel': rounded(scrollDistance), 'eventValue': 1, 'eventNonInteraction': options.nonInteraction});
}

if (options.userTiming && arguments.length > 3) {
standardEventHandler({'event': 'ScrollTiming', 'eventCategory': 'Scroll Depth', 'eventAction': action, 'eventLabel': label, 'eventTiming': timing});
standardEventHandler({'element' : elem, 'event': 'ScrollTiming', 'eventCategory': 'Scroll Depth', 'eventAction': action, 'eventLabel': label, 'eventTiming': timing});
}

} else {
Expand Down Expand Up @@ -143,34 +142,50 @@

}

function calculateMarks(docHeight) {
function calculateMarks(elemHeight) {
return {
'25%' : parseInt(docHeight * 0.25, 10),
'50%' : parseInt(docHeight * 0.50, 10),
'75%' : parseInt(docHeight * 0.75, 10),
'25%' : parseInt(elemHeight * 0.25, 10),
'50%' : parseInt(elemHeight * 0.50, 10),
'75%' : parseInt(elemHeight * 0.75, 10),
// Cushion to trigger 100% event in iOS
'100%': docHeight - 5
'100%': elemHeight - 5
};
}

function checkMarks(marks, scrollDistance, timing) {
function checkMarks(marks, scrollDistance, timing, element) {
var _cache = (element === document ? cache : element.cache);

// Check each active mark
$.each(marks, function(key, val) {
if ( $.inArray(key, cache) === -1 && scrollDistance >= val ) {
sendEvent('Percentage', key, scrollDistance, timing);
cache.push(key);
}
if ( $.inArray(key, _cache) === -1 && scrollDistance >= val ) {
sendEvent('Percentage', key, scrollDistance, timing, element);
_cache.push(key);
}
});
}

function checkElements(elements, scrollDistance, timing) {
$.each(elements, function(index, elem) {
if ( $.inArray(elem, cache) === -1 && $(elem).length ) {
if ( scrollDistance >= $(elem).offset().top ) {
sendEvent('Elements', elem, scrollDistance, timing);
cache.push(elem);
if ( $.inArray(elem, cache) === -1 && $(elem).length ) {
var top = $(elem).offset().top;
if (options.elementsWithMarks) {
if (elem.cache === undefined) {
elem.cache = [];
}
var height = $(elem).height();
var bottom = top + height;
var marks = calculateMarks(bottom);
checkMarks(marks, scrollDistance, timing, elem);

if (scrollDistance >= bottom) {
cache.push(elem);
}
}
else if ( scrollDistance >= top) {
sendEvent('Elements', elem, scrollDistance, timing, elem);
cache.push(elem);
}
}
}
});
}

Expand Down Expand Up @@ -308,7 +323,7 @@

// Check standard marks
if (options.percentage) {
checkMarks(marks, scrollDistance, timing);
checkMarks(marks, scrollDistance, timing, document);
}
}, 500));

Expand Down