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 は終わりの見えない状態として流れるバーや回転する弧を表示します。
モーションの途中で新しい値が来ても、速度を保ったまま続きます。
途切れることのない 1 本の線や弧で、区切りが飛ぶことはありません。
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 でも使えます。