ProgressBar · ProgressRing

支援不確定狀態的受控進度條與進度環。

WebReact Native進度

動手試試

正在準備範例…

JavaScript 已關閉。下方的程式碼就是完整的範例。

App.jsx

import { useEffect, useState } from 'react';
import {
  MotionNumber,
  ProgressBar,
  ProgressRing,
  motionTokens,
} from '@kkwaenggwari/animated-chorus';
import './styles.css';

export default function App({ indeterminate = false, thickness = 8, spring = 'default' }) {
  const [progress, setProgress] = useState(35);
  const [uploading, setUploading] = useState(false);
  // "default" is not a preset: undefined keeps the component's own motion.
  const transition = motionTokens.spring[spring];
  const value = indeterminate ? null : progress;

  // A pretend upload: a new value every 350 ms until it reaches 100.
  useEffect(() => {
    if (!uploading) return;
    if (progress >= 100) {
      setUploading(false);
      return;
    }
    const timer = setTimeout(() => setProgress(Math.min(100, progress + 7 + (progress % 5))), 350);
    return () => clearTimeout(timer);
  }, [uploading, progress]);

  return (
    <div className="stage">
      <div className="ring">
        <ProgressRing
          value={value}
          size={120}
          thickness={thickness}
          color="#176b52"
          trackColor="#eaf6f0"
          transition={transition}
        >
          <strong>{indeterminate ? '…' : <MotionNumber value={progress} suffix="%" />}</strong>
        </ProgressRing>
      </div>
      <ProgressBar
        className="bar"
        value={value}
        thickness={thickness}
        color="#176b52"
        trackColor="#eaf6f0"
        transition={transition}
      />
      <div className="buttons">
        <button
          className="primary"
          onClick={() => {
            setProgress(0);
            setUploading(true);
          }}
        >
          Start upload
        </button>
        <button onClick={() => setProgress(Math.min(100, progress + 10))}>+10%</button>
        <button onClick={() => setProgress(Math.max(0, progress - 25))}>−25%</button>
      </div>
    </div>
  );
}

styles.css

.stage {
  display: grid;
  justify-items: center;
  gap: 22px;
  max-width: 480px;
  margin: 0 auto;
  padding: 32px 20px;
}

.ring strong {
  font:
    800 24px system-ui,
    sans-serif;
  font-variant-numeric: tabular-nums;
  color: #0e2e24;
}

.bar {
  width: 100%;
  border-radius: 999px;
  overflow: hidden;
}

.buttons {
  display: flex;
  flex-wrap: wrap;
  justify-content: center;
  gap: 8px;
}

.buttons button {
  min-height: 44px;
  padding: 0 16px;
  border: 1px solid #cfe8dc;
  border-radius: 999px;
  background: #fff;
  font:
    600 14px system-ui,
    sans-serif;
  cursor: pointer;
}

.buttons .primary {
  border-color: #176b52;
  background: #176b52;
  color: #fff;
}

最簡用法

Upload.jsx

<ProgressBar value={progress} max={100} />
<ProgressRing value={progress} size={96}>{progress}%</ProgressRing>
<ProgressBar value={null} /> {/* indeterminate */}

它替你處理的事

值會限制在 0…max 範圍內，null 會顯示不確定的掃動條或旋轉弧線。
動態進行中的新值會帶著速度繼續。
始終是一條連續的線或弧，絕不會跳格。
指定了 duration 的彈簧會恰好在那一刻結束。

適用情境

檔案上傳。
已用儲存空間占配額的比例。
結帳流程的進度。

Props

`ProgressBar`

Prop	型別	預設值	說明
`value`	`number \| null`		從 `0` 到 `max` 的進度；`null` 表示不確定。
`max`	`number`	`100`	代表完成的值。
`color`	`string`	`'currentColor'`	填色顏色。
`trackColor`	`string`	`'#e7ece9'`	軌道顏色。
`thickness`	`number`	`8`	線條粗細，單位為像素。
`direction`	`'ltr' \| 'rtl'`	`'ltr'`	從左（`ltr`）或從右（`rtl`）開始填滿。
`transition`	`Transition`	`spring`	時間曲線 `{ duration, easing }` 或彈簧 `{ tempo: 'spring', spring }`。彈簧被中斷時會保留動量。

`ProgressRing`

Prop	型別	預設值	說明
`value`	`number \| null`		從 `0` 到 `max` 的進度；`null` 表示不確定。
`max`	`number`	`100`	代表完成的值。
`size`	`number`	`96`	直徑，單位為像素。
`thickness`	`number`	`8`	圓環粗細，單位為像素。
`color`	`string`	`'currentColor'`	弧線顏色。
`trackColor`	`string`	`'#e7ece9'`	軌道顏色。
`children`	`ReactNode`		顯示在中間的標籤。
`transition`	`Transition`	`spring`	時間曲線 `{ duration, easing }` 或彈簧 `{ tempo: 'spring', spring }`。彈簧被中斷時會保留動量。

其他 props 會傳給渲染的元素，所以 className、style 與事件處理函式照常可用。

Web 與 React Native

ProgressRing 可接收子元素作為中間的標籤；ProgressBar 可用 direction 從右側開始填滿。

同樣的元件與 props 在 React Native 上也能用。