WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Animation.finished — das Promise für den Animationsabschluss

Mit Animation.finished kannst du mit await auf den Abschluss einer Animation warten und dabei einen möglichen Abbruch berücksichtigen.

Version: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Syntax

const completedAnimation = await animation.finished;

Animation.finished ist eine schreibgeschützte Eigenschaft, die ein Promise<Animation> zurückgibt. Erreicht die Animation den Zustand finished, auch durch finish(), kann das Promise mit dem Animationsobjekt erfüllt werden. Es ist weder ein boolescher Wert noch eine Methode.

Beim Verlassen des Zustands finished wird das aktuelle Promise nur ersetzt, wenn es bereits erfüllt wurde. Verlässt die Animation diesen Zustand, bevor eine zur Verarbeitung vorgemerkte Abschlussbenachrichtigung das Promise erfüllt, kann dasselbe Promise noch ausstehen. Lies die Eigenschaft für eine weitere Wiedergabe erneut aus. Ist die Animation nicht im Zustand idle, weist cancel() ihr aktuelles finished-Promise mit einer DOMException namens AbortError zurück, sofern es noch aussteht. Diese Zurückweisung kannst du mit try/catch abfangen. Ist die Animation bereits im Zustand idle, bleibt ein ausstehendes finished-Promise bei cancel() ausstehend. await kann dann weiter warten, ohne dass der catch-Block ausgeführt wird. ready zeigt an, dass die Wiedergabe oder Pause bereit ist, nicht dass die Animation abgeschlossen ist.

Dies gehört zu Web Animations, nicht zu ECMAScript. Es wird Browserunterstützung benötigt; Node 24 im Repository belegt diese nicht.

Beispiele

(async () => {
  const element = document.createElement('div');
  element.textContent = 'Animation.finished';
  document.body.append(element);

  const animation = element.animate(
    [{ opacity: 0 }, { opacity: 1 }],
    { duration: 1000, fill: 'forwards' }
  );

  try {
    const completion = animation.finished;
    animation.finish();
    const result = await completion;
    console.log(result === animation);
    console.log(animation.playState);
  } catch (error) {
    console.log(error.name);
  } finally {
    animation.cancel();
    element.remove();
  }
})();

Ergebnis

true
finished

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen