API リファレンス

@kkwaenggwari/animated のすべてのエクスポートと、そのシグネチャー、解説しているガイド。

57 個の API

値とグラフ

Value

new Value(initial: number)

setValue、setOffset、flattenOffset、extractOffset、stopAnimation、resetAnimation を持つ、変更できる数値。

ガイド: 値と style

ValueXY

new ValueXY({ x?, y? })

同じ操作に加えて getLayout と getTranslateTransform を持つ、x と y の値のペア。

ガイド: 値と style

createValue

createValue(initial: number | Record<string, number>)

React の外で数値か、名前付きの数値レコードを作ります。作成しただけでは何も動きません。

ガイド: 値と style

AnimatedNode

node.getValue() · node.interpolate(config) · node.addListener(fn)

すべての値とグラフの読み取り専用の基底: getValue、interpolate、リスナー。

ガイド: 値と style

AnimatedInterpolation

node.interpolate({ inputRange, outputRange, easing?, extrapolate? })

入力範囲から出力範囲への動く対応付け。easing と、extend・clamp・identity の外挿を指定できます。

ガイド: 値と style

AnimatedComputed

new AnimatedComputed(inputs, (...values) => result);

1 つ以上の入力に対する、純粋で読み取り専用の計算。これを使う出力は JavaScript で動きます。

ガイド: 値と style

diffClamp

diffClamp(input, min, max);

入力の変化に追従しつつ、範囲内に収まります。スクロールで隠れるヘッダーに便利です。

ガイド: 値と style

React フック

useAnimatedValue

useAnimatedValue(initial, { scope?, id? }?)

コンポーネントの寿命の間、数値か数値レコードを持ちます。style の中では CSS 変数です。

ガイド: 値と style

useAnimated

useAnimated(initial, value => { … }, deps?, { autoStart?, onComplete?, scope? }?)

値と、そのファクトリーで宣言したすべてのコントローラー・入力・出力を所有します。開始し、依存値が変わると再開し、後片付けもします。

ガイド: 値と style

useAnimatedCSS

useAnimatedCSS(node, { scope?, id? }?): string

calc() 式にできない派生ノードに、コンポーネントと同じ寿命の専用の CSS 変数を与えます。

ガイド: 値と style

ドライバー、組み合わせ、タイムライン

コンポーネントとレイアウト

入力と接続

出力と診断

検索

入力するとドキュメントを検索します。