Skip to content

feature: Allow extra properties per tracking handler #84

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feature: Allow extra properties per tracking handler #84

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 21 additions & 14 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,14 +275,21 @@ function cleanObject(obj) {
return obj;
}

function eventProperties() {
return cleanObject({
tag: this.tagName.toLowerCase(),
id: presence(this.id),
"class": presence(this.className),
page: page(),
section: getClosest(this, "data-section")
});
function defaultExtraEventProperties(element, event) {
return {};
}

function eventProperties(element, event, extraEventProperties=defaultExtraEventProperties) {
return cleanObject(Object.assign(
{
tag: element.tagName.toLowerCase(),
id: presence(element.id),
"class": presence(element.className),
page: page(),
section: getClosest(element, "data-section")
},
extraEventProperties.call(this, element, event),
));
}

function getClosest(element, attribute) {
Expand Down Expand Up @@ -439,35 +446,35 @@ ahoy.trackView = function (additionalProperties) {
ahoy.track("$view", properties);
};

ahoy.trackClicks = function (selector) {
ahoy.trackClicks = function (selector, extraEventProperties) {
if (selector === undefined) {
throw new Error("Missing selector");
}
onEvent("click", selector, function (e) {
const properties = eventProperties.call(this, e);
const properties = eventProperties(this, e, extraEventProperties);
properties.text = properties.tag === "input" ? this.value : (this.textContent || this.innerText || this.innerHTML).replace(/[\s\r\n]+/g, " ").trim();
properties.href = this.href;
ahoy.track("$click", properties);
});
};

ahoy.trackSubmits = function (selector) {
ahoy.trackSubmits = function (selector, extraEventProperties) {
if (selector === undefined) {
throw new Error("Missing selector");
}
onEvent("submit", selector, function (e) {
const properties = eventProperties.call(this, e);
const properties = eventProperties(this, e, extraEventProperties);
ahoy.track("$submit", properties);
});
};

ahoy.trackChanges = function (selector) {
ahoy.trackChanges = function (selector, extraEventProperties) {
log("trackChanges is deprecated and will be removed in 0.5.0");
if (selector === undefined) {
throw new Error("Missing selector");
}
onEvent("change", selector, function (e) {
const properties = eventProperties.call(this, e);
const properties = eventProperties(this, e, extraEventProperties);
ahoy.track("$change", properties);
});
};
Expand Down