ガイド · 01

値と style

コンポーネントで値を持ち、calc() で出力を導き、CSS 変数を書き込む場所を選びます。

値を持つ

useAnimatedValue(initial) はコンポーネントが所有する Value を作ります。数値か、{ x: 0, opacity: 1 } のようにフィールドごとに別々の値を持つレコードを使えます。

普通の style の中では、フックの値は var(--kkwa-…, initial) というトークンです。更新はその値を使う要素に変数を書き込むだけで、React はレンダリングしません。

サンプルを準備中…

JavaScript がオフになっています。下のコードがサンプルの全体です。

App.jsx

import { timing, useAnimatedValue } from '@kkwaenggwari/animated';
import './styles.css';

export default function App({ duration = 600 }) {
  const progress = useAnimatedValue(1);

  const toggle = () => {
    const toValue = progress.getValue() > 0.5 ? 0 : 1;
    timing(progress, { toValue, duration }).start();
  };

  return (
    <div className="stage">
      <button type="button" onClick={toggle}>
        Toggle
      </button>
      <div className="box" style={{ opacity: progress }}>
        Ready
      </div>
    </div>
  );
}

styles.css

.stage {
  display: flex;
  align-items: center;
  gap: 24px;
  min-height: 200px;
  padding: 28px;
}

button {
  min-height: 44px;
  padding: 0 20px;
  border: 0;
  border-radius: 999px;
  background: #2854ff;
  color: #fff;
  font: inherit;
  font-weight: 650;
  cursor: pointer;
}

.box {
  display: grid;
  place-items: center;
  width: 140px;
  height: 140px;
  border-radius: 24px;
  background: #16181d;
  color: #fff;
  font-weight: 700;
}

calc() で導く

イージングのない補間と、定数との add、subtract、multiply、divide は、同じ変数の正確な calc() 式になります。ブラウザーが計算するので、フレームごとに JavaScript は動きません。

Slide.jsx

const progress = useAnimatedValue(0);

// A linear interpolation of a hook value is a calc() of the same CSS variable.
const x = progress.interpolate({ inputRange: [0, 1], outputRange: ['0px', '180px'] });
const half = multiply(progress, 0.5);

<div style={{ opacity: half, transform: `translateX(${x})` }} />;

サンプルを準備中…

JavaScript がオフになっています。下のコードがサンプルの全体です。

App.jsx

import { spring, useAnimatedValue } from '@kkwaenggwari/animated';
import './styles.css';

const colors = ['#2854ff', '#4a6bff', '#8fb0ff', '#7d9bff', '#5c7cff'];

export default function App({ distance = 220, spread = 0.12 }) {
  const progress = useAnimatedValue(0);

  const toggle = () => {
    const toValue = progress.getValue() < 0.5 ? 1 : 0;
    spring(progress, { toValue, stiffness: 150, damping: 16 }).start();
  };

  return (
    <div className="stage">
      <button type="button" onClick={toggle}>
        Move all
      </button>
      <div className="lanes">
        {colors.map((color, index) => {
          const start = index * spread;
          const x = progress.interpolate({
            inputRange: [start, start + 1 - spread * 4],
            outputRange: ['0px', `${distance}px`],
            extrapolate: 'clamp',
          });
          const turn = progress.interpolate({
            inputRange: [0, 1],
            outputRange: ['0deg', `${90 + index * 45}deg`],
          });
          return (
            <div key={color} className="lane">
              <span style={{ background: color, transform: `translateX(${x}) rotate(${turn})` }} />
            </div>
          );
        })}
      </div>
    </div>
  );
}

styles.css

.stage {
  display: grid;
  gap: 20px;
  padding: 28px;
}

button {
  justify-self: start;
  min-height: 44px;
  padding: 0 20px;
  border: 0;
  border-radius: 999px;
  background: #2854ff;
  color: #fff;
  font: inherit;
  font-weight: 650;
  cursor: pointer;
}

.lanes {
  display: grid;
  gap: 10px;
}

.lane {
  height: 36px;
  max-width: 320px;
  border-radius: 999px;
  background: #f5f6fb;
}

.lane span {
  display: block;
  width: 36px;
  height: 36px;
  border-radius: 10px;
}

色と独自の計算

色、イージング付きの補間、modulo、diffClamp、AnimatedComputed は calc() では書けません。useAnimatedCSS(node) はそれらに専用の CSS 変数を与え、コンポーネントと同じ寿命で JavaScript から更新します。

そうしたノードを style に直接使うと例外が投げられるので、コストが隠れることはありません。

Glow.jsx

const progress = useAnimatedValue(0);

// Colors and eased curves are not calc() expressions: give them their own CSS value.
const color = useAnimatedCSS(
  progress.interpolate({ inputRange: [0, 1], outputRange: ['#3d3bf3', '#22b8f0'] }),
);

<div style={{ background: color }} />;

レシピをフックに任せる

useAnimated(initial, factory, deps) は値と、ファクトリーの中で同期的に宣言したすべてのコントローラーを所有します。マウント時に開始し、依存値が変わると再開し、アンマウント時に止まります。

イベントで再生したいときは { autoStart: false } を渡し、返された値の start()、stop()、reset() を呼びます。

Intro.jsx

const intro = useAnimated(
  { opacity: 0, y: 24 },
  (value) => {
    parallel([
      timing(value.opacity, { toValue: 1, duration: 400 }),
      spring(value.y, { toValue: 0, stiffness: 220, damping: 20 }),
    ]);
  },
  [],
);

<section style={{ opacity: intro.opacity, transform: `translateY(calc(${intro.y} * 1px))` }} />;

多くの要素に 1 回で書き込む

デフォルトでは、インラインスタイルで値を使う要素ごとに変数が書き込まれます。scope を使うと変数はコンテナーに 1 回だけ書き込まれ、子要素が継承します。数百個の要素があるときに適した選択です。

AnimatedProvider scope={ref} は、その配下のすべてのフックの値にデフォルトのスコープを設定します。

Field.jsx

const field = useRef(null);

// Written once on the field; every child that uses the value inherits it.
const wave = useAnimatedValue(0, { scope: field });

<div ref={field}>
  {items.map((item) => (
    <i key={item} style={{ transform: `rotate(calc(${wave} * 1turn))` }} />
  ))}
</div>;

JavaScript で値を読む

getValue() は React を購読させずにスナップショットを返します。useAnimatedListener(node, fn) は変更のたびに呼び出され、アンマウント時にリスナーを外します。canvas への描画や分析に使い、レンダリングには使わないでください。