HOWTO · jQuery

Verwendung von setTimeout() in jQuery

Im heutigen Beitrag lernen wir die setTimeout-Funktion in jQuery kennen.

Auf dieser Seite

setTimeout() ist eine integrierte JavaScript-Funktion und keine jQuery-Methode. Du kannst sie in jQuery-Code aufrufen, um ein Element zu aktualisieren, eine Animation zu starten oder nach Ablauf einer Verzögerung eine weitere Aktion einzuplanen. Der Callback wird einmal ausgeführt. Soll eine Aktion wiederholt werden, verwende ein Intervall.

Was setTimeout() in jQuery bewirkt

Der Browser plant einen Callback für einen späteren Durchlauf seiner Ereignisschleife ein. jQuery stellt keine eigene Timer-API bereit, sondern praktische Methoden wie .text() und .animate(), die der Callback aufrufen kann. Die angeforderte Verzögerung ist eine Mindestwartezeit für die Einplanung und keine Garantie, dass der Callback exakt dann ausgeführt wird.

Syntax und Argumente von setTimeout()

Die Funktionsform lautet setTimeout(callback, delay, ...args). callback ist eine aufzurufende Funktion, delay die Wartezeit in Millisekunden, nach der der Callback ausgeführt werden kann. Optionale Argumente werden an den Callback übergeben. Verwende vorzugsweise einen Funktions-Callback statt einer Zeichenfolge mit Code: Zeichenfolgen sind schwieriger zu warten und können Sicherheitsprobleme verursachen.

Das folgende eigenständige JavaScript-Beispiel veranschaulicht den Callback und die Verzögerung. Es wurde in diesem Paket nicht ausgeführt; daher wird kein beobachtetes Ergebnis angegeben:

Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.

setTimeout(() => {
  console.log("The callback ran");
}, 1000);

jQuery-Code nach einer Verzögerung ausführen

Auf einer Seite, die jQuery lädt, kannst du dessen Methoden innerhalb des Callbacks aufrufen. Dieses Beispiel für den Seitenquelltext ändert den Absatz einmal, nachdem auf die Schaltfläche geklickt wurde und die Verzögerung abgelaufen ist. Es ist eine statische Veranschaulichung und setzt das Browser-DOM sowie ein aus dem Netzwerk geladenes jQuery-Skript voraus; ein Laufzeitergebnis wird daher nicht behauptet.

Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.

<p id="message">Waiting for an update.</p>
<button id="change">Change the message</button>
<script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
<script>
  $("#change").on("click", function () {
    setTimeout(function () {
      $("#message").text("The delayed update ran.");
    }, 1000);
  });
</script>

Die Verzögerung beginnt bei jedem Klick von Neuem. Klickt der Benutzer mehrmals, plant jeder Klick einen eigenen Callback ein. Wenn nur die jüngste Anfrage ausgeführt werden soll, speichere die Timer-Handles und breche vorherige Timer ab.

jQuery-Animationen einplanen

Du kannst einzelne Aufrufe von .animate() so einplanen, dass sie zu unterschiedlichen Zeitpunkten beginnen. Berücksichtige bei einer Abfolge die Dauer jeder Animation: Ein zweiter Timer, der 2,000 Millisekunden nach dem ursprünglichen Klick gesetzt wird, wird nicht automatisch erst nach dem Ende der ersten Animation eingeplant. Für eine klarere Abfolge planst du die nächste Aktion im Abschluss-Callback der ersten Animation ein: $("#box").animate({ left: "+=100px" }, 1000, function () { $(this).animate({ top: "+=100px" }, 1000); });. Das setzt eine Seite mit jQuery und ein Element mit der ID box voraus, dessen CSS-Position nicht static ist, zum Beispiel position: relative. Lege diese Position fest, bevor die Animation beginnt, damit sowohl left als auch top das Element bewegen können. Die erste Animation fordert eine Bewegung von einer Sekunde an; die zweite beginnt, wenn der Abschluss-Callback der ersten ausgeführt wird. Ladezeit und Darstellung im Browser können die tatsächliche Dauer beeinflussen.

Einen geplanten Timeout abbrechen

Speichere den von setTimeout() zurückgegebenen Wert und übergib dieses Handle an clearTimeout(), bevor der Callback ausgeführt wird. Deklariere in einem jQuery-Klick-Handler let timer; und weise im Handler für #start den Wert timer = setTimeout(function () { $("#message").text("The delayed update ran."); }, 3000); zu. Im Handler für #cancel rufst du clearTimeout(timer); auf. Diese Syntaxveranschaulichung setzt Elemente mit den IDs start, cancel und message sowie jQuery voraus. clearTimeout() verhindert, dass ein noch ausstehender Callback ausgeführt wird; einen bereits gestarteten Callback kann es nicht rückgängig machen. Wenn jede Startaktion einen neuen Timer anlegt, entscheide, ob du den vorherigen zuerst abbrechen solltest, damit sich nicht mehrere ausstehende Aktualisierungen ansammeln.

Zeitsteuerung und Timer-IDs

Auch bei einer Verzögerung von 0 wird der Callback asynchron eingeplant; er wird dadurch nicht vor der nächsten Anweisung direkt ausgeführt. Wenn andere Aufgaben in der Warteschlange stehen oder die Seite ausgelastet ist, kann der Browser den Callback später als nach der angeforderten Verzögerung ausführen. Speichere das zurückgegebene Timer-Handle nur, wenn du den geplanten Callback abbrechen musst, und übergib es dann an clearTimeout(); für diesen Ablauf brauchst du nicht zu wissen, wie das Handle dargestellt wird.