Skip to main content

scrollTrigger

scrollTrigger: ScrollTrigger | undefined

A handy way to access the ScrollTrigger associated with a tween. This is only accessible if the tween has a ScrollTrigger.

Details

caution

A "scrollTrigger" property is only added to the Timeline or Tween if it has a ScrollTrigger.

See the ScrollTrigger docs for more details

// add a ScrollTrigger to a Timeline
let tl = gsap.to("#id" {scrollTrigger: {start: "top center"...}});

// access the ScrollTrigger to call various methods
tl.scrollTrigger.refresh();
// or
tl.scrollTrigger.kill();

Contents