ScrollState

ScrollState holds the runtime's live scroll-related values.

Public status

ScrollState lives in src/states and is mainly runtime reference. Most integrations should read it through exported StringData.

Important fields

• target
• current
• transformedCurrent
• delta
• lerped
• displacement
• isScrollingDown
• topPosition
• bottomPosition
• direction
• container
• elementContainer
• scrollContainer
• mode
• modeMobile
• modeDesktop
• speed
• speedAccelerate

What it is for

This state powers:

• scroll progress modules
• scroll controller behavior
• direction-aware runtime logic
• transformed scroll-container math

Practical note

If a custom module needs current scroll numbers, data.scroll is usually the most important branch of StringData.