Skip to content

Update JSDoc and parameter naming for process() and cleanup() #3847

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
scriptogre wants to merge 1 commit into
base: four-dev
Choose a base branch
from
+32 −23
Open

Update JSDoc and parameter naming for process() and cleanup() #3847

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
2 changes: 1 addition & 1 deletion dist/htmx.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export interface Htmx {
on(event: string, handler: (evt: Event) => void): void;
on(target: string | Element, event: string, handler: (evt: Event) => void): void;
onLoad(callback: (elt: Element) => void): void;
process(elt: Element): void;
process(root: Element | ShadowRoot | DocumentFragment): void;
registerExtension(name: string, ext: any): void;
trigger(elt: Element | string, event: string, detail?: any, bubbles?: boolean): boolean;
timeout(ms: number): Promise<void>;
Expand Down
53 changes: 31 additions & 22 deletions src/htmx.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -869,30 +869,35 @@ var htmx = (() => {
return func.call(thisArg, ...values);
}

process(elt) {
if (!elt) return;
if (!(elt instanceof Element)) {
for (let child of elt.children || []) this.process(child);
/**
* Initialize htmx attributes on root and all its descendants.
* @see https://four.htmx.org/reference/methods/htmx-process
* @param {Element | ShadowRoot | DocumentFragment} root
*/
process(root) {
if (!root) return;
if (!(root instanceof Element)) { // ShadowRoot, DocumentFragment
for (let elt of root.children || []) this.process(elt);
return;
}
if (this.__ignore(elt)) return;
if (!this.__trigger(elt, "htmx:before:process")) return
let hxOnNodes = [elt];
let iter = this.#hxOnQuery.evaluate(elt)
if (this.__ignore(root)) return;
if (!this.__trigger(root, "htmx:before:process")) return
let hxOnNodes = [root];
let iter = this.#hxOnQuery.evaluate(root)
let node = null
while (node = iter.iterateNext()) hxOnNodes.push(node)
for (let hxOnNode of hxOnNodes) {
if (!this.__ignore(hxOnNode) && this.__trigger(hxOnNode, "htmx:before:on:init", {}, true)) {
this.__handleHxOnAttributes(hxOnNode);
}
}
for (let child of this.__queryEltAndDescendants(elt, this.#actionSelector)) {
this.__initializeElement(child);
for (let elt of this.__queryEltAndDescendants(root, this.#actionSelector)) {
this.__initializeElement(elt);
}
for (let child of this.__queryEltAndDescendants(elt, this.#boostSelector)) {
this.__maybeBoost(child);
for (let elt of this.__queryEltAndDescendants(root, this.#boostSelector)) {
this.__maybeBoost(elt);
}
this.__trigger(elt, "htmx:after:process");
this.__trigger(root, "htmx:after:process");
}

__maybeBoost(elt) {
Expand Down Expand Up @@ -936,23 +941,27 @@ var htmx = (() => {
return !elt._htmx?.initialized && !this.__ignore(elt);
}

__cleanup(elt) {
if (elt._htmx) {
this.__trigger(elt, "htmx:before:cleanup")
for (let spec of elt._htmx.triggerSpecs || []) {
/**
* Remove listeners, timers, and observers from root and all powered descendants.
* @param {Element} root
*/
__cleanup(root) {
if (root._htmx) {
this.__trigger(root, "htmx:before:cleanup")
for (let spec of root._htmx.triggerSpecs || []) {
if (spec.interval) clearInterval(spec.interval);
if (spec.timeout) clearTimeout(spec.timeout);
if (spec.throttleTimeout) clearTimeout(spec.throttleTimeout);
spec.observer?.disconnect()
}
for (let listenerInfo of elt._htmx.listeners || []) {
for (let listenerInfo of root._htmx.listeners || []) {
listenerInfo.fromElt.removeEventListener(listenerInfo.eventName, listenerInfo.handler, listenerInfo);
}
this.__trigger(elt, "htmx:after:cleanup")
this.__trigger(root, "htmx:after:cleanup")
}
if (elt.firstChild) {
for (let child of elt.querySelectorAll('[data-htmx-powered]')) {
this.__cleanup(child);
if (root.firstChild) {
for (let elt of root.querySelectorAll('[data-htmx-powered]')) {
this.__cleanup(elt);
}
}
}
Expand Down