Referência da API

Todos os exports de @kkwaenggwari/animated, com assinatura e o guia que os explica.

57 APIs

Valores e grafos

Value

new Value(initial: number)

Um número mutável com setValue, setOffset, flattenOffset, extractOffset, stopAnimation e resetAnimation.

Guia: Valores e style

ValueXY

new ValueXY({ x?, y? })

Valores x e y em par com as mesmas operações, além de getLayout e getTranslateTransform.

Guia: Valores e style

createValue

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

Cria um número ou um registro numérico nomeado fora do React. Criar não dispara nada.

Guia: Valores e style

AnimatedNode

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

A base somente leitura de todo valor e grafo: getValue, interpolate e listeners.

Guia: Valores e style

AnimatedInterpolation

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

Um mapeamento vivo entre faixas de entrada e de saída, com easing e extrapolação extend, clamp ou identity.

Guia: Valores e style

AnimatedComputed

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

Um cálculo puro e somente leitura sobre uma ou mais entradas. As saídas que o usam rodam em JavaScript.

Guia: Valores e style

diffClamp

diffClamp(input, min, max);

Segue as mudanças da entrada, mas fica dentro de uma faixa; útil para cabeçalhos que se escondem na rolagem.

Guia: Valores e style

Hooks do React

useAnimated

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

Mantém um valor e todo controlador, entrada e saída declarados na factory dele. Começa, recomeça quando as dependências mudam e faz a limpeza.

Guia: Valores e style

useAnimatedCSS

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

Dá a um nó derivado que não é uma expressão calc() uma variável CSS própria, com a vida do componente.

Guia: Valores e style

Drivers, composição e linhas do tempo

Easing

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

Curvas iguais às do React Native: linear, quad, cubic, sin, circle, exp, elastic, back, bounce, bezier e auxiliares in/out.

Guia: Timing, molas e composição

Componentes e layout

Animated

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

O namespace dos hosts HTML e SVG como Animated.div, mais as funções principais com os nomes do React Native.

Guia: Componentes Animated

Entrada e conexões

input

input(targetRef, adapter, onEvent?)

Conecta um adaptador de entrada a um elemento como controlador gerenciado.

Guia: Entrada e gestos

event

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

Mapeia dados aninhados de eventos para valores, como no React Native.

Guia: Entrada e gestos

dragInput

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

Arraste com ponteiro e teclado, com limites, bordas elásticas, inércia e settle.

Guia: Entrada e gestos

scrollInput

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

Posição e progresso da rolagem de um elemento, da página ou de um elemento atravessando o viewport.

Guia: Entrada e gestos

Saída e diagnóstico

bind

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

Vincula estilos Animated a um elemento fora do React; retorna update, inspect e dispose.

Guia: Desempenho e reprodução

Pesquisar

Digite para pesquisar na documentação.