API-Referenz

Jeder Export von @kkwaenggwari/animated mit Signatur und dem Guide, der ihn erklärt.

57 APIs

Werte und Graphen

Value

new Value(initial: number)

Eine veränderbare Zahl mit setValue, setOffset, flattenOffset, extractOffset, stopAnimation und resetAnimation.

Guide: Werte und style

createValue

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

Eine Zahl oder einen benannten Zahlen-Record außerhalb von React erstellen. Das Erstellen löst nichts aus.

Guide: Werte und style

AnimatedNode

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

Die schreibgeschützte Basis jedes Werts und Graphen: getValue, interpolate und Listener.

Guide: Werte und style

AnimatedInterpolation

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

Eine lebendige Zuordnung von Eingabe- zu Ausgabebereichen, mit easing und Extrapolation extend, clamp oder identity.

Guide: Werte und style

AnimatedComputed

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

Eine reine, schreibgeschützte Berechnung über eine oder mehrere Eingaben. Ausgaben, die sie nutzen, laufen in JavaScript.

Guide: Werte und style

diffClamp

diffClamp(input, min, max);

Folgt den Änderungen der Eingabe, bleibt aber in einem Bereich; nützlich für Kopfzeilen, die sich beim Scrollen verstecken.

Guide: Werte und style

React-Hooks

useAnimatedValue

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

Eine Zahl oder einen Zahlen-Record für die Lebensdauer der Komponente halten. In style ist er eine CSS-Variable.

Guide: Werte und style

useAnimated

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

Einen Wert und jeden in seiner Factory deklarierten Controller, jede Eingabe und Ausgabe halten. Startet, startet bei geänderten Abhängigkeiten neu und räumt auf.

Guide: Werte und style

useAnimatedCSS

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

Einem abgeleiteten Knoten, der kein calc()-Ausdruck ist, eine eigene CSS-Variable mit Komponenten-Lebensdauer geben.

Guide: Werte und style

Driver, Komposition und Timelines

Easing

Easing.inOut(Easing.cubic) · Easing.bezier(x1, y1, x2, y2)

Kurven wie in React Native: linear, quad, cubic, sin, circle, exp, elastic, back, bounce, bezier und in/out-Helfer.

Guide: Timing, Federn und Komposition

Komponenten und Layout

Animated

<Animated.div seed pose tempo respond depart move />;

Der Namespace der HTML- und SVG-Hosts wie Animated.div, dazu die Kernfunktionen unter React-Native-Namen.

Guide: Animated-Komponenten

Animated.wrap

Animated.wrap(Component) · Animated.createAnimatedComponent(Component)

Eine Komponente, die ihre ref weiterleitet, die props der Animated-Hosts akzeptieren lassen.

Guide: Animated-Komponenten

Eingaben und Verbindungen

event

Animated.event([{ nativeEvent: { contentOffset: { y } } }]);

Verschachtelte Event-Daten auf Werte abbilden, wie in React Native.

Guide: Eingaben und Gesten

dragInput

dragInput({ x?, y?, axis?, bounds?, elastic?, momentum?, settle? })

Ziehen per Zeiger und Tastatur mit Grenzen, elastischen Rändern, Schwung und settle.

Guide: Eingaben und Gesten

scrollInput

scrollInput({ x?, y?, progressX?, progressY?, target?, through? })

Scrollposition und Fortschritt eines Elements, der Seite oder eines Elements, das den Viewport durchquert.

Guide: Eingaben und Gesten

Ausgabe und Diagnose

bind

bind(element, style) → { update, inspect, dispose }

Animated-Styles außerhalb von React an ein Element binden; gibt update, inspect und dispose zurück.

Guide: Performance und Wiedergabe

Suchen

Tippe, um die Dokumentation zu durchsuchen.