-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
htmx.js
5084 lines (4728 loc) · 154 KB
/
htmx.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
var htmx = (function() {
'use strict'
// Public API
const htmx = {
// Tsc madness here, assigning the functions directly results in an invalid TypeScript output, but reassigning is fine
/* Event processing */
/** @type {typeof onLoadHelper} */
onLoad: null,
/** @type {typeof processNode} */
process: null,
/** @type {typeof addEventListenerImpl} */
on: null,
/** @type {typeof removeEventListenerImpl} */
off: null,
/** @type {typeof triggerEvent} */
trigger: null,
/** @type {typeof ajaxHelper} */
ajax: null,
/* DOM querying helpers */
/** @type {typeof find} */
find: null,
/** @type {typeof findAll} */
findAll: null,
/** @type {typeof closest} */
closest: null,
/**
* Returns the input values that would resolve for a given element via the htmx value resolution mechanism
*
* @see https://htmx.org/api/#values
*
* @param {Element} elt the element to resolve values on
* @param {HttpVerb} type the request type (e.g. **get** or **post**) non-GET's will include the enclosing form of the element. Defaults to **post**
* @returns {Object}
*/
values: function(elt, type) {
const inputValues = getInputValues(elt, type || 'post')
return inputValues.values
},
/* DOM manipulation helpers */
/** @type {typeof removeElement} */
remove: null,
/** @type {typeof addClassToElement} */
addClass: null,
/** @type {typeof removeClassFromElement} */
removeClass: null,
/** @type {typeof toggleClassOnElement} */
toggleClass: null,
/** @type {typeof takeClassForElement} */
takeClass: null,
/** @type {typeof swap} */
swap: null,
/* Extension entrypoints */
/** @type {typeof defineExtension} */
defineExtension: null,
/** @type {typeof removeExtension} */
removeExtension: null,
/* Debugging */
/** @type {typeof logAll} */
logAll: null,
/** @type {typeof logNone} */
logNone: null,
/* Debugging */
/**
* The logger htmx uses to log with
*
* @see https://htmx.org/api/#logger
*/
logger: null,
/**
* A property holding the configuration htmx uses at runtime.
*
* Note that using a [meta tag](https://htmx.org/docs/#config) is the preferred mechanism for setting these properties.
*
* @see https://htmx.org/api/#config
*/
config: {
/**
* Whether to use history.
* @type boolean
* @default true
*/
historyEnabled: true,
/**
* The number of pages to keep in **localStorage** for history support.
* @type number
* @default 10
*/
historyCacheSize: 10,
/**
* @type boolean
* @default false
*/
refreshOnHistoryMiss: false,
/**
* The default swap style to use if **[hx-swap](https://htmx.org/attributes/hx-swap)** is omitted.
* @type HtmxSwapStyle
* @default 'innerHTML'
*/
defaultSwapStyle: 'innerHTML',
/**
* The default delay between receiving a response from the server and doing the swap.
* @type number
* @default 0
*/
defaultSwapDelay: 0,
/**
* The default delay between completing the content swap and settling attributes.
* @type number
* @default 20
*/
defaultSettleDelay: 20,
/**
* If true, htmx will inject a small amount of CSS into the page to make indicators invisible unless the **htmx-indicator** class is present.
* @type boolean
* @default true
*/
includeIndicatorStyles: true,
/**
* The class to place on indicators when a request is in flight.
* @type string
* @default 'htmx-indicator'
*/
indicatorClass: 'htmx-indicator',
/**
* The class to place on triggering elements when a request is in flight.
* @type string
* @default 'htmx-request'
*/
requestClass: 'htmx-request',
/**
* The class to temporarily place on elements that htmx has added to the DOM.
* @type string
* @default 'htmx-added'
*/
addedClass: 'htmx-added',
/**
* The class to place on target elements when htmx is in the settling phase.
* @type string
* @default 'htmx-settling'
*/
settlingClass: 'htmx-settling',
/**
* The class to place on target elements when htmx is in the swapping phase.
* @type string
* @default 'htmx-swapping'
*/
swappingClass: 'htmx-swapping',
/**
* Allows the use of eval-like functionality in htmx, to enable **hx-vars**, trigger conditions & script tag evaluation. Can be set to **false** for CSP compatibility.
* @type boolean
* @default true
*/
allowEval: true,
/**
* If set to false, disables the interpretation of script tags.
* @type boolean
* @default true
*/
allowScriptTags: true,
/**
* If set, the nonce will be added to inline scripts.
* @type string
* @default ''
*/
inlineScriptNonce: '',
/**
* The attributes to settle during the settling phase.
* @type string[]
* @default ['class', 'style', 'width', 'height']
*/
attributesToSettle: ['class', 'style', 'width', 'height'],
/**
* Allow cross-site Access-Control requests using credentials such as cookies, authorization headers or TLS client certificates.
* @type boolean
* @default false
*/
withCredentials: false,
/**
* @type number
* @default 0
*/
timeout: 0,
/**
* The default implementation of **getWebSocketReconnectDelay** for reconnecting after unexpected connection loss by the event code **Abnormal Closure**, **Service Restart** or **Try Again Later**.
* @type {'full-jitter' | ((retryCount:number) => number)}
* @default "full-jitter"
*/
wsReconnectDelay: 'full-jitter',
/**
* The type of binary data being received over the WebSocket connection
* @type BinaryType
* @default 'blob'
*/
wsBinaryType: 'blob',
/**
* @type string
* @default '[hx-disable], [data-hx-disable]'
*/
disableSelector: '[hx-disable], [data-hx-disable]',
/**
* @type {'auto' | 'instant' | 'smooth'}
* @default 'smooth'
*/
scrollBehavior: 'instant',
/**
* If the focused element should be scrolled into view.
* @type boolean
* @default false
*/
defaultFocusScroll: false,
/**
* If set to true htmx will include a cache-busting parameter in GET requests to avoid caching partial responses by the browser
* @type boolean
* @default false
*/
getCacheBusterParam: false,
/**
* If set to true, htmx will use the View Transition API when swapping in new content.
* @type boolean
* @default false
*/
globalViewTransitions: false,
/**
* htmx will format requests with these methods by encoding their parameters in the URL, not the request body
* @type {(HttpVerb)[]}
* @default ['get', 'delete']
*/
methodsThatUseUrlParams: ['get', 'delete'],
/**
* If set to true, disables htmx-based requests to non-origin hosts.
* @type boolean
* @default false
*/
selfRequestsOnly: true,
/**
* If set to true htmx will not update the title of the document when a title tag is found in new content
* @type boolean
* @default false
*/
ignoreTitle: false,
/**
* Whether the target of a boosted element is scrolled into the viewport.
* @type boolean
* @default true
*/
scrollIntoViewOnBoost: true,
/**
* The cache to store evaluated trigger specifications into.
* You may define a simple object to use a never-clearing cache, or implement your own system using a [proxy object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Proxy)
* @type {Object|null}
* @default null
*/
triggerSpecsCache: null,
/** @type boolean */
disableInheritance: false,
/** @type HtmxResponseHandlingConfig[] */
responseHandling: [
{ code: '204', swap: false },
{ code: '[23]..', swap: true },
{ code: '[45]..', swap: false, error: true }
],
/**
* Whether to process OOB swaps on elements that are nested within the main response element.
* @type boolean
* @default true
*/
allowNestedOobSwaps: true
},
/** @type {typeof parseInterval} */
parseInterval: null,
/** @type {typeof internalEval} */
_: null,
version: '2.0a'
}
// Tsc madness part 2
htmx.onLoad = onLoadHelper
htmx.process = processNode
htmx.on = addEventListenerImpl
htmx.off = removeEventListenerImpl
htmx.trigger = triggerEvent
htmx.ajax = ajaxHelper
htmx.find = find
htmx.findAll = findAll
htmx.closest = closest
htmx.remove = removeElement
htmx.addClass = addClassToElement
htmx.removeClass = removeClassFromElement
htmx.toggleClass = toggleClassOnElement
htmx.takeClass = takeClassForElement
htmx.swap = swap
htmx.defineExtension = defineExtension
htmx.removeExtension = removeExtension
htmx.logAll = logAll
htmx.logNone = logNone
htmx.parseInterval = parseInterval
htmx._ = internalEval
const internalAPI = {
addTriggerHandler,
bodyContains,
canAccessLocalStorage,
findThisElement,
filterValues,
swap,
hasAttribute,
getAttributeValue,
getClosestAttributeValue,
getClosestMatch,
getExpressionVars,
getHeaders,
getInputValues,
getInternalData,
getSwapSpecification,
getTriggerSpecs,
getTarget,
makeFragment,
mergeObjects,
makeSettleInfo,
oobSwap,
querySelectorExt,
settleImmediately,
shouldCancel,
triggerEvent,
triggerErrorEvent,
withExtensions
}
const VERBS = ['get', 'post', 'put', 'delete', 'patch']
const VERB_SELECTOR = VERBS.map(function(verb) {
return '[hx-' + verb + '], [data-hx-' + verb + ']'
}).join(', ')
const HEAD_TAG_REGEX = makeTagRegEx('head')
//= ===================================================================
// Utilities
//= ===================================================================
/**
* @param {string} tag
* @param {boolean} global
* @returns {RegExp}
*/
function makeTagRegEx(tag, global = false) {
return new RegExp(`<${tag}(\\s[^>]*>|>)([\\s\\S]*?)<\\/${tag}>`,
global ? 'gim' : 'im')
}
/**
* Parses an interval string consistent with the way htmx does. Useful for plugins that have timing-related attributes.
*
* Caution: Accepts an int followed by either **s** or **ms**. All other values use **parseFloat**
*
* @see https://htmx.org/api/#parseInterval
*
* @param {string} str timing string
* @returns {number|undefined}
*/
function parseInterval(str) {
if (str == undefined) {
return undefined
}
let interval = NaN
if (str.slice(-2) == 'ms') {
interval = parseFloat(str.slice(0, -2))
} else if (str.slice(-1) == 's') {
interval = parseFloat(str.slice(0, -1)) * 1000
} else if (str.slice(-1) == 'm') {
interval = parseFloat(str.slice(0, -1)) * 1000 * 60
} else {
interval = parseFloat(str)
}
return isNaN(interval) ? undefined : interval
}
/**
* @param {Node} elt
* @param {string} name
* @returns {(string | null)}
*/
function getRawAttribute(elt, name) {
return elt instanceof Element && elt.getAttribute(name)
}
/**
* @param {Element} elt
* @param {string} qualifiedName
* @returns {boolean}
*/
// resolve with both hx and data-hx prefixes
function hasAttribute(elt, qualifiedName) {
return !!elt.hasAttribute && (elt.hasAttribute(qualifiedName) ||
elt.hasAttribute('data-' + qualifiedName))
}
/**
*
* @param {Node} elt
* @param {string} qualifiedName
* @returns {(string | null)}
*/
function getAttributeValue(elt, qualifiedName) {
return getRawAttribute(elt, qualifiedName) || getRawAttribute(elt, 'data-' + qualifiedName)
}
/**
* @param {Node} elt
* @returns {Node | null}
*/
function parentElt(elt) {
const parent = elt.parentElement
if (!parent && elt.parentNode instanceof ShadowRoot) return elt.parentNode
return parent
}
/**
* @returns {Document}
*/
function getDocument() {
return document
}
/**
* @param {Node} elt
* @param {boolean} global
* @returns {Node|Document}
*/
function getRootNode(elt, global) {
return elt.getRootNode ? elt.getRootNode({ composed: global }) : getDocument()
}
/**
* @param {Node} elt
* @param {(e:Node) => boolean} condition
* @returns {Node | null}
*/
function getClosestMatch(elt, condition) {
while (elt && !condition(elt)) {
elt = parentElt(elt)
}
return elt || null
}
/**
* @param {Element} initialElement
* @param {Element} ancestor
* @param {string} attributeName
* @returns {string|null}
*/
function getAttributeValueWithDisinheritance(initialElement, ancestor, attributeName) {
const attributeValue = getAttributeValue(ancestor, attributeName)
const disinherit = getAttributeValue(ancestor, 'hx-disinherit')
var inherit = getAttributeValue(ancestor, 'hx-inherit')
if (initialElement !== ancestor) {
if (htmx.config.disableInheritance) {
if (inherit && (inherit === '*' || inherit.split(' ').indexOf(attributeName) >= 0)) {
return attributeValue
} else {
return null
}
}
if (disinherit && (disinherit === '*' || disinherit.split(' ').indexOf(attributeName) >= 0)) {
return 'unset'
}
}
return attributeValue
}
/**
* @param {Element} elt
* @param {string} attributeName
* @returns {string | null}
*/
function getClosestAttributeValue(elt, attributeName) {
let closestAttr = null
getClosestMatch(elt, function(e) {
return !!(closestAttr = getAttributeValueWithDisinheritance(elt, asElement(e), attributeName))
})
if (closestAttr !== 'unset') {
return closestAttr
}
}
/**
* @param {Node} elt
* @param {string} selector
* @returns {boolean}
*/
function matches(elt, selector) {
// @ts-ignore: non-standard properties for browser compatibility
// noinspection JSUnresolvedVariable
const matchesFunction = elt instanceof Element && (elt.matches || elt.matchesSelector || elt.msMatchesSelector || elt.mozMatchesSelector || elt.webkitMatchesSelector || elt.oMatchesSelector)
return !!matchesFunction && matchesFunction.call(elt, selector)
}
/**
* @param {string} str
* @returns {string}
*/
function getStartTag(str) {
const tagMatcher = /<([a-z][^\/\0>\x20\t\r\n\f]*)/i
const match = tagMatcher.exec(str)
if (match) {
return match[1].toLowerCase()
} else {
return ''
}
}
/**
* @param {string} resp
* @returns {Document}
*/
function parseHTML(resp) {
const parser = new DOMParser()
return parser.parseFromString(resp, 'text/html')
}
/**
* @param {DocumentFragment} fragment
* @param {Node} elt
*/
function takeChildrenFor(fragment, elt) {
while (elt.childNodes.length > 0) {
fragment.append(elt.childNodes[0])
}
}
/**
* @param {HTMLScriptElement} script
* @returns {HTMLScriptElement}
*/
function duplicateScript(script) {
const newScript = getDocument().createElement('script')
forEach(script.attributes, function(attr) {
newScript.setAttribute(attr.name, attr.value)
})
newScript.textContent = script.textContent
newScript.async = false
if (htmx.config.inlineScriptNonce) {
newScript.nonce = htmx.config.inlineScriptNonce
}
return newScript
}
/**
* @param {HTMLScriptElement} script
* @returns {boolean}
*/
function isJavaScriptScriptNode(script) {
return script.matches('script') && (script.type === 'text/javascript' || script.type === 'module' || script.type === '')
}
/**
* we have to make new copies of script tags that we are going to insert because
* SOME browsers (not saying who, but it involves an element and an animal) don't
* execute scripts created in <template> tags when they are inserted into the DOM
* and all the others do lmao
* @param {DocumentFragment} fragment
*/
function normalizeScriptTags(fragment) {
Array.from(fragment.querySelectorAll('script')).forEach(/** @param {HTMLScriptElement} script */ (script) => {
if (isJavaScriptScriptNode(script)) {
const newScript = duplicateScript(script)
const parent = script.parentNode
try {
parent.insertBefore(newScript, script)
} catch (e) {
logError(e)
} finally {
script.remove()
}
}
})
}
/**
* @typedef {DocumentFragment & {title?: string}} DocumentFragmentWithTitle
* @description a document fragment representing the response HTML, including
* a `title` property for any title information found
*/
/**
* @param {string} response HTML
* @returns {DocumentFragmentWithTitle}
*/
function makeFragment(response) {
// strip head tag to determine shape of response we are dealing with
const responseWithNoHead = response.replace(HEAD_TAG_REGEX, '')
const startTag = getStartTag(responseWithNoHead)
/** @type DocumentFragmentWithTitle */
let fragment
if (startTag === 'html') {
// if it is a full document, parse it and return the body
fragment = /** @type DocumentFragmentWithTitle */ (new DocumentFragment())
const doc = parseHTML(response)
takeChildrenFor(fragment, doc.body)
fragment.title = doc.title
} else if (startTag === 'body') {
// parse body w/o wrapping in template
fragment = /** @type DocumentFragmentWithTitle */ (new DocumentFragment())
const doc = parseHTML(responseWithNoHead)
takeChildrenFor(fragment, doc.body)
fragment.title = doc.title
} else {
// otherwise we have non-body partial HTML content, so wrap it in a template to maximize parsing flexibility
const doc = parseHTML('<body><template class="internal-htmx-wrapper">' + responseWithNoHead + '</template></body>')
fragment = /** @type DocumentFragmentWithTitle */ (doc.querySelector('template').content)
// extract title into fragment for later processing
fragment.title = doc.title
// for legacy reasons we support a title tag at the root level of non-body responses, so we need to handle it
var titleElement = fragment.querySelector('title')
if (titleElement && titleElement.parentNode === fragment) {
titleElement.remove()
fragment.title = titleElement.innerText
}
}
if (fragment) {
if (htmx.config.allowScriptTags) {
normalizeScriptTags(fragment)
} else {
// remove all script tags if scripts are disabled
fragment.querySelectorAll('script').forEach((script) => script.remove())
}
}
return fragment
}
/**
* @param {Function} func
*/
function maybeCall(func) {
if (func) {
func()
}
}
/**
* @param {any} o
* @param {string} type
* @returns
*/
function isType(o, type) {
return Object.prototype.toString.call(o) === '[object ' + type + ']'
}
/**
* @param {*} o
* @returns {o is Function}
*/
function isFunction(o) {
return typeof o === 'function'
}
/**
* @param {*} o
* @returns {o is Object}
*/
function isRawObject(o) {
return isType(o, 'Object')
}
/**
* @typedef {Object} OnHandler
* @property {(keyof HTMLElementEventMap)|string} event
* @property {EventListener} listener
*/
/**
* @typedef {Object} ListenerInfo
* @property {string} trigger
* @property {EventListener} listener
* @property {EventTarget} on
*/
/**
* @typedef {Object} HtmxNodeInternalData
* Element data
* @property {number} [initHash]
* @property {boolean} [boosted]
* @property {OnHandler[]} [onHandlers]
* @property {number} [timeout]
* @property {ListenerInfo[]} [listenerInfos]
* @property {boolean} [cancelled]
* @property {boolean} [triggeredOnce]
* @property {number} [delayed]
* @property {number|null} [throttle]
* @property {string} [lastValue]
* @property {boolean} [loaded]
* @property {string} [path]
* @property {string} [verb]
* @property {boolean} [polling]
* @property {HTMLButtonElement|HTMLInputElement|null} [lastButtonClicked]
* @property {number} [requestCount]
* @property {XMLHttpRequest} [xhr]
* @property {(() => void)[]} [queuedRequests]
* @property {boolean} [abortable]
*
* Event data
* @property {HtmxTriggerSpecification} [triggerSpec]
* @property {EventTarget[]} [handledFor]
*/
/**
* getInternalData retrieves "private" data stored by htmx within an element
* @param {EventTarget|Event} elt
* @returns {HtmxNodeInternalData}
*/
function getInternalData(elt) {
const dataProp = 'htmx-internal-data'
let data = elt[dataProp]
if (!data) {
data = elt[dataProp] = {}
}
return data
}
/**
* toArray converts an ArrayLike object into a real array.
* @template T
* @param {ArrayLike<T>} arr
* @returns {T[]}
*/
function toArray(arr) {
const returnArr = []
if (arr) {
for (let i = 0; i < arr.length; i++) {
returnArr.push(arr[i])
}
}
return returnArr
}
/**
* @template T
* @param {T[]|NamedNodeMap|HTMLCollection|HTMLFormControlsCollection|ArrayLike<T>} arr
* @param {(T) => void} func
*/
function forEach(arr, func) {
if (arr) {
for (let i = 0; i < arr.length; i++) {
func(arr[i])
}
}
}
/**
* @param {Element} el
* @returns {boolean}
*/
function isScrolledIntoView(el) {
const rect = el.getBoundingClientRect()
const elemTop = rect.top
const elemBottom = rect.bottom
return elemTop < window.innerHeight && elemBottom >= 0
}
/**
* @param {Node} elt
* @returns {boolean}
*/
function bodyContains(elt) {
// IE Fix
const rootNode = elt.getRootNode && elt.getRootNode()
if (rootNode && rootNode instanceof window.ShadowRoot) {
return getDocument().body.contains(rootNode.host)
} else {
return getDocument().body.contains(elt)
}
}
/**
* @param {string} trigger
* @returns {string[]}
*/
function splitOnWhitespace(trigger) {
return trigger.trim().split(/\s+/)
}
/**
* mergeObjects takes all the keys from
* obj2 and duplicates them into obj1
* @template T1
* @template T2
* @param {T1} obj1
* @param {T2} obj2
* @returns {T1 & T2}
*/
function mergeObjects(obj1, obj2) {
for (const key in obj2) {
if (obj2.hasOwnProperty(key)) {
// @ts-ignore tsc doesn't seem to properly handle types merging
obj1[key] = obj2[key]
}
}
// @ts-ignore tsc doesn't seem to properly handle types merging
return obj1
}
/**
* @param {string} jString
* @returns {any|null}
*/
function parseJSON(jString) {
try {
return JSON.parse(jString)
} catch (error) {
logError(error)
return null
}
}
/**
* @returns {boolean}
*/
function canAccessLocalStorage() {
const test = 'htmx:localStorageTest'
try {
localStorage.setItem(test, test)
localStorage.removeItem(test)
return true
} catch (e) {
return false
}
}
/**
* @param {string} path
* @returns {string}
*/
function normalizePath(path) {
try {
const url = new URL(path)
if (url) {
path = url.pathname + url.search
}
// remove trailing slash, unless index page
if (!(/^\/$/.test(path))) {
path = path.replace(/\/+$/, '')
}
return path
} catch (e) {
// be kind to IE11, which doesn't support URL()
return path
}
}
//= =========================================================================================
// public API
//= =========================================================================================
/**
* @param {string} str
* @returns {any}
*/
function internalEval(str) {
return maybeEval(getDocument().body, function() {
return eval(str)
})
}
/**
* Adds a callback for the **htmx:load** event. This can be used to process new content, for example initializing the content with a javascript library
*
* @see https://htmx.org/api/#onLoad
*
* @param {(elt: Node) => void} callback the callback to call on newly loaded content
* @returns {EventListener}
*/
function onLoadHelper(callback) {
const value = htmx.on('htmx:load', /** @param {CustomEvent} evt */ function(evt) {
callback(evt.detail.elt)
})
return value
}
/**
* Log all htmx events, useful for debugging.
*
* @see https://htmx.org/api/#logAll
*/
function logAll() {
htmx.logger = function(elt, event, data) {
if (console) {
console.log(event, elt, data)
}
}
}
function logNone() {
htmx.logger = null
}
/**
* Finds an element matching the selector
*
* @see https://htmx.org/api/#find
*
* @param {ParentNode|string} eltOrSelector the root element to find the matching element in, inclusive | the selector to match
* @param {string} [selector] the selector to match
* @returns {Element|null}
*/
function find(eltOrSelector, selector) {
if (typeof eltOrSelector !== 'string') {
return eltOrSelector.querySelector(selector)
} else {
return find(getDocument(), eltOrSelector)
}
}
/**
* Finds all elements matching the selector
*
* @see https://htmx.org/api/#findAll
*
* @param {ParentNode|string} eltOrSelector the root element to find the matching elements in, inclusive | the selector to match
* @param {string} [selector] the selector to match
* @returns {NodeListOf<Element>}
*/
function findAll(eltOrSelector, selector) {
if (typeof eltOrSelector !== 'string') {
return eltOrSelector.querySelectorAll(selector)
} else {
return findAll(getDocument(), eltOrSelector)
}
}
/**
* @returns Window
*/
function getWindow() {
return window
}
/**
* Removes an element from the DOM
*
* @see https://htmx.org/api/#remove
*
* @param {Node} elt
* @param {number} [delay]
*/
function removeElement(elt, delay) {
elt = resolveTarget(elt)
if (delay) {
getWindow().setTimeout(function() {
removeElement(elt)
elt = null
}, delay)
} else {
parentElt(elt).removeChild(elt)
}
}
/**
* @param {any} elt
* @return {Element|null}
*/
function asElement(elt) {
return elt instanceof Element ? elt : null
}
/**
* @param {any} elt
* @return {HTMLElement|null}
*/
function asHtmlElement(elt) {
return elt instanceof HTMLElement ? elt : null
}
/**
* @param {any} value
* @return {string|null}
*/
function asString(value) {
return typeof value === 'string' ? value : null
}
/**
* @param {EventTarget} elt
* @return {ParentNode|null}
*/
function asParentNode(elt) {
return elt instanceof Element || elt instanceof Document || elt instanceof DocumentFragment ? elt : null
}
/**
* This method adds a class to the given element.
*
* @see https://htmx.org/api/#addClass
*
* @param {Element|string} elt the element to add the class to
* @param {string} clazz the class to add
* @param {number} [delay] the delay (in milliseconds) before class is added
*/
function addClassToElement(elt, clazz, delay) {