Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Animate<S, SS, S>

A component that AnimationGroup can animate.

This component gets access to the AnimationGroup via the <ConnectToAnimationGroup /> HOC and must:

  • call group.register(this) in componentDidMount()
  • call group.unregister(this) in componentWillUnmount()
  • call group.register(this) whenever estimatedDuration changes.
  • in componentDidUpdate, if the group changed, unregister from the old group, and register into the new group.

If no group was passed into an Animate, it should be animated immediately.

Type parameters

  • S

  • SS

  • S

Hierarchy

Index

Properties

estimatedDuration

estimatedDuration: number | null

The estimated duration of the animation this component can provide, or null if the component is not yet ready to animate.

If the estimatedDuration of any child Animate is null, nothing will be animated until every estimatedDuration is set.

trigger

trigger: function

AnimationGroup calls this when the component should start its animation.

Type declaration

    • (): void
    • Returns void

Generated using TypeDoc