Referencia de la API

Todos los exports de @kkwaenggwari/animated, con su firma y la guía que los explica.

57 APIs

Valores y grafos

Value

new Value(initial: number)

Un número mutable con setValue, setOffset, flattenOffset, extractOffset, stopAnimation y resetAnimation.

Guía: Valores y style

ValueXY

new ValueXY({ x?, y? })

Valores x e y emparejados con las mismas operaciones, más getLayout y getTranslateTransform.

Guía: Valores y style

createValue

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

Crea un número o un registro numérico con nombre fuera de React. Crearlo no pone nada en marcha.

Guía: Valores y style

AnimatedNode

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

La base de solo lectura de todo valor y grafo: getValue, interpolate y listeners.

Guía: Valores y style

AnimatedInterpolation

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

Una correspondencia viva entre rangos de entrada y de salida, con easing y extrapolación extend, clamp o identity.

Guía: Valores y style

AnimatedComputed

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

Un cálculo puro de solo lectura sobre una o varias entradas. Las salidas que lo usan se ejecutan en JavaScript.

Guía: Valores y style

diffClamp

diffClamp(input, min, max);

Sigue los cambios de la entrada pero se queda dentro de un rango; útil para cabeceras que se ocultan al hacer scroll.

Guía: Valores y style

Hooks de React

useAnimated

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

Gestiona un valor y todos los controladores, entradas y salidas declarados en su factoría. Arranca, se reinicia cuando cambian las dependencias y limpia.

Guía: Valores y style

useAnimatedCSS

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

Da su propia variable CSS, con la vida del componente, a un nodo derivado que no es una expresión calc().

Guía: Valores y style

Drivers, composición y líneas de tiempo

Easing

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

Curvas iguales a las de React Native: linear, quad, cubic, sin, circle, exp, elastic, back, bounce, bezier y ayudantes in/out.

Guía: Timing, resortes y composición

Componentes y layout

Animated

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

El espacio de nombres de los hosts HTML y SVG como Animated.div, más las funciones principales con los nombres de React Native.

Guía: Componentes Animated

Animated.Scope

<Animated.Scope pose? tempo? animation?>…</Animated.Scope>

Comparte un nombre de pose, un tempo y valores por defecto de animación con los elementos Animated que contiene.

Guía: Componentes Animated

Entrada y conexiones

event

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

Asigna datos anidados de eventos a valores, como en React Native.

Guía: Entrada y gestos

dragInput

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

Arrastre con puntero y teclado, con límites, bordes elásticos, inercia y settle.

Guía: Entrada y gestos

scrollInput

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

Posición y progreso del scroll de un elemento, de la página o de un elemento que atraviesa el viewport.

Guía: Entrada y gestos

Salida y diagnóstico

Buscar

Escribe para buscar en la documentación.