API

Composite

Control a named map of actions, and output to the same structure.

Import

import { composite } from 'popmotion';

Usage

composite({
  x: tween({ from: 60, to: 400 }),
  y: physics({ from: 60, velocity: 300 })
}).start(({ x, y }) => {});

composite outputs at most once per frame.

Methods

Action methods

composite() returns:

  • filter((v: any) => boolean): Returns a new action that filters out values when the provided function returns false.
  • pipe(...funcs: Array<(v) => v): Returns a new action that will run update values through this sequence of functions.
  • start(update | { update, complete }): Starts the action and returns a subscription.
  • while((v: any) => boolean): Returns a new action that will complete when the provided function returns false.

Subscription methods

composite().start() returns:

  • stop(): void

Note: If all actions return the same API, for instance all composed actions are tweens, the composite subscription will also return a version of that API that controls all child actions.