Skip to content

Home > @unseenco/backstage-gsap

backstage-gsap package ​

Functions ​

FunctionDescription
attachBackstagePageScroll(sheet, options)
bindGsapScrollTriggerPlugin(scrollTrigger)Optional: bind the ScrollTrigger plugin instance your app registered with GSAP. When omitted, Backstage resolves ScrollTrigger from gsap/ScrollTrigger (ESM) or globalThis.ScrollTrigger.
bindGsapTickerToRafDriver(rafDriver, gsap)Drives a Backstage rafDriver from gsap.ticker (GSAP time in seconds → Backstage ms). Returns a cleanup that removes the ticker listener and unmarks the driver.
configureBackstageGsap(config)
createDefaultPageScrollDriver(scroller)
getAnimationEntry(sheetObject, animationId)
getAnimationEntryById(id)
getAnimationEntryForSheetObject(sheetObject)
getBackstageGsapConfig()
getBackstagePageScrollContext()
isRafDriverDrivenByGsapTicker(rafDriver)
listAnimationEntries()
refreshRegisteredGsapScrollTriggerLayouts(sheet)Re-reads layout for all scroll triggers registered on this sheet (after ST refresh / resize).
registerAllGsapScrollTriggers(sheet)Registers every document-vertical ScrollTrigger from ScrollTrigger.getAll().
registerAnimationInRegistry(entry)
registerGsapAnimation(animation, sheet, options)

Registers a GSAP tween for Backstage sequence bridging and creates an outline proxy object under GSAP/<label> (namespace configurable).

The animation is paused immediately so Backstage can drive progress.

registerGsapScrollTrigger(scrollTrigger, sheet, options)Registers a GSAP ScrollTrigger for read-only visualization on the page-mode sequencer.
scheduleGsapTickerRafWarningCheck()Schedules a deferred check so same-turn setCoreRafDriver → bindGsapTickerToRafDriver → registerGsapAnimation does not warn before the bind runs.
unregisterGsapAnimation(sheet, options)Removes a GSAP animation registered with registerGsapAnimation() from the shared registry. Prefer letting / clear registrations automatically.
unregisterGsapScrollTrigger(sheet, options)Removes a ScrollTrigger registration from the shared registry. and clear these automatically.
warnIfGsapTickerNotDrivingBackstageRaf()Warns once per page load when Backstage's core rAF is not driven by gsap.ticker.

Type Aliases ​

Type AliasDescription
BackstageGsapConfig
BackstageGsapPageScrollConfig
GsapAnimationRegistryEntry
GsapScrollTriggerLikeMinimal GSAP ScrollTrigger surface for Backstage (avoids tight GSAP coupling).
GsapTickerLike
RegisterAllGsapScrollTriggersResult
RegisterGsapAnimationOptions
RegisterGsapAnimationResult
RegisterGsapScrollTriggerOptions
RegisterGsapScrollTriggerResult
UnregisterGsapAnimationOptions
UnregisterGsapScrollTriggerOptions