Interface StaggerBuilder<TItem>

interface StaggerBuilder<TItem> {
    each(factory: StaggerFactory<TItem>): AnimationHandle;
    springPose<TPose>(
        adapter: SceneAdapter<{ id: string }, TPose>,
        poseFn: (item: TItem, index: number) => TPose,
        opts?: StaggerSpringPoseOptions<TPose>,
    ): AnimationHandle;
    tween<T>(opts: StaggerTweenOptions<T, TItem>): AnimationHandle;
}

Type Parameters

TItem

Index

Methods

each springPose tween

Methods

each

each(factory: StaggerFactory<TItem>): AnimationHandle
Run an arbitrary per-item factory.
Parameters
- factory: StaggerFactory<TItem>
Returns AnimationHandle
- Defined in packages/core/src/animation/types.ts:296

springPose

springPose<TPose>(
    adapter: SceneAdapter<{ id: string }, TPose>,
    poseFn: (item: TItem, index: number) => TPose,
    opts?: StaggerSpringPoseOptions<TPose>,
): AnimationHandle
Sugar: per-item springPose against an adapter. poseFn returns the target pose for each item. Each item must either be a primitive (string/number) or expose a string id field — otherwise pose ids would collide on "[object Object]" and successive tweens would cancel each other. Throws on items that satisfy neither.
Type Parameters
- TPose
Parameters
- adapter: SceneAdapter<{ id: string }, TPose>
- poseFn: (item: TItem, index: number) => TPose
- Optionalopts: StaggerSpringPoseOptions<TPose>
Returns AnimationHandle
- Defined in packages/core/src/animation/types.ts:304

tween

tween<T>(opts: StaggerTweenOptions<T, TItem>): AnimationHandle
Sugar: per-item animator.tween with per-item-varying options.
Type Parameters
- T
Parameters
- opts: StaggerTweenOptions<T, TItem>
Returns AnimationHandle
- Defined in packages/core/src/animation/types.ts:298