Skip to content

Fix cmd-click for auto events#78

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

Draft
adriaandotcom wants to merge 1 commit into
base:v12
Choose a base branch
from
Draft

Fix cmd-click for auto events #78

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions dist/latest/auto-events.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 25 additions & 16 deletions src/auto-events.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,13 +73,25 @@
if (typeof optionsLink === "undefined")
log("options object not found, please specify", "warn");

var saAutomatedLink = function saAutomatedLink(element, type) {
var saAutomatedLink = function saAutomatedLink(element, type, event) {
try {
if (!element) return log("no element found");
var sent = false;

var openNewTab =
(element.hasAttribute("target") &&
element.getAttribute("target") !== "_self") ||
(event &&
(event.metaKey ||
event.ctrlKey ||
event.shiftKey ||
event.altKey ||
event.button === 1));

if (event && !openNewTab && event.preventDefault) event.preventDefault();

var callback = function () {
if (!sent && !element.hasAttribute("target"))
if (!sent && !openNewTab && !element.hasAttribute("target"))
document.location = element.getAttribute("href");
sent = true;
};
Expand DownExpand Up@@ -134,15 +146,18 @@

log("collected " + clean);

return type === "email"
? callback()
: window.setTimeout(callback, 5000);
if (type === "email") callback();
else window.setTimeout(callback, 5000);

return openNewTab;
} else {
log(saGlobal + " is not defined", "warn");
return callback();
callback();
return openNewTab;
}
} catch (error) {
log(error.message, "warn");
return openNewTab;
}
};

Expand DownExpand Up@@ -179,18 +194,12 @@
if (!collect) return;

if (onclick) {
var onClickAttribute = "saAutomatedLink(this, '" + collect + "');";

if (
!link.hasAttribute("target") ||
link.getAttribute("target") === "_self"
)
onClickAttribute += " return false;";

var onClickAttribute =
"return saAutomatedLink(this, '" + collect + "', event);";
link.setAttribute("onclick", onClickAttribute);
} else {
link.addEventListener("click", function () {
saAutomatedLink(link, collect);
link.addEventListener("click", function (e) {
saAutomatedLink(link, collect, e);
});
}
}
Expand Down
45 changes: 45 additions & 0 deletions test/unit/auto-events-cmdclick.test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
const { expect } = require("chai");
const { JSDOM } = require("jsdom");
const { readFileSync } = require("fs");
const vm = require("vm");

describe("auto-events cmd-click", function () {
it("allows meta click without preventing default", function () {
const html =
'<!doctype html><html><body><a id="doc" href="https://docs.example.com/">Doc</a></body></html>';
const dom = new JSDOM(html, {
url: "https://simpleanalytics.com/",
runScripts: "outside-only",
pretendToBeVisual: true,
});
const context = dom.getInternalVMContext();
vm.runInContext(
"window.sa_event = function(){}; window.sa_event_loaded = true;",
context
);
const script = readFileSync("dist/latest/auto-events.js", "utf8");
vm.runInContext(script, context);
const link = dom.window.document.getElementById("doc");
const normalEvent = new dom.window.MouseEvent("click", {
bubbles: true,
cancelable: true,
});
const metaEvent = new dom.window.MouseEvent("click", {
bubbles: true,
cancelable: true,
metaKey: true,
});

const normalReturn = dom.window.saAutomatedLink(
link,
"outbound",
normalEvent
);
const metaReturn = dom.window.saAutomatedLink(link, "outbound", metaEvent);

expect(normalEvent.defaultPrevented).to.equal(true);
expect(metaEvent.defaultPrevented).to.equal(false);
expect(normalReturn).to.equal(false);
expect(metaReturn).to.equal(true);
});
});