Popmotion
Pose Core
Factory for Pose animation state machines
Install
npm install pose-core --saveCreate a poser factory
JavaScript
import poseFactory from 'pose-core';
const pose = poseFactory(config);TypeScript
const pose = poseFactory<Value, Action, Poser>(config);Config options
All config options are mandatory.
getDefaultProps
Returns default properties to be injected into every poser's config.props property.
(config: PoserConfig) => { [key: string]: any }readValue
Read and return from Value.
(value: Value) => any;createValue
Create a new Value. Each Value is responsible for tracking a single value defined in the poser's poses.
type CreateValueProps = {
passiveParent?: Value,
passiveProps?: any // Passed as the second value in the `passive` tuple
}
(init: any, props?: CreateValueProps) => ValueresolveTarget
Accepts the target as defined in the pose, and returns an animatable version of it. For instance React Animated only animates raw numbers, so it runs every target through parseFloat.
(value: Value, target: any) => anygetTransitionProps
Takes the target as returned from resolveTarget and returns default props to be passed to the entered pose's transition function.
(value: Value, target: any) => { [key: string]: any }bindOnChange
Bind the onChange callbacks to their respective Values.
type OnChangeMap = { [key: string]: (v: any) => void };
type ValuesMap = Map<string, Value>;
(values: Map<string, Value>, onChange: OnChangeMap) => (key: string) => void;startAction
Takes an action (ie animation or interaction) and returns the subscription returned from its start (or equivalent) method. This subscription might be the same as the action (in the case of Animated) or different (in the case of Popmotion)
(action: Action, onComplete: Function) => ActionSubscriptionstopAction
Takes an action subscription and stops it.
(actionSubscription: ActionSubscription) => voidgetInstantTransition
Returns an Action that represents an instant transition. We do this rather than simply set on the corresponding Value because both Animated and Popmotion allow these "instant" actions to be composed with things like a delay action.
(value: Value, to: number) => ActionaddActionDelay
Returns an action that delays the execution of the initially provided action.
(delay: number, action: Action) => ActiondefaultTransitions
A Map that contains Action factory functions that match the signature of the pose's transition property.
The Map must contain at least a 'default' action factory.
Map<string, (props: Props) => Action>selectValueToRead
Accepts Value and returns the value returned by poser.get(key: string)
(value: Value) => anyextendAPI
A chance to add methods to the output Poser. For instance the Popmotion Pose factory uses this to append DOM-specific FLIP methods. Simply return api for no change.
(api: Poser) => Poser