Skip to content
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

fix(swap): apply swap delay in swap function instead of handleAjaxResponse #2845

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

fix(swap): apply swap delay in swap function instead of handleAjaxResponse #2845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2e9b87
fix(swap): apply swap delay in swap function instead of handleAjaxRes…
boonedox Aug 23, 2024
5b46688
add swap delay test
boonedox Dec 27, 2024
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: 26 additions & 9 deletions src/htmx.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1796,6 +1796,30 @@ var htmx = (function() {
return oobElts.length > 0
}

/**
* Apply swapping class and then execute the swap with optional delay
* @param {string|Element} target
* @param {string} content
* @param {HtmxSwapSpecification} swapSpec
* @param {SwapOptions} [swapOptions]
*/
function swap(target, content, swapSpec, swapOptions) {
if (!swapOptions) {
swapOptions = {}
}

target = resolveTarget(target)
target.classList.add(htmx.config.swappingClass)
const localSwap = function() {
runSwap(target, content, swapSpec, swapOptions)
}
if (swapSpec?.swapDelay && swapSpec.swapDelay > 0) {
getWindow().setTimeout(localSwap, swapSpec.swapDelay)
} else {
localSwap()
}
}

/**
* Implements complete swapping pipeline, including: focus and selection preservation,
* title updates, scroll, OOB swapping, normal swapping and settling
Expand All @@ -1804,7 +1828,7 @@ var htmx = (function() {
* @param {HtmxSwapSpecification} swapSpec
* @param {SwapOptions} [swapOptions]
*/
function swap(target, content, swapSpec, swapOptions) {
function runSwap(target, content, swapSpec, swapOptions) {
if (!swapOptions) {
swapOptions = {}
}
Expand Down Expand Up @@ -4695,8 +4719,6 @@ var htmx = (function() {
swapSpec.ignoreTitle = ignoreTitle
}

target.classList.add(htmx.config.swappingClass)

// optional transition API promise callbacks
let settleResolve = null
let settleReject = null
Expand Down Expand Up @@ -4783,12 +4805,7 @@ var htmx = (function() {
})
}
}

if (swapSpec.swapDelay > 0) {
getWindow().setTimeout(doSwap, swapSpec.swapDelay)
} else {
doSwap()
}
doSwap()
}
if (isError) {
triggerErrorEvent(elt, 'htmx:responseError', mergeObjects({ error: 'Response Status Error Code ' + xhr.status + ' from ' + responseInfo.pathInfo.requestPath }, responseInfo))
Expand Down
11 changes: 11 additions & 0 deletions test/core/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,17 @@ describe('Core htmx API test', function() {
output.innerHTML.should.be.equal('<div>Swapped!</div>')
})

it('swap works with a swap delay', function(done) {
var div = make("<div hx-get='/test'></div>")
div.innerText.should.equal('')
htmx.swap(div, 'jsswapped', { swapDelay: 10 })
div.innerText.should.equal('')
setTimeout(function() {
div.innerText.should.equal('jsswapped')
done()
}, 30)
})

it('swaps content properly (with select)', function() {
var output = make('<output id="output"/>')
htmx.swap('#output', '<div><p id="select-me">Swapped!</p></div>', { swapStyle: 'innerHTML' }, { select: '#select-me' })
Expand Down