大网数据广告活动
Web 标准与前端开发

Animation: overallProgress property

· 52CE 我爱测

The **`overallProgress`** read-only property of the Animation interface returns a number between `0` and `1` indicating the animation's overall progress towards its finished state. This is the overall progress across all of the animation's iterations, not each individual iteratio

Web Animations

The overallProgress read-only property of the Animation interface returns a number between 0 and 1 indicating the animation's overall progress towards its finished state. This is the overall progress across all of the animation's iterations, not each individual iteration.

overallProgress works consistently across all animations, regardless of the type of AnimationTimeline.

Value

A number between 0 and 1, or null if the animation lacks a timeline, is inactive or hasn't been played yet, or if its Animation/currentTime is set to a non-time value.

If the animation's iterations property is set to Infinity, or if its Animation/currentTime is set to a negative value, overallProgress will return 0.

If the animation's duration is set to 0, overallProgress will return 1.

Examples

Displaying a percentage progress

This demo uses overallProgress to create a "percentage progress" readout, which is displayed to the screen while an animation runs.

HTML

The HTML contains a button to press to start the animation, a p element in which to display the percentage progress, and a div that will be animated.

<button>Run animation</button>
<p class="progress">Progress: 0%</p>
<div class="box"></div>

The demo's CSS provides some rudimentary styling, which is not important for understanding how the JavaScript works, therefore we have hidden it for brevity.

* {
  box-sizing: border-box;
}

html {
  font-family: "Helvetica", "Arial", sans-serif;
}

body {
  width: 500px;
  margin: 0 auto;
  padding: 20px;
}

.progress {
  font-weight: bold;
}

.box {
  width: 100px;
  height: 100px;
  border-radius: 40px 20px;
  border: 10px solid black;
  background: lightseagreen;
  margin: 0 auto;
}

JavaScript

In the JavaScript, we start off by grabbing references to the button, p, and div elements.

We then create:

  • an animation variable which will reference the animation, once we've created it
  • a keyframes array
  • an options object containing timing properties.
const btn = document.querySelector("button");
const progress = document.querySelector(".progress");
const box = document.querySelector(".box");

let animation;

const keyframes = [{ rotate: "0deg" }, { rotate: "360deg" }];

const timingProps = {
  duration: 3000,
  iterations: 1,
};

Next we add a "click" event listener to the <button> via addEventListener() so that, when pressed, it:

  1. Starts the animation running using Element.animate(), passing it the keyframes and options defined earlier and assigning the returned Animation instance to the animation variable.
  2. Runs a function called updateProgress() via the Window.requestAnimationFrame method, which handles updating the percentage process display.
btn.addEventListener("click", () => {
  // Animate the box
  animation = box.animate(keyframes, timingProps);
  // Start updating the progress percentage via rAF()
  requestAnimationFrame(updateProgress);
});

Now let's define the updateProgress() function. This queries Animation.playState to see if the animation is not finished. If it isn't finished, we grab the current value of overallProgress, multiplying it by 100 and rounding the result down to convert it to a whole percentage number, then update the <p> element's Node.textContent value with it. We then call requestAnimationFrame(updateProgress) again to re-run the progress percentage update.

If the animation is finished, we replace the percentage progress with a "Finished!" message, and don't call requestAnimationFrame(updateProgress), so the progress percentage updates stop.

function updateProgress() {
  // Check if the animation is finished
  if (animation.playState !== "finished") {
    // Convert overallProgress to a whole number percentage
    const progressPercentage = Math.floor(animation.overallProgress * 100);
    // Update the progress paragraph with the percentage
    progress.textContent = `Progress: ${progressPercentage}%`;
    // Only request the next frame if the animation is not finished
    requestAnimationFrame(updateProgress);
  } else {
    progress.textContent = "Finished!";
  }
}

Result

The output looks like this. Try pressing the button to see the animation and associated progress indicator run.

Displaying a percentage progress

Specifications

Browser compatibility

See also

  • Animation for other methods and properties you can use to control web page animation.
  • Web Animations API

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。