pixi-reels

BounceOptions

pixi-reels


pixi-reels / index / BounceOptions

Interface: BounceOptions

Defined in: spin/phases/ReelPhase.ts:32

Shape of one landing bounce, for ReelPhase.bounce. Every field falls back to the phase’s speed profile, so a phase that wants the profile’s own bounce passes nothing.

Properties#

PropertyTypeDescriptionDefined in
animation?(ctx: BounceContext) => AnimationThe tween itself, for a different shape than out-and-back: an elastic settle, three diminishing hops. Gets the numbers above resolved and must end with the container at base. The lifted-view bookkeeping is done around it either way. Default: ReelPhase.defaultBounce.spin/phases/ReelPhase.ts:51
distance?numberOvershoot in px, in the reel’s direction of travel. Default: the profile’s bounceDistance. 0 or less means no bounce at all.spin/phases/ReelPhase.ts:37
duration?numberTotal down-and-back time in ms; each leg takes half. Default: the profile’s bounceDuration.spin/phases/ReelPhase.ts:42
ease?stringGSAP ease for each leg. Default 'power1.out'.spin/phases/ReelPhase.ts:44