htmx/test/attributes/hx-trigger.js
Carson Gross 8b9585f439 flip revealed to be a normal event
this fixes an ugly bug introduced when the trigger logic was pulled out, where the handler of the first revealed element was used over and over again for any future elements that also were revealed.  many braincells lost mmm.
2022-07-08 13:54:25 -06:00

753 lines
26 KiB
JavaScript

describe("hx-trigger attribute", function(){
beforeEach(function() {
this.server = sinon.fakeServer.create();
clearWorkArea();
});
afterEach(function() {
this.server.restore();
clearWorkArea();
});
it('non-default value works', function()
{
this.server.respondWith("GET", "/test", "Clicked!");
var form = make('<form hx-get="/test" hx-trigger="click">Click Me!</form>');
form.click();
form.innerHTML.should.equal("Click Me!");
this.server.respond();
form.innerHTML.should.equal("Clicked!");
});
it('changed modifier works', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var input = make('<input hx-trigger="click changed" hx-target="#d1" hx-get="/test" value="foo"/>');
var div = make('<div id="d1"></div>');
input.click();
this.server.respond();
div.innerHTML.should.equal("");
input.click();
this.server.respond();
div.innerHTML.should.equal("");
input.value = "bar";
input.click();
this.server.respond();
div.innerHTML.should.equal("Requests: 1");
input.click();
this.server.respond();
div.innerHTML.should.equal("Requests: 1");
});
it('once modifier works', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var input = make('<input hx-trigger="click once" hx-target="#d1" hx-get="/test" value="foo"/>');
var div = make('<div id="d1"></div>');
input.click();
this.server.respond();
div.innerHTML.should.equal("Requests: 1");
input.click();
this.server.respond();
div.innerHTML.should.equal("Requests: 1");
input.value = "bar";
input.click();
this.server.respond();
div.innerHTML.should.equal("Requests: 1");
input.click();
this.server.respond();
div.innerHTML.should.equal("Requests: 1");
});
it('once modifier works with multiple triggers', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var input = make('<input hx-trigger="click once, foo" hx-target="#d1" hx-get="/test" value="foo"/>');
var div = make('<div id="d1"></div>');
input.click();
this.server.respond();
div.innerHTML.should.equal("Requests: 1");
input.click();
this.server.respond();
div.innerHTML.should.equal("Requests: 1");
input.value = "bar";
input.click();
this.server.respond();
div.innerHTML.should.equal("Requests: 1");
input.click();
this.server.respond();
div.innerHTML.should.equal("Requests: 1");
htmx.trigger(input, "foo");
this.server.respond();
div.innerHTML.should.equal("Requests: 2");
});
it('polling works', function(complete)
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
if (requests > 5) {
complete();
// cancel polling with a
xhr.respond(286, {}, "Requests: " + requests);
} else {
xhr.respond(200, {}, "Requests: " + requests);
}
});
this.server.autoRespond = true;
this.server.autoRespondAfter = 0;
make('<div hx-trigger="every 10ms" hx-get="/test"/>');
});
it('non-default value works w/ data-* prefix', function()
{
this.server.respondWith("GET", "/test", "Clicked!");
var form = make('<form data-hx-get="/test" data-hx-trigger="click">Click Me!</form>');
form.click();
form.innerHTML.should.equal("Click Me!");
this.server.respond();
form.innerHTML.should.equal("Clicked!");
});
it('works with multiple events', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var div = make('<div hx-trigger="load,click" hx-get="/test">Requests: 0</div>');
div.innerHTML.should.equal("Requests: 0");
this.server.respond();
div.innerHTML.should.equal("Requests: 1");
div.click();
this.server.respond();
div.innerHTML.should.equal("Requests: 2");
});
it("parses spec strings", function()
{
var specExamples = {
"": [{trigger: 'click'}],
"every 1s": [{trigger: 'every', pollInterval: 1000}],
"click": [{trigger: 'click'}],
"customEvent": [{trigger: 'customEvent'}],
"event changed": [{trigger: 'event', changed: true}],
"event once": [{trigger: 'event', once: true}],
"event delay:1s": [{trigger: 'event', delay: 1000}],
"event throttle:1s": [{trigger: 'event', throttle: 1000}],
"event delay:1s, foo": [{trigger: 'event', delay: 1000}, {trigger: 'foo'}],
"event throttle:1s, foo": [{trigger: 'event', throttle: 1000}, {trigger: 'foo'}],
"event changed once delay:1s": [{trigger: 'event', changed: true, once: true, delay: 1000}],
"event1,event2": [{trigger: 'event1'}, {trigger: 'event2'}],
"event1, event2": [{trigger: 'event1'}, {trigger: 'event2'}],
"event1 once, event2 changed": [{trigger: 'event1', once: true}, {trigger: 'event2', changed: true}],
"event1,": [{trigger: 'event1'}],
" ": [{trigger: 'click'}],
}
for (var specString in specExamples) {
var div = make("<div hx-trigger='" + specString + "'></div>");
var spec = htmx._('getTriggerSpecs')(div);
spec.should.deep.equal(specExamples[specString], "Found : " + JSON.stringify(spec) + ", expected : " + JSON.stringify(specExamples[specString]) + " for spec: " + specString);
}
});
it('sets default trigger for forms', function()
{
var form = make('<form></form>');
var spec = htmx._('getTriggerSpecs')(form);
spec.should.deep.equal([{trigger: 'submit'}]);
})
it('sets default trigger for form elements', function()
{
var form = make('<input></input>');
var spec = htmx._('getTriggerSpecs')(form);
spec.should.deep.equal([{trigger: 'change'}]);
})
it('filters properly with false filter spec', function(){
this.server.respondWith("GET", "/test", "Called!");
var form = make('<form hx-get="/test" hx-trigger="evt[foo]">Not Called</form>');
form.click();
form.innerHTML.should.equal("Not Called");
var event = htmx._("makeEvent")('evt');
form.dispatchEvent(event);
this.server.respond();
form.innerHTML.should.equal("Not Called");
})
it('filters properly with true filter spec', function(){
this.server.respondWith("GET", "/test", "Called!");
var form = make('<form hx-get="/test" hx-trigger="evt[foo]">Not Called</form>');
form.click();
form.innerHTML.should.equal("Not Called");
var event = htmx._("makeEvent")('evt');
event.foo = true;
form.dispatchEvent(event);
this.server.respond();
form.innerHTML.should.equal("Called!");
})
it('filters properly compound filter spec', function(){
this.server.respondWith("GET", "/test", "Called!");
var div = make('<div hx-get="/test" hx-trigger="evt[foo&&bar]">Not Called</div>');
var event = htmx._("makeEvent")('evt');
event.foo = true;
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Not Called");
event.bar = true;
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Called!");
})
it('can refer to target element in condition', function(){
this.server.respondWith("GET", "/test", "Called!");
var div = make('<div hx-get="/test" hx-trigger="evt[target.classList.contains(\'doIt\')]">Not Called</div>');
var event = htmx._("makeEvent")('evt');
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Not Called");
div.classList.add("doIt");
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Called!");
})
it('can refer to target element in condition w/ equality', function(){
this.server.respondWith("GET", "/test", "Called!");
var div = make('<div hx-get="/test" hx-trigger="evt[target.id==\'foo\']">Not Called</div>');
var event = htmx._("makeEvent")('evt');
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Not Called");
div.id = "foo";
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Called!");
})
it('negative condition', function(){
this.server.respondWith("GET", "/test", "Called!");
var div = make('<div hx-get="/test" hx-trigger="evt[!target.classList.contains(\'disabled\')]">Not Called</div>');
div.classList.add("disabled");
var event = htmx._("makeEvent")('evt');
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Not Called");
div.classList.remove("disabled");
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Called!");
})
it('global function call works', function(){
window.globalFun = function(evt) {
return evt.bar;
}
try {
this.server.respondWith("GET", "/test", "Called!");
var div = make('<div hx-get="/test" hx-trigger="evt[globalFun(event)]">Not Called</div>');
var event = htmx._("makeEvent")('evt');
event.bar = false;
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Not Called");
event.bar = true;
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Called!");
} finally {
delete window.globalFun;
}
})
it('global property event filter works', function(){
window.foo = {
bar:false
}
try {
this.server.respondWith("GET", "/test", "Called!");
var div = make('<div hx-get="/test" hx-trigger="evt[foo.bar]">Not Called</div>');
var event = htmx._("makeEvent")('evt');
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Not Called");
foo.bar = true;
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Called!");
} finally {
delete window.foo;
}
})
it('global variable filter works', function(){
try {
this.server.respondWith("GET", "/test", "Called!");
var div = make('<div hx-get="/test" hx-trigger="evt[foo]">Not Called</div>');
var event = htmx._("makeEvent")('evt');
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Not Called");
foo = true;
div.dispatchEvent(event);
this.server.respond();
div.innerHTML.should.equal("Called!");
} finally {
delete window.foo;
}
})
it('can filter polling', function(complete){
this.server.respondWith("GET", "/test", "Called!");
window.foo = false;
var div = make('<div hx-get="/test" hx-trigger="every 5ms[foo]">Not Called</div>');
var div2 = make('<div hx-get="/test" hx-trigger="every 5ms">Not Called</div>');
this.server.autoRespond = true;
this.server.autoRespondAfter = 0;
setTimeout(function () {
div.innerHTML.should.equal("Not Called");
div2.innerHTML.should.equal("Called!");
delete window.foo;
complete();
}, 100);
})
it('bad condition issues error', function(){
this.server.respondWith("GET", "/test", "Called!");
var div = make('<div hx-get="/test" hx-trigger="evt[a.b]">Not Called</div>');
var errorEvent = null;
var handler = htmx.on("htmx:eventFilter:error", function (event) {
errorEvent = event;
});
try {
var event = htmx._("makeEvent")('evt');
div.dispatchEvent(event);
should.not.equal(null, errorEvent);
should.not.equal(null, errorEvent.detail.source);
console.log(errorEvent.detail.source);
} finally {
htmx.off("htmx:eventFilter:error", handler);
}
})
it('from clause works', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var div2 = make('<div id="d2"></div>');
var div1 = make('<div hx-trigger="click from:#d2" hx-get="/test">Requests: 0</div>');
div1.innerHTML.should.equal("Requests: 0");
div1.click();
this.server.respond();
div1.innerHTML.should.equal("Requests: 0");
div2.click();
this.server.respond();
div1.innerHTML.should.equal("Requests: 1");
});
it('from clause works with body selector', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var div1 = make('<div hx-trigger="click from:body" hx-get="/test">Requests: 0</div>');
div1.innerHTML.should.equal("Requests: 0");
document.body.click();
this.server.respond();
div1.innerHTML.should.equal("Requests: 1");
});
it('from clause works with document selector', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var div1 = make('<div hx-trigger="foo from:document" hx-get="/test">Requests: 0</div>');
div1.innerHTML.should.equal("Requests: 0");
htmx.trigger(document, 'foo');
this.server.respond();
div1.innerHTML.should.equal("Requests: 1");
});
it('from clause works with window selector', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var div1 = make('<div hx-trigger="foo from:window" hx-get="/test">Requests: 0</div>');
div1.innerHTML.should.equal("Requests: 0");
htmx.trigger(window, 'foo');
this.server.respond();
div1.innerHTML.should.equal("Requests: 1");
});
it('from clause works with closest clause', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var div1 = make('<div><a id="a1" hx-trigger="click from:closest div" hx-get="/test">Requests: 0</a></div>');
var a1 = byId('a1');
a1.innerHTML.should.equal("Requests: 0");
div1.click();
this.server.respond();
a1.innerHTML.should.equal("Requests: 1");
});
it('from clause works with find clause', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var div1 = make('<div hx-trigger="click from:find a" hx-target="#a1" hx-get="/test"><a id="a1">Requests: 0</a></div>');
var a1 = byId('a1');
a1.innerHTML.should.equal("Requests: 0");
a1.click();
this.server.respond();
a1.innerHTML.should.equal("Requests: 1");
});
it('event listeners on other elements are removed when an element is swapped out', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
this.server.respondWith("GET", "/test2", "Clicked");
var div1 = make('<div hx-get="/test2">' +
'<div id="d2" hx-trigger="click from:body" hx-get="/test">Requests: 0</div>' +
'</div>');
var div2 = byId("d2");
div2.innerHTML.should.equal("Requests: 0");
document.body.click();
this.server.respond();
requests.should.equal(1);
requests.should.equal(1);
div1.click();
this.server.respond();
div1.innerHTML.should.equal("Clicked");
requests.should.equal(2);
document.body.click();
this.server.respond();
requests.should.equal(2);
});
it('multiple triggers with from clauses mixed in work', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var div2 = make('<div id="d2"></div>');
var div1 = make('<div hx-trigger="click from:#d2, click" hx-get="/test">Requests: 0</div>');
div1.innerHTML.should.equal("Requests: 0");
div1.click();
this.server.respond();
div1.innerHTML.should.equal("Requests: 1");
div2.click();
this.server.respond();
div1.innerHTML.should.equal("Requests: 2");
});
it('event listeners can filter on target', function()
{
var requests = 0;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
var div1 = make('<div>' +
'<div id="d1" hx-trigger="click from:body target:#d3" hx-get="/test">Requests: 0</div>' +
'<div id="d2"></div>' +
'<div id="d3"></div>' +
'</div>');
var div1 = byId("d1");
var div2 = byId("d2");
var div3 = byId("d3");
div1.innerHTML.should.equal("Requests: 0");
document.body.click();
this.server.respond();
requests.should.equal(0);
div1.click();
this.server.respond();
requests.should.equal(0);
div2.click();
this.server.respond();
requests.should.equal(0);
div3.click();
this.server.respond();
requests.should.equal(1);
});
it('consume prevents event propogation', function()
{
this.server.respondWith("GET", "/foo", "foo");
this.server.respondWith("GET", "/bar", "bar");
var div = make("<div hx-trigger='click' hx-get='/foo'>" +
" <div id='d1' hx-trigger='click consume' hx-get='/bar'></div>" +
"</div>");
byId("d1").click();
this.server.respond();
// should not have been replaced by click
byId("d1").parentElement.should.equal(div);
byId("d1").innerText.should.equal("bar");
});
it('throttle prevents multiple requests from happening', function(done)
{
var requests = 0;
var server = this.server;
server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
server.respondWith("GET", "/bar", "bar");
var div = make("<div hx-trigger='click throttle:10ms' hx-get='/test'></div>");
div.click();
server.respond();
div.click();
server.respond();
div.click();
server.respond();
div.click();
server.respond();
// should not have been replaced by click
div.innerText.should.equal("Requests: 1");
setTimeout(function () {
div.click();
server.respond();
div.innerText.should.equal("Requests: 2");
div.click();
server.respond();
div.innerText.should.equal("Requests: 2");
done();
}, 50);
});
it('delay delays the request', function(done)
{
var requests = 0;
var server = this.server;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
this.server.respondWith("GET", "/bar", "bar");
var div = make("<div hx-trigger='click delay:10ms' hx-get='/test'></div>");
div.click();
this.server.respond();
div.click();
this.server.respond();
div.click();
this.server.respond();
div.click();
this.server.respond();
div.innerText.should.equal("");
setTimeout(function () {
server.respond();
div.innerText.should.equal("Requests: 1");
div.click();
server.respond();
div.innerText.should.equal("Requests: 1");
done();
}, 50);
});
it('requests are queued with last one winning by default', function()
{
var requests = 0;
var server = this.server;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
this.server.respondWith("GET", "/bar", "bar");
var div = make("<div hx-trigger='click' hx-get='/test'></div>");
div.click();
div.click();
div.click();
this.server.respond();
div.innerText.should.equal("Requests: 1");
this.server.respond();
div.innerText.should.equal("Requests: 2");
this.server.respond();
div.innerText.should.equal("Requests: 2");
});
it('queue:all queues all requests', function()
{
var requests = 0;
var server = this.server;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
this.server.respondWith("GET", "/bar", "bar");
var div = make("<div hx-trigger='click queue:all' hx-get='/test'></div>");
div.click();
div.click();
div.click();
this.server.respond();
div.innerText.should.equal("Requests: 1");
this.server.respond();
div.innerText.should.equal("Requests: 2");
this.server.respond();
div.innerText.should.equal("Requests: 3");
});
it('queue:first queues first request', function()
{
var requests = 0;
var server = this.server;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
this.server.respondWith("GET", "/bar", "bar");
var div = make("<div hx-trigger='click queue:first' hx-get='/test'></div>");
div.click();
div.click();
div.click();
this.server.respond();
div.innerText.should.equal("Requests: 1");
this.server.respond();
div.innerText.should.equal("Requests: 2");
this.server.respond();
div.innerText.should.equal("Requests: 2");
});
it('queue:none queues no requests', function()
{
var requests = 0;
var server = this.server;
this.server.respondWith("GET", "/test", function (xhr) {
requests++;
xhr.respond(200, {}, "Requests: " + requests);
});
this.server.respondWith("GET", "/bar", "bar");
var div = make("<div hx-trigger='click queue:none' hx-get='/test'></div>");
div.click();
div.click();
div.click();
this.server.respond();
div.innerText.should.equal("Requests: 1");
this.server.respond();
div.innerText.should.equal("Requests: 1");
this.server.respond();
div.innerText.should.equal("Requests: 1");
});
it('load event works w/ positive filters', function()
{
this.server.respondWith("GET", "/test", "Loaded!");
var div = make('<div hx-get="/test" hx-trigger="load[true]">Load Me!</div>');
div.innerHTML.should.equal("Load Me!");
this.server.respond();
div.innerHTML.should.equal("Loaded!");
});
it('load event works w/ negative filters', function()
{
this.server.respondWith("GET", "/test", "Loaded!");
var div = make('<div hx-get="/test" hx-trigger="load[false]">Load Me!</div>');
div.innerHTML.should.equal("Load Me!");
this.server.respond();
div.innerHTML.should.equal("Load Me!");
});
it('reveal event works on two elements', function()
{
this.server.respondWith("GET", "/test1", "test 1");
this.server.respondWith("GET", "/test2", "test 2");
var div = make('<div hx-get="/test1" hx-trigger="revealed"></div>');
var div2 = make('<div hx-get="/test2" hx-trigger="revealed"></div>');
div.innerHTML.should.equal("");
div2.innerHTML.should.equal("");
htmx.trigger(div, 'revealed')
htmx.trigger(div2, 'revealed')
this.server.respondAll();
div.innerHTML.should.equal("test 1");
div2.innerHTML.should.equal("test 2");
});
})